Advanced

BYOK (Bring Your Own Key)

BYOK (Bring Your Own Key) lets Pro plan companies connect their own AI provider API keys. You choose the provider and model, you're billed directly by that provider, and requests made with your key don't count against your Aimy plan usage.

Setting Up BYOK

  1. Go to API Keys in the company admin sidebar (Pro plan only).
  2. Click Add Key and choose a provider from the list below.
  3. Paste the API key from that provider.
  4. Click Test to verify the key works, then Save.

Supported Providers

Aimy works with any provider that exposes an OpenAI-compatible API. The providers below are configured on the platform:

ProviderKey formatGet a keyOpenAI-compatible
OpenAI sk-... platform.openai.com/api-keys
Google Gemini AIza... aistudio.google.com/apikey
Mistral ... console.mistral.ai/api-keys
Groq gsk_... console.groq.com/keys
Together AI ... api.together.ai/settings/api-keys
OpenRouter sk-or-... openrouter.ai/keys
Anthropic (Claude) sk-ant-... console.anthropic.com/settings/keys
Nvidia NIM nvapi-...

Only providers marked OpenAI-compatible can be used for chat. A provider shown with — (for example Anthropic's native API) uses a different request format and isn't selectable for BYOK chat yet.

Using BYOK Models

Once a key is saved, models from that provider appear alongside the standard models in:

  • Chatbot settings — set a BYOK model as a chatbot's default.
  • Chat & Playground — switch to a BYOK model per message.

Security

  • Your API key is encrypted at rest using libsodium authenticated encryption (XSalsa20-Poly1305 secretbox), with a per-key random nonce.
  • Keys are decrypted only at the moment a request is made to the provider — they're never shown again in the UI after saving and are not written to logs.
  • You can delete a key at any time from the API Keys page.

Costs

With BYOK, API usage is billed directly by the provider (OpenAI, Gemini, Groq, etc.) and is separate from your Aimy subscription. Aimy adds no markup, and BYOK requests don't draw down your Aimy plan usage.

BYOK is available on the Pro plan only. Keys are stored encrypted and never shared with third parties.