API Reference/Overview

Overview

Reading conventions for the reference: hosts, encoding, field types and error shape.

On this page

Hosts

text
https://api.apione.ai/v1          OpenAI-compatible
https://api.apione.ai             Anthropic-compatible (the SDK appends /v1/messages)
https://api.apione.ai/v1beta      Gemini-compatible (generateContent / streamGenerateContent)

Conventions

  • Requests and responses are application/json, UTF-8.
  • Timestamps are RFC 3339 in UTC, or Unix seconds (created).
  • Omitting a field marked required returns 400.
  • Responses may gain fields; clients must tolerate unknown keys.

Request ID

Every response carries an X-Maxx-Request-ID header, readable from the browser too. It identifies one call: search it in console › Usage › Request log, and include it when contacting support so we can pull up that exact call.

Errors

json
{
  "error": {
    "message": "model \"claude-sonet-4-6\" is not supported by any configured provider",
    "type": "upstream_error",
    "code": "model_not_supported",
    "retryable": false
  }
}

retryable says whether the same request could succeed if sent again later. The full status/code mapping is in Error codes.

Contact us

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