Pull By Label

GEThttps://api.confident-ai.com/v2/prompts/{promptId}/labels/{label}

Retrieves the prompt version carrying label.

GET/v2/prompts/{promptId}/labels/{label}

curl -X GET "https://api.confident-ai.com/v2/prompts/{promptId}/labels/{label}" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "text": "Hello, {{name}}! How can I help you today?",
    "id": "<COMMIT-ID>",
    "hash": "bab04ce",
    "version": "00.00.01",
    "label": "production",
    "type": "TEXT",
    "interpolationType": "MUSTACHE",
    "modelSettings": {
      "provider": "OPEN_AI",
      "name": "gpt-4o",
      "temperature": 0.7,
      "maxTokens": 1024,
      "topP": 1,
      "topK": 40,
      "frequencyPenalty": 0,
      "presencePenalty": 0,
      "stopSequence": [
        "\n\nHuman:",
        "###"
      ],
      "reasoningEffort": "MINIMAL",
      "verbosity": "LOW"
    },
    "outputType": "TEXT",
    "outputSchema": {
      "name": "Greeting",
      "fields": [
        {
          "id": "<FIELD-ID>",
          "name": "greeting",
          "type": "OBJECT",
          "required": true,
          "parentId": null
        }
      ]
    },
    "tools": [
      {
        "id": "<TOOL-ID>",
        "name": "get_customer_name",
        "description": "Looks up the customer's name by id.",
        "mode": "ALLOW_ADDITIONAL",
        "structuredSchema": {
          "id": "<STRUCTURED-SCHEMA-ID>",
          "name": "GetCustomerNameInput",
          "fields": [
            {
              "id": "<FIELD-ID>",
              "name": "customerId",
              "description": "The id of the customer to look up.",
              "type": "OBJECT",
              "required": true,
              "parentId": null
            }
          ]
        }
      }
    ]
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

promptIdstringRequired
The unique id of the prompt.
labelstringRequired
The label of the version to pull.

Response

Pull By Label succeeded.

successboolean
Indicates if the request was successful.
dataobject | object
A single commit of a prompt, as pulled by version, commit hash, or label. It carries text when the prompt is a text prompt and messages when it is a messages prompt, never both.
Show 2 variantsHide 2 variants
- Text Promptobject
  A pulled prompt whose content is a single text template.
  Show 11 propertiesHide 11 properties
  - textstring
    This is the text content of the prompt.
  - idstring
    This is the id of the commit pulled, generated by Confident AI, not to be confused with the prompt id, the version number, or the commit hash.
  - hashstring
    This is the commit hash of the prompt pulled.
  - versionstring
    The version number of the prompt, present when the commit pulled has been released as a version.
  - labelstring
    The user-defined label of the version pulled, present when the version carries one.
  - typeenum
    This is the type of the prompt, which can be either a simple text or a list of messages.
    Show 2 enum valuesHide 2 enum values
    TEXT
    LIST
  - interpolationTypeenum
    The type of interpolation format used in the prompt to insert dynamic variables.
    Show 5 enum valuesHide 5 enum values
    MUSTACHE
    MUSTACHE_WITH_SPACE
    FSTRING
    DOLLAR_BRACKETS
    JINJA
  - modelSettingsobject
    This is the model settings the prompt was authored for.
    Show 11 propertiesHide 11 properties
    providerenum
    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
    This is the name of the model.
    temperaturenumber
    This controls randomness in the model's output. Higher values make output more random.
    maxTokensnumber
    This is the maximum number of tokens to generate.
    topPnumber
    This controls diversity via nucleus sampling. Lower values focus on more likely tokens.
    topKnumber
    This limits sampling to the K most likely tokens at each step.
    frequencyPenaltynumber
    This is the penalty for tokens based on their frequency in the text so far.
    presencePenaltynumber
    This is the penalty for tokens based on whether they appear in the text so far.
    stopSequencelist of strings
    This is the sequences where the model will stop generating further tokens.
    reasoningEffortenum
    This is the level of reasoning effort for the model.
    Show 4 enum valuesHide 4 enum values
    MINIMAL
    LOW
    MEDIUM
    HIGH
    verbosityenum
    This is the verbosity level for model output.
    Show 3 enum valuesHide 3 enum values
    LOW
    MEDIUM
    HIGH
  - outputTypeenum
    The type of output expected from the prompt.
    Show 3 enum valuesHide 3 enum values
    TEXT
    JSON
    SCHEMA
  - outputSchemaobject
    This is the output schema definition, used when outputType is SCHEMA.
    Show 2 propertiesHide 2 properties
    namestring
    This is the name of the output schema.
    fieldslist of objects
    This is the array of fields that define the output schema structure.
    Show 5 propertiesHide 5 properties
    idstring
    This is the unique identifier for the schema field. Use it as the parentId of nested fields.
    namestring
    This is the name of the schema field.
    typeenum
    This is the data type of a schema field.
    Show 7 enum valuesHide 7 enum values
    OBJECT
    ARRAY
    STRING
    FLOAT
    INTEGER
    BOOLEAN
    NULL
    requiredboolean
    This indicates whether the field is required in the output.
    parentIdstring | null
    This is the id of the parent field for nested structures, or null for a top-level field.
  - toolslist of objects
    This is the list of tools available to the prompt.
    Show 5 propertiesHide 5 properties
    idstring
    This is the id of the tool assigned by Confident AI.
    namestring
    This is the name of the tool.
    descriptionstring | null
    This is the description of the tool.
    modeenum
    This is the mode for your tool input fields, which controls whether fields outside the schema are allowed.
    Show 3 enum valuesHide 3 enum values
    ALLOW_ADDITIONAL
    NO_ADDITIONAL
    STRICT
    structuredSchemaobject
    This is the schema for your tool's input.
    Show 3 propertiesHide 3 properties
    idstring
    This is the id of the schema assigned by Confident AI.
    namestring | null
    This is the name of the schema.
    fieldslist of objects
    This is the array of fields that define the tool's input structure.
    Show 6 propertiesHide 6 properties
    idstring
    This is the unique identifier for the schema field. Use it as the parentId of nested fields.
    namestring | null
    This is the name of the schema field.
    descriptionstring | null
    This is the description of the schema field.
    typeenum
    This is the data type of a schema field.
    Show 7 enum valuesHide 7 enum values
    OBJECT
    ARRAY
    STRING
    FLOAT
    INTEGER
    BOOLEAN
    NULL
    requiredboolean
    This indicates whether the field is required in the input.
    parentIdstring | null
    This is the id of the parent field for nested structures, or null for a top-level field.
- OR
- Messages Promptobject
  A pulled prompt whose content is a list of messages.
  Show 11 propertiesHide 11 properties
  - messageslist of objects
    This is the list of messages that make up the prompt.
    Show 2 propertiesHide 2 properties
    rolestring
    This is the role of the message, which can be user, assistant, system, or developer.
    contentstring
    This is the text content of the message.
  - idstring
    This is the id of the commit pulled, generated by Confident AI, not to be confused with the prompt id, the version number, or the commit hash.
  - hashstring
    This is the commit hash of the prompt pulled.
  - versionstring
    The version number of the prompt, present when the commit pulled has been released as a version.
  - labelstring
    The user-defined label of the version pulled, present when the version carries one.
  - typeenum
    This is the type of the prompt, which can be either a simple text or a list of messages.
    Show 2 enum valuesHide 2 enum values
    TEXT
    LIST
  - interpolationTypeenum
    The type of interpolation format used in the prompt to insert dynamic variables.
    Show 5 enum valuesHide 5 enum values
    MUSTACHE
    MUSTACHE_WITH_SPACE
    FSTRING
    DOLLAR_BRACKETS
    JINJA
  - modelSettingsobject
    This is the model settings the prompt was authored for.
    Show 11 propertiesHide 11 properties
    providerenum
    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
    This is the name of the model.
    temperaturenumber
    This controls randomness in the model's output. Higher values make output more random.
    maxTokensnumber
    This is the maximum number of tokens to generate.
    topPnumber
    This controls diversity via nucleus sampling. Lower values focus on more likely tokens.
    topKnumber
    This limits sampling to the K most likely tokens at each step.
    frequencyPenaltynumber
    This is the penalty for tokens based on their frequency in the text so far.
    presencePenaltynumber
    This is the penalty for tokens based on whether they appear in the text so far.
    stopSequencelist of strings
    This is the sequences where the model will stop generating further tokens.
    reasoningEffortenum
    This is the level of reasoning effort for the model.
    Show 4 enum valuesHide 4 enum values
    MINIMAL
    LOW
    MEDIUM
    HIGH
    verbosityenum
    This is the verbosity level for model output.
    Show 3 enum valuesHide 3 enum values
    LOW
    MEDIUM
    HIGH
  - outputTypeenum
    The type of output expected from the prompt.
    Show 3 enum valuesHide 3 enum values
    TEXT
    JSON
    SCHEMA
  - outputSchemaobject
    This is the output schema definition, used when outputType is SCHEMA.
    Show 2 propertiesHide 2 properties
    namestring
    This is the name of the output schema.
    fieldslist of objects
    This is the array of fields that define the output schema structure.
    Show 5 propertiesHide 5 properties
    idstring
    This is the unique identifier for the schema field. Use it as the parentId of nested fields.
    namestring
    This is the name of the schema field.
    typeenum
    This is the data type of a schema field.
    Show 7 enum valuesHide 7 enum values
    OBJECT
    ARRAY
    STRING
    FLOAT
    INTEGER
    BOOLEAN
    NULL
    requiredboolean
    This indicates whether the field is required in the output.
    parentIdstring | null
    This is the id of the parent field for nested structures, or null for a top-level field.
  - toolslist of objects
    This is the list of tools available to the prompt.
    Show 5 propertiesHide 5 properties
    idstring
    This is the id of the tool assigned by Confident AI.
    namestring
    This is the name of the tool.
    descriptionstring | null
    This is the description of the tool.
    modeenum
    This is the mode for your tool input fields, which controls whether fields outside the schema are allowed.
    Show 3 enum valuesHide 3 enum values
    ALLOW_ADDITIONAL
    NO_ADDITIONAL
    STRICT
    structuredSchemaobject
    This is the schema for your tool's input.
    Show 3 propertiesHide 3 properties
    idstring
    This is the id of the schema assigned by Confident AI.
    namestring | null
    This is the name of the schema.
    fieldslist of objects
    This is the array of fields that define the tool's input structure.
    Show 6 propertiesHide 6 properties
    idstring
    This is the unique identifier for the schema field. Use it as the parentId of nested fields.
    namestring | null
    This is the name of the schema field.
    descriptionstring | null
    This is the description of the schema field.
    typeenum
    This is the data type of a schema field.
    Show 7 enum valuesHide 7 enum values
    OBJECT
    ARRAY
    STRING
    FLOAT
    INTEGER
    BOOLEAN
    NULL
    requiredboolean
    This indicates whether the field is required in the input.
    parentIdstring | null
    This is the id of the parent field for nested structures, or null for a top-level field.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI