Before you begin
- You’re an organization admin. Only organization admins add, switch, edit, or remove providers and models.
- You have the provider’s credential: an API key for most providers, AWS access keys for Bedrock, or a service-account key file for Vertex AI. See Supported model providers for what each type needs.
- For Bedrock, the role needs
bedrock:InvokeModelandbedrock:InvokeModelWithResponseStreamto serve calls, andbedrock:ListFoundationModelsandbedrock:ListInferenceProfilesto discover models. - For Vertex AI, the service account needs
roles/aiplatform.useron the project. - A custom base URL, for LiteLLM, Azure, or an OpenAI-compatible server, must be a host your deployment allows.
1
Start adding a provider
In Model Gateway studio, open Providers and select Add a provider. The provider is added to the organization workspace, where every caller resolves model names.
2
Choose the provider type
Pick the type from Provider. The form below changes to ask only for what that type needs: for example, AWS region for Bedrock, GCP project ID and Region for Vertex AI, or Resource name for Azure.
3
Enter the details
Enter a Display name. The provider’s Name, the first part of every model name it serves, is derived from it and can’t change once created. Leave Base URL empty to use the type’s default.
4
Add the credential
Under Credential, paste the key (Paste a key, Paste AWS access keys, or Service-account key file), or choose Use a secret to pick one already stored in Atlan. Keep Route calls to it once connected selected to let agents call its models straight away.
5
Add the provider
Select Add provider. Atlan stores the credential as a secret, then calls the provider with it. Nothing is created until the provider accepts the credential. If it refuses, the form says
<Provider> did not accept this provider. and keeps the credential as a secret so you can fix it and retry.6
Choose which models agents can call
Discovery lists the models the credential can reach, usually in under a minute. A model with a price lands enabled. A model with no price lands off and shows Can’t enable until you Set rates. Select models and use Enable selected or Disable selected, then select Done.
Verify
- Providers shows the provider under Connected.
-
With an agent key, list models and find the provider’s models, each with
is_routable: true:Model ids start with the provider’s name, such asopenai/<model>. -
On Models, select Check on one of the provider’s models. The check makes one real call, the smallest the model allows, and reads
Answeredwhen it succeeds. Checks are metered as you.
Turn a provider or model on and off
A model can’t be turned on while its provider is off.
Keep the catalog current
Discovery runs again every hour. To pick up a change now, select Refresh now on the provider’s row or page. Review the provider’s changes lists the models to add, to update, and to remove for everyone. Nothing changes until you select Apply, or Apply and remove when models are listed for removal. If nothing changed, the result reads Already up to date. Removing a model archives it, so calls naming it are refused. That includes models registered by hand, except under Bedrock, whose models discovery never removes. To update one model only, open it on Models and select Refresh from the provider.Fix a provider that stopped working
A provider whose key is refused, or whose host doesn’t answer, moves to Needs attention on Providers, with the fix on its row:- Check again lists the provider’s models with its stored key and changes nothing. It tells you whether the provider accepts the key now.
- Replace key stores a new key as a new secret, points the provider at it, and refreshes its models. The old secret is kept.
Related
- Supported model providers: credentials, discovery, and constraints per provider type.
- Route and fall back across deployments: put several providers behind one model name.
- Connect client to Model Gateway: create an agent key and call a model.