Skip to main content
All endpoints use HTTPS and authenticate with the same APIONE API Key.

Common request headers

Anthropic and Gemini native protocols also support their respective key headers. Send only one credential per request. Save the actual request identifiers and field names returned in the response: X-Request-ID, X-Maxx-Trace-Id, or X-Maxx-Request-ID. Different interfaces do not guarantee returning all fields; record local business IDs separately and do not assume custom headers will be echoed back unchanged.

Version paths

/v1 and /v1beta are part of the interface version. When configuring an SDK, do not mistakenly enter the complete endpoint as the Base URL, and do not form /v1/v1/....

Find endpoints by task

Text chat

Use Chat Completions for ordinary multi-turn conversations; use Responses for existing Responses workflows or Codex-like tools. The two cannot simply swap paths while reusing the exact same request body.

Native protocols

Anthropic Messages and Gemini generateContent use their own message structures and authentication conventions. When choosing a native protocol, construct requests according to the corresponding page; do not send OpenAI’s messages structure directly to the Gemini endpoint.

Images and video

Image generation, image editing, and video generation are media interfaces. Query model parameters before submitting. Video is an asynchronous task: POST /v1/videos creates it, GET /v1/videos/{id} queries it; do not let a single creation request wait until generation finishes.

General response handling

  • Success responses: read the body, result object, or task ID according to the specific interface.
  • Error responses: record both HTTP status and sanitized response body.
  • Request tracking: save the actual returned request identifiers and field names to locate them in the console or support tickets.
  • Dynamic capabilities: models, parameters, prices, and output formats are determined by the current key’s query results.

Pre-production checklist

Next: Choose a protocol, Request tracking and retries.