API Documentation
Introduction
Introduction to the OmniAI API
Base URL
The base URL for the API is
Authentication
All requests to the OmniAI API must include an x-api-key header with your API key. You can access your API Keys here.
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.
Response Codes
The OmniAI API uses standard HTTP response codes to indicate the status of requests. Here’s what each code means:
| Code | Status | Description |
|---|---|---|
| 200 | Success | Request was successful. |
| 400 | Bad Request | The request was invalid or malformed. |
| 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 | Rate limit exceeded. Try again later. |
| 500, 503 | Server Error | Something went wrong on OmniAI’s end. |