Docs/API access

API endpoints

Review endpoints, required headers and versioning before choosing a call path.

On this page

Base URL

text
OpenAI-compatible      https://api.apione.ai/v1
Anthropic-compatible   https://api.apione.ai
Gemini-compatible      https://api.apione.ai/v1beta

HTTPS only. Every protocol lives on the same host and takes the same key — no per-vendor addresses.

Endpoint list

MethodPathPurpose
POST/v1/chat/completionsChat completion (OpenAI protocol)
POST/v1/responsesChat completion (OpenAI Responses protocol)
POST/v1/messagesChat completion (Anthropic protocol)
POST/v1beta/models/{model}:generateContentChat completion (Gemini protocol); stream with :streamGenerateContent
GET/v1/modelsModels this key may call
GET/v1/models/{model}/paramsOne model's supported parameters and billing mode
POST/v1/images/generationsImage generation
POST/v1/images/editsImage editing
POST/v1/videosSubmit a video generation job
GET/v1/videos/{id}Video job progress and result

Common request headers

Authorizationstringone of three

Bearer YOUR_APIONE_KEY. The Anthropic protocol also accepts x-api-key and the Gemini protocol x-goog-api-key; send only one per request — several at once are rejected.

Content-Typestringrequired

application/json on every POST.

X-Maxx-Request-IDstring

Optional trace id of your own (up to 128 printable ASCII characters), recorded as this request's ID and searchable during support.

Common response headers

HeaderMeaning
X-Maxx-Request-IDThis request's ID. Search it in console › Usage › Request log, and include it when contacting support
Retry-AfterSeconds to wait when rate limited

Versioning

The /v1 path segment is the major interface version. Backwards-compatible changes — new fields, new optional parameters, new models — ship without a version bump. Breaking changes get a new prefix, announced at least six months before the old one is retired.

Warning

Parse responses as a structure that may gain fields. Strict deserialisers that reject unknown keys will break the first time we add one.

Contact us

Something unclear, or need a human? Pick the channel that fits your question.