Authentication
Authentication
To make authorized calls to the OmniAI API, your must provide a valid x-api-key
header with an API key. You can find your API key in the OmniAI settings.
The header name and value are case-insensitive. If a request is executed with invalid or missing headers, an HTTP 401 (Unauthorized) response will be returned.
HTTP Response Codes
The OmniAI API uses HTTP response codes to indicate whether a request was successful.
Below is a summary of the HTTP response codes you may encounter:
Code | Status | Description |
---|---|---|
200 | Success | Request was successful. |
401 | Unauthorized | Invalid or missing API key. |
404 | Not Found | The requested resource doesn’t exist. |
413 | Payload Too Large | Exceeds the token limit configured for the selected LLM. |
429 | Too Many Requests | Too many request were sent to the API. |
500, 503 | Server Error | Something went wrong on OmniAI's end. |
Last updated