Skip to content

BYOK integration

Bring your own key (BYOK) lets Rikaii route requests through your credentials for a given upstream instead of Rikaii-managed keys where you enable routing.

Supported providers

The gateway persists BYOK rows per provider name (uppercase). Supported values include:

Provider keyTypical upstream
OPENAIOpenAI
ANTHROPICAnthropic
GOOGLEGoogle Gemini (Generative Language API family)
DEEPSEEKDeepSeek
MISTRALMistral
XAIxAI
QWENQwen
COHERECohere (OpenAI-compatible surface)
PERPLEXITYPerplexity
OPENROUTEROpenRouter

Routing for these universal vendors uses the shared OpenAI-compatible adapter stack; consult each vendor’s docs for model ids, context limits, and tool support.

Configuration

Add or rotate provider keys in Dashboard → Settings → Bring Your Own Key (BYOK)
rikaii.com/dashboard/settings

Secrets are stored encrypted and are not returned in plaintext from the product UI after save—only masked summaries.

Routing behavior

Two flags control how a stored secret participates in routing:

  • Use my key (routing enabled) — When on, eligible chat traffic may use your credential for that provider. When off, the key can remain on file but platform keys are preferred until you re-enable routing.
  • Fallback — Allows the key to participate in fallback hops when a primary route fails.

Precedence for chat requests is described in the Routing engine—including the rule that pinning a catalog model only bypasses smart routing when BYOK routing is active for that provider.

Billing

Traffic satisfied with your provider credentials is generally billed by that provider under your contract with them. Rikaii may still apply platform fees depending on your plan—see Billing in the Dashboard.

See also Routing engine, Overage protection, and Parameter sanitization.

Rikaii API documentation