AI Gateway

The AI Gateway is configured by the superadmin. Credentials and routing apply to this Breeks installation.

What It Controls

• API credentials for OpenAI, OpenRouter, Gemini, Anthropic, and Kimi.
• OpenAI Codex device login through the local Codex CLI.
• The active embedding provider for document search vectors.
• Provider-specific model dropdowns for embeddings.

Runtime Routing

Document processing renders pages, runs OCR, and builds embeddings with the selected embedding provider. If no external embedding provider is available, Breeks uses the deterministic local hash embedding so document search still works offline.

API Endpoints

GET    /api/superadmin/ai-settings
PUT    /api/superadmin/ai-settings/providers/{provider}
DELETE /api/superadmin/ai-settings/providers/{provider}
POST   /api/superadmin/ai-settings/providers/{provider}/test
PATCH  /api/superadmin/ai-settings/gateway

Codex device login is available on /api/superadmin/ai-settings/codex/*.

Provider Model Dropdowns

These model options are returned as model_options from the AI settings payload. The UI preserves a saved custom model value as a custom option if it is not in the curated list.

Updating The Catalog

1. Check the provider docs or model API listed below.
2. Update provider_definitions() in apps/api/app/credentials.py.
3. Update apps/api/tests/test_ai_settings.py when expected model options change.
4. Run the API tests and web typecheck.
5. Regenerate the OpenAPI snapshot if API schemas changed.

Sources

Model options were checked on 2026-07-06.

• OpenAI models
• OpenAI embeddings
• OpenAI Codex models
• Google Gemini models
• Anthropic model overview
• Kimi model list
• OpenRouter models API