This page describes features extending the AI Gateway, which provides a unified API for accessing multiple AI providers. To learn more, see AI Gateway.
For the OpenAI API specification, see the API Reference
Base URL
OpenAI-compatible endpoint:Authentication
Authenticate with your Orq.ai API key via theAuthorization: Bearer $ORQ_API_KEY header.
To learn more about Orq API Key, see API Key.
- Authorization: Bearer $ORQ_API_KEY
- Content-Type: application/json
Supported Endpoints
Schema, parameters, and response formats match the OpenAI API.- (WIP) GET /models- List available models
- (WIP) GET /models/{model}- Get model details
- POST /chat/completions- Chat completions (supports streaming, images, files, and tool calls)
- POST /completions- Text completions
- POST /embeddings- Vector embeddings
- POST /images/generations- Image generation
- POST /images/edits- Image editing
- POST /images/variations- Image variations
- POST /moderations- Text moderation
- POST /rerank- Rerank results
- POST /speech- Text-to-speech
- POST /audio/transcriptions- Transcribe audio into the input language
- POST /audio/translations- Translate audio into the input language
- POST /responses- Create a model response with built-in tools
Models
Use the model field exactly as you would with OpenAI, substituting the ID of any model available in your Orq.ai Model Garden.To list your models via the API, see Using the Model Garden via the API.
Error Handling & Compatibility Notes
- HTTP status codes and error structures follow OpenAI’s conventions.
- Streaming, function/tool calls, and multimodal inputs (images/files) are supported on /chat/completions.
- The AI Gateway is versioned under /v2/proxy. Ensure clients target this path.
Load Balancing PDF Input