Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omniakey.com/llms.txt

Use this file to discover all available pages before exploring further.

Every OmniaKey API request uses an API key from the API Keys dashboard.

Bearer token

The universal form is an Authorization header:
Authorization: Bearer your-omniakey-api-key
Use this form for cURL, OpenAI-compatible clients, and most custom integrations.

SDK conventions

Official SDKs use different auth conventions. OmniaKey accepts the common forms for the protocol being called.
SDK or protocolAuth form
OpenAI SDKapi_key / Authorization: Bearer
Anthropic SDKapi_key / x-api-key
Gemini SDKapi_key / x-goog-api-key / ?key= query parameter
For custom integrations, prefer Authorization: Bearer. It works consistently across all documented endpoints.

Keep keys scoped

Create separate keys for local development, CI, and shared team workflows. This makes it easier to rotate a compromised key and set per-key spending caps.

Common auth errors

StatusMeaningFix
401Missing, inactive, or invalid keyCreate or rotate the key in the dashboard
403Key cap or account balance is too lowRaise the key cap or top up balance