Skip to main content

BYOK formats and setup

BYOK means you connect your own API provider and key, then select BYOK as the route source.

Supported profile formats​

Ask AI profiles​

Current provider presets:

  • openai-compatible
  • gemini-compatible
  • anthropic-compatible

Each profile includes:

  • Name
  • Provider
  • API endpoint (optional in UI, defaults are provided)
  • Model
  • API key

Embedding profiles​

  • Provider format: OpenAI-compatible
  • Fields: Name / Provider / API endpoint / Model / API key

How to fill a BYOK profile​

  1. Open Settings → Intelligence → API keys.
  2. Add a profile and choose provider type.
  3. Fill endpoint/model/key.
  4. Save and set it as active.
  5. Go back to Intelligence route settings and choose BYOK (or Auto).

Endpoint defaults​

  • OpenAI-compatible: https://api.openai.com/v1
  • Gemini-compatible: https://generativelanguage.googleapis.com/v1beta
  • Anthropic-compatible: https://api.anthropic.com/v1

You can replace these with your own compatible gateway endpoint.

Important compatibility note​

  • For media BYOK paths (OCR/audio/media understanding), current setup expects an OpenAI-compatible profile.

Safety notes​

  • API keys are stored encrypted on-device.
  • Keep one active profile per capability to avoid routing confusion.