Bring Your Own Key (BYOK)

Use your own API keys for direct access to AI providers.

Why Use BYOK?

Direct billing

Pay the provider directly at their rates

Bypass rate limits

No Synoppy rate limits when using BYOK

Access Gemini

Use Gemini models with your own Google API key

Full control

Manage your own usage limits and quotas

Requirements

•Pro plan ($20/mo): 1 BYOK provider (Anthropic, DeepSeek, or Gemini)
•Pro+ plan ($60/mo): Up to 3 BYOK providers (Anthropic, DeepSeek, Gemini)

Setting Up BYOK

1. Add your API key (during a session):

text

/apikey anthropic sk-ant-api03-...

2. Enable BYOK mode:

text

/byok on

3. View BYOK status:

text

/byok

Supported Providers

Anthropic (Claude)

Pro (1 provider) or Pro+ (3 providers)

Get API Key

text

/apikey anthropic sk-ant-...

Available models:

Claude Haiku 4.5Claude Sonnet 4.5Claude Sonnet 4.6Claude Opus 4.5Claude Opus 4.6

DeepSeek

Pro (1 provider) or Pro+ (3 providers)

Get API Key

text

/apikey deepseek sk-...

Available models:

DeepSeek V3

Google (Gemini)

Pro (1 provider) or Pro+ (3 providers)

Get API Key

text

/apikey gemini AIza...

Available models:

Gemini 3 FlashGemini 3.1 Flash-LiteGemini 3.1 Pro

Managing Keys

View configured keys:

text

/apikey

Clear a specific key:

text

/apikey clear anthropic

Check overall status:

bash

synoppy status

Security

Key Storage

• API keys are stored locally in ~/.synoppy/config.json
• Keys are never sent to Synoppy servers
• Requests go directly to the provider
• Set usage limits in your provider dashboard

Switching Modes

Toggle between BYOK and Synoppy credits at any time:

Use your API keys:

text

/byok on

Use Synoppy credits:

text

/byok off

Or use the provider command:

text

/provider byok

Next: Thinking Modes

Learn about extended and adaptive thinking modes for complex reasoning tasks.

Thinking Modes