Launch Week 02 wrapped — explore all five launches

Get Model

GEThttps://api.confident-ai.com/v2/projects/{projectId}/models

Returns the model in effect for the project, selected by the required type query parameter. EVALUATION is the LLM judge that scores this project's metrics. 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.

source tells you where the returned model comes from: project when the project has an override of its own, organization when it follows the organization's default. The evaluation model is always project scoped, so it always reports project.

Reading never creates configuration, so model is null when nothing has been set for that type — which for PLATFORM and SIMULATION means neither the project nor the organization has configured one.

GET/v2/projects/{projectId}/models
curl -X GET "https://api.confident-ai.com/v2/projects/{projectId}/models" \
  -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>"
200
{
  "success": true,
  "data": {
    "model": {
      "id": "<MODEL-ID>",
      "type": "EVALUATION",
      "provider": "GEMINI",
      "name": "gemini-2.0-flash",
      "maxConcurrency": 5,
      "maxInputTokens": 128000,
      "projectId": null,
      "organizationId": "<ORGANIZATION-ID>"
    },
    "source": "project"
  },
  "deprecated": false
}

Headers

  • CONFIDENT_API_KEYstringRequired

    The organization API key for your Confident AI organization.

Path parameters

  • projectIdstringRequired

    The id of the project, which must belong to the organization your API key is scoped to.

Query parameters

  • typeenumRequired

    Which of the project's models to read.

Response

Get Model succeeded.

  • successboolean

    Indicates if the request was successful.

  • dataobject

    The model the project actually runs for one type, whether that is its own override or the organization's default.

    Show 2 propertiesHide 2 properties
    • modelobject | null

      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.

    • sourceenum

      Where the model in effect for a project comes from: project when the project has an override of its own, organization when it follows the organization's default. The evaluation model is always project scoped, so it only ever reports project.

      Show 2 enum valuesHide 2 enum values
      • project
      • organization
  • deprecatedboolean

    Indicates if this endpoint is deprecated.

Built byConfident AI