Skip to main content

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 pathPurposeReference
GET /v1/modelsAvailable model IDs; service_type selects another typeDiscovery
POST /v1/chat/completionsOpenAI-compatible chat and streamingChat Completions
POST /v1/responsesResponses-format requests on compatible offeringsResponses
POST /v1/responses/compactModel-billed compaction on native Responses routesConversation state
POST /v1/messagesAnthropic-compatible requestsMessages
Operation-specific toolsClient functions, MCP and metered provider-run toolsTool contracts

Media, documents and services​

WorkflowReference covers
Private filesAuthorize, upload, finalize, ownership and expiry
ImagesGenerate, edit and model-specific controls
VideoGenerate, inspect job lifecycle and retrieve results
AudioTranscribe, translate audio, speak, discover voices and create sound effects
EmbeddingsVector requests and output
RerankingRank candidate documents against a query
Documents and visionOCR, structured document analysis and image analysis
Language and safetyTranslate, 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.