Skip to content

InteractionProcessCredentialRequest

A model provider API key of yours for a run to use. For each call the run tries these keys in priority order, then your tenant’s model keys, and moves on to the next when one fails authentication or hits a quota.

Kind: an object, used in requests.

FieldTypeRequiredDescription
providerstringThe model provider the key is for: a model-key provider name (Anthropic, OpenAi, DeepSeek, Gemini, Qwen, Glm or Kimi, in any case), or an inline model’s credentialProvider.
apiKeystringThe API key. Write-only: never returned.
baseUrlstring | nullThe endpoint to call with this key, such as a regional Qwen host or an Azure resource. Null: the provider’s default.
modelNameOverridesmap<string, string> | nullCatalogue model names mapped to the model or deployment id this key’s endpoint uses for them, such as an Azure deployment name. Null or empty: the catalogue’s ids are used as they are.
credentialIdstringYour own id for the key. The run’s token usage and credential failures carry it, so you can tell which key served or failed a call.
isOwnLicensebooleanSet to true for a key of your own, which the provider bills you for directly. Only such keys are used: to let a run fall back to Maitento’s own key, set allowMaitentoFallback on the start request instead.
priorityintegerThe order keys for the same provider are tried in: lowest first.
{
"provider": "...",
"apiKey": "...",
"baseUrl": "...",
"modelNameOverrides": {
"key": "..."
},
"credentialId": "...",
"isOwnLicense": false,
"priority": 0
}