Account

set_byok_key

Add or update a BYOK provider API key. Encrypted at rest (AES-256-GCM). Requires a paid plan (Pro or higher).

Does not consume quota.

Providers & key formats:

  • openai: sk-… (OpenAI API key)
  • claude: sk-ant-… (Anthropic Claude key)
  • gemini: AIza… or AQ.… (Google AI Studio key)

Example prompts: "Set my OpenAI key to sk-proj-abc123..."

Parameters: provider (required), api_key (required).

post/tools/set_byok_key

Request

  • Base URL: https://compabase.com/api/mcp
  • URL: https://compabase.com/api/mcp/tools/set_byok_key
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Response

Key saved confirmation

object required

Changes

No recorded changes to this operation across all 1 revision of this API.