Bring Your Own Key

Open in CMS

With your own API key, your agents reach a model on your own provider account β€” OpenAI, Azure OpenAI, Azure AI Inference or DeepSeek β€” instead of a Qlar model. The provider bills you directly, and no Qlar credit is charged for that model's tokens.

Each key you add is one model: an alias your team picks from model lists, the provider and model it reaches, and the key to reach it with.

Who can do this? Owners and Admins, in an organization that Qlar has allowed to bring its own AI models. If the Sources tab or Add API key doesn't appear, ask Qlar support to turn it on for your organization.


Before you start

  • An account with a supported provider and an API key for it:
    • OpenAI β€” the model name, for example gpt-4o-mini.
    • Azure OpenAI β€” the endpoint and the deployment name.
    • Azure AI Inference β€” the endpoint, and optionally a Response API endpoint.
    • DeepSeek β€” the model name; the endpoint defaults to https://api.deepseek.com.
  • What the model accepts and produces (images, audio, documents, …), from the provider's own documentation. Qlar can't detect it.
  • Owner or Admin role in the organization.

Want to use your Claude or ChatGPT plan instead, with the key never leaving your own computer? See Connect a Gateway.


Add a key

Open the Organization page β†’ Configure on your organization β†’ AI Models tile β†’ Sources tab β†’ Add API key (or Add API key in the Your API keys group on the Models tab).

  1. Alias β€” the name your team sees in model lists, for example my-gpt-4o. It must be unique and can't be the name of a Qlar model. It can't be changed later.
  2. Provider β€” OpenAI, Azure OpenAI, Azure AI Inference or DeepSeek.
  3. Invocation method β€” Chat Completion or Response API. DeepSeek supports Chat Completion only.
  4. Native model name (for example gpt-4o-mini) or, for Azure, the Deployment name, plus the Endpoint for Azure providers.
  5. API key β€” pasted once. It is stored encrypted; afterwards only a masked part of it is shown.
  6. Optionally a Short description and an Estimated credit ratio (leave 0 if unknown).
  7. Capabilities β€” switch on what the model accepts (Image, Audio, Video, Document) and produces (Image, Audio, Video). With Document on, pick at least one document type.
  8. Click Create.

The model appears under Models in Your API keys, switched on.


Use it

  • In an agent: as the conversation model, in Allowed Conversation AI Models, or as the Answering AI model of a Natural conversation voice call. Model lists show it under API key.
  • As a feature default: on the Defaults tab, choose it for Conversation, Summarization, Personalization, Reranker, KB Training or Conversation Analysis.
  • Billing: no Qlar credit for the model's tokens; your provider bills you. Tools the answer uses β€” web search, knowledge base, plugins β€” are billed as usual.

Change or remove a key

TaskWhat to do
Rotate the keySources β†’ Edit on the key β†’ paste the new API key β†’ Save. Leave the field blank to keep the current key.
Change the endpoint, capabilities or descriptionEdit β†’ change the fields β†’ Save.
Hide it from every agentTurn its switch off on the Models tab.
Delete itEdit β†’ Delete β†’ Yes, delete. Agents using it fall back to the organization default.

Troubleshooting

SymptomCauseFix
Sources tab or Add API key missingYour organization isn't allowed to bring its own models, or you aren't an Owner or AdminAsk Qlar support, or an Owner.
The alias is refusedIt clashes with a Qlar model or another keyChoose another alias.
Replies fail with an authentication errorThe key was revoked or rotated at the providerEdit the key and paste the new one.
Images or documents are refusedThe capability switch is offEdit and turn the capability on, if the model supports it.
"Someone else changed this at the same time"Someone else saved AI Models at the same momentReload the page and try again.