Skip to content
☰
Documentation navigation +
betaMay change before the API is declared stable.

Use your own AI provider key (BYOK)

Organization admins can store a provider key so that intake drafting and concept reviews run on your own provider account. Alive then charges no credits for those AI calls (it still meters tokens so you can see usage).

  1. In the app, open Settings → Provider keys, or call POST /v1/orgs/{org_id}/provider-keys with {"provider": "anthropic", "label": "…", "api_key": "…"}. Supported providers: openai, anthropic, google.
  2. Choose the provider when you draft an intake (byok_provider) or start a review (byok_provider in the request body).

How the key is protected

  • It is encrypted with AES-256-GCM under a master key that is held outside the database.
  • No API ever returns it; listings show only the provider, label and last four characters.
  • It is decrypted only at the moment of a call, and never written to logs, prompts or exports.
  • Revoking it (DELETE /v1/orgs/{org_id}/provider-keys/{key_id}) destroys the stored ciphertext.

The model used for BYOK calls is set by the deployment for each provider. If none is configured for your provider, the request fails with PROVIDER_NOT_CONFIGURED rather than guessing a model.