API reference
The inference gateway is https://gateway.primexos.com. Authenticate with
Authorization: Bearer <PRIMEX_API_KEY> unless a specific compatible client guide
uses its documented key header. Use the complete endpoint URL for direct HTTP.
See API formats for SDK base URLs and protocol differences,
Parameters and compatibility for optional controls and
Conversation history for subsequent turns.
Models, conversations and tools
| Method and path | Purpose | Reference |
|---|---|---|
GET /v1/models | Available model IDs; service_type selects another type | Discovery |
POST /v1/chat/completions | OpenAI-compatible chat and streaming | Chat Completions |
POST /v1/responses | Responses-format requests on compatible offerings | Responses |
POST /v1/responses/compact | Model-billed compaction on native Responses routes | Conversation state |
POST /v1/messages | Anthropic-compatible requests | Messages |
| Operation-specific tools | Client functions, MCP and metered provider-run tools | Tool contracts |
Media, documents and services
| Workflow | Reference covers |
|---|---|
| Private files | Authorize, upload, finalize, ownership and expiry |
| Images | Generate, edit and model-specific controls |
| Video | Generate, inspect job lifecycle and retrieve results |
| Audio | Transcribe, translate audio, speak, discover voices and create sound effects |
| Embeddings | Vector requests and output |
| Reranking | Rank candidate documents against a query |
| Documents and vision | OCR, structured document analysis and image analysis |
| Language and safety | Translate, analyze, summarize and moderate supported input |
References describe the public Primex contract. Native parameter tables are derived from Gateway schemas; compatible passthrough pages describe their supported scope and link to the upstream format. Availability and pricing come from the public catalogue, not this endpoint index.
Response handling
Use the response shape documented for the operation. Streaming, binary audio, structured documents and asynchronous jobs require different handling. The same is true of billing: tokens, pages, characters, images and other units must not be added together as one meter. See Billing.
For failures, use Errors & Limits. Preserve the returned request identifier and inspect Usage when a dispatched operation has an uncertain outcome. Follow operation-specific retry guidance.