← All docs

Reference

Compatibility features

Optional model name prefix, cost header, Idempotency-Key, per-endpoint limits.

Updated

Optional model name prefix

Calls work without everyais/. When the last segment is unique in the catalog, claude-opus-5 resolves to everyais/claude-opus-5. Dotted names (gemini-3.5-flash) and curated public ids (gpt-5.4everyais/openai-gpt-5-4) map only when that canonical is currently sold. Ambiguous names 404 instead of guessing. Provider-native model IDs map through admin ModelAlias. GET /v1/models lists these inbound names on each row as aliases.

Per-call cost header

Non-streaming responses include the service price (USD) for that request in the x-everyais-cost-usd header. Use it for agent budget guards.

Idempotency-Key

Supported for Chat, Messages, Responses, and image generation/editing. Video submission is excluded. Retry the identical body with the same Idempotency-Key, API key, route, and authorization policy. Keys can be up to 255 characters; records are kept for 24 hours. Different JSON whitespace or field order counts as a different body.

  • Successful JSON responses up to 300 KiB can be replayed with Idempotent-Replayed: true.
  • Reusing a key with a different body, or while a request is in progress, returns 409.
  • SSE and large successful responses are not replayed. A marker blocks duplicate execution; a repeat returns 409.
  • Failed responses are not cached. Requests may proceed if the idempotency store is unavailable, so this is not an absolute exactly-once guarantee.

See errors and retries before enabling automatic retries.

usage token details

When the provider reports them, usage.prompt_tokens_details.cached_tokens (cache hit) and cache_creation_tokens (cache creation) are included.

Per-key budget and scopes

In the dashboard you can set a monthly/daily/per-minute spend limit (USD) per API key and the allowed endpoint scopes (chat, images, video, models:read). Exceeding the limit returns 402, and a call outside the scopes returns 403 (leaving all scopes empty allows everything).

Per-endpoint limits

ItemLimit
n on /v1/chat/completionsOnly 1 is supported — 2 or more returns 400
n on /v1/images/generations1–10
n on /v1/images/edits1–4

See Base URL and request limits for time budgets and body sizes. Dedicated /v1/embeddings and /v1/audio/* APIs are not available.