Set Model

PUThttps://api.confident-ai.com/v2/organization/models/{modelType}

Sets one of your organization's default models, selected by the modelType path segment. platform is the model behind Confident AI's own AI features, like classification, summaries and report generation. simulation is the model that simulates user turns in conversation simulations, including multi-turn test runs and red teaming. Each applies to every project that has no override of its own for that type.

The provider's credential must already be configured on the organization through the model credentials endpoint. A provider your organization's model provider policy does not allow is rejected with a 403. CONFIDENT_AI needs no credential and stores a null model name.

PUT/v2/organization/models/{modelType}

curl -X PUT "https://api.confident-ai.com/v2/organization/models/{modelType}" \
  -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "provider": "OPEN_AI",
  "name": "gemini-2.0-flash",
  "maxConcurrency": 5,
  "maxInputTokens": 128000
}'

200

{
  "success": true,
  "data": {
    "id": "<MODEL-ID>",
    "type": "EVALUATION",
    "provider": "GEMINI",
    "name": "gemini-2.0-flash",
    "maxConcurrency": 5,
    "maxInputTokens": 128000,
    "projectId": null,
    "organizationId": "<ORGANIZATION-ID>"
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Path parameters

modelTypeenumRequired
Which of the organization's models to set.

Request body

providerenumRequired
This is the provider of the model.
Show 18 enum valuesHide 18 enum values
- OPEN_AI
- CUSTOM
- CONFIDENT_AI
- BEDROCK
- ANTHROPIC
- GEMINI
- X_AI
- DEEPSEEK
- MOONSHOT_AI
- VERTEX_AI
- AZURE
- MISTRAL
- PERPLEXITY
- OPEN_ROUTER
- PORTKEY
- LITE_LLM
- TRUE_FOUNDRY
- HUGGING_FACE
namestring
The model to call at that provider, for example gemini-2.0-flash. Omit it to fall back to the provider's default; it is ignored for CONFIDENT_AI, which always stores a null name. A Portkey model must be written as the saved integration slug, for example @openai-prod/gpt-4o.
maxConcurrencyinteger | null
How many calls Confident AI may make to this model at once. Omit it or send null for no limit of its own.
maxInputTokensinteger | null
How many input tokens Confident AI may send to this model per call. Omit it or send null for no limit of its own.

Response

Set Model succeeded.

successboolean
Indicates if the request was successful.
dataobject
One model configuration: the provider and model Confident AI calls for a given purpose, with the limits it calls them under. A configuration belongs either to the organization (organizationId set) or to a single project (projectId set), never to both.
Show 8 propertiesHide 8 properties
- idstring
  The id of the model configuration, generated by Confident AI.
- typeenum
  What a configured model is used for. EVALUATION is the LLM judge that scores a project's metrics, PLATFORM is the model behind Confident AI's own AI features such as classification, summaries and report generation, and SIMULATION is the model that simulates user turns in conversation simulations. Those three are the only types the public API reads or writes.
  Show 6 enum valuesHide 6 enum values
  - EVALUATION
  - PLATFORM
  - GENERATION
  - SIMULATION
  - TEXT_TO_SPEECH
  - SPEECH_TO_TEXT
- providerenum | null
  This is the provider of the model.
  Show 18 enum valuesHide 18 enum values
  - OPEN_AI
  - CUSTOM
  - CONFIDENT_AI
  - BEDROCK
  - ANTHROPIC
  - GEMINI
  - X_AI
  - DEEPSEEK
  - MOONSHOT_AI
  - VERTEX_AI
  - AZURE
  - MISTRAL
  - PERPLEXITY
  - OPEN_ROUTER
  - PORTKEY
  - LITE_LLM
  - TRUE_FOUNDRY
  - HUGGING_FACE
- namestring | null
  The model to call at that provider, or null when the provider's default is used. Always null for CONFIDENT_AI.
- maxConcurrencyinteger | null
  How many calls Confident AI makes to this model at once, or null for no limit of its own.
- maxInputTokensinteger | null
  How many input tokens Confident AI sends to this model per call, or null for no limit of its own.
- projectIdstring | null
  The id of the project this configuration overrides the organization default for, or null when it is the organization default itself.
- organizationIdstring | null
  The id of the organization this configuration is the default for, or null when it is a project override.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI