> For the complete documentation index, see [llms.txt](https://vordai.gitbook.io/vordai-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://vordai.gitbook.io/vordai-docs/api-reference.md).

# API Reference

OpenAI-compatible text inference, live model discovery, tools, and request recovery.

### Base URL

<https://gateway.vordai.io>

Inference endpoints use an active Vord Session credential in the Authorization header unless noted otherwise.

### Available endpoints

#### List models

GET /v1/models

Returns the live OpenAI-style model catalog. Each entry publishes an exact model ID, context and output limits, capabilities, privacy\_tier, privacy\_capabilities, model\_sets, traits, maximum\_usage, and token or metered-unit prices.

The response is a signed taxonomy-v2 bundle. Clients may verify model\_taxonomy\_version, bundle\_digest, source\_bundle\_digest, publisher\_key\_id, and publisher\_signature. These fields provide catalog integrity and provenance metadata.

Interpret privacy\_tier, privacy\_capabilities, model\_sets, and traits independently. The uncensored model set applies only to models explicitly listed in model\_sets. The most\_uncensored trait is a recommendation signal and does not establish model-set membership or guarantee unrestricted model behavior. The current live catalog publishes empty model\_sets arrays.

Vord publishes two privacy tiers: anonymized and private. TEE attestation and E2EE are separate signed privacy capabilities. The current private routes are tee-glm-5.2 and tee-kimi-k2.6; both currently declare e2ee and tee\_attestation.

#### List built-in tools

GET /v1/tools

This endpoint is the authoritative built-in tool directory. Use the returned exact function schemas, tool\_catalog\_version, and tool\_catalog\_digest; do not treat a documentation snapshot as the long-term source of truth.

The current live snapshot reports tool\_catalog\_version account-r71, digest sha256:2a750b05b534034a7dfd7dc64449a26318867cc4202c1651bd67d83cdcb6bf78, and four tools: calculator, fetch\_url, current\_time, and web\_search.

A tool may be used only with a model whose live capabilities declare the required support.

#### Chat completions

POST /v1/chat/completions

Accepts OpenAI-compatible chat-completion requests and supports streaming. Use the exact model ID and limits from GET /v1/models.

Required headers include:

* Authorization: Bearer sk-...
* Content-Type: application/json
* Idempotency-Key for requests that may be retried

Account OAuth tokens, account cookies, and payment credentials are not inference credentials and must not be sent to this endpoint.

#### Parse text from a file

POST /v1/parse/text

File parsing is Available. The current public contract supports PDF, EPUB, DOCX, PPTX, XLSX, and XLS, requires an active Vord Session, and applies a 25 MiB file limit.

Text and source files are read locally where possible. Original files and extracted text are not persisted in ordinary database, object-storage, log, or backup paths. Parsed content is sent to a model only when the user submits the request.

#### Node attestation

GET /attestation?nonce={32-byte-base64url-nonce}

Node attestation is Available. The response provides Intel TDX node evidence bound to the supplied nonce and the current TLS public key.

The bounded successful conclusion is TDX NODE VERIFIED. It does not verify the workload image, source code, runtime arguments, or operator exclusion.

### Beta / rollout pending

#### Session and billing lifecycle

Session open, close, automatic close, claim, preflight, billing lookup, request lookup, and related purchase and recovery flows remain Beta / rollout pending. Do not treat a contract-defined route as generally available unless the live public interface is enabled.

#### Direct recovery

Direct-mode recovery converges request identity and billing state by Idempotency-Key or request ID. It does not replay or reconstruct response text and must not create a second provider execution.

#### Response Spool

A separate opt-in Response Spool path is Beta / rollout pending. When enabled, it resumes the same accepted request from short-lived encrypted frames and never creates a second provider execution. The feature gate is not generally open.

#### Credits

Credits purchase and the device wallet are Beta / rollout pending. 1 Credit equals 1 cent.

Credits are blind-signed, device-held bearer credentials protected by P2PK keys. Anyone with the corresponding proof and private-key material can spend them; exporting that material transfers practical spending control.

### Coming Soon contracts

#### Video generation and media routes

The /v1/videos family and other media-capable routes are Coming Soon. They remain under integration and are not generally available.

The route family may appear in contract material, but developers must not rely on it until general availability is explicitly announced. This documentation intentionally provides no callable video example.

#### App Screen Lock

Optional device-local App Screen Lock with a 4-digit or 6-digit passcode is Coming Soon. It is a screen-privacy control and does not replace the recovery key or add a new Credits-encryption layer.

### Error and retry guidance

Use stable idempotency keys. A retry must converge the original request rather than create another provider execution. Respect the live maximum\_usage and price metadata from the selected model entry.

### Status terminology

Available means the live service or catalog exposes the capability. Beta / rollout pending means implementation or a public contract exists but general availability has not been confirmed. Coming Soon means an approved product or implementation plan exists, but the capability is not yet available.
