List Tool Versions

(v2)

GET

Lists a tool's versions, newest first, so the first is its latest. Changing a tool's mode or schema adds a version.

GET/v2/tools/{toolId}/versions

curl -X GET "https://api.confident-ai.com/v2/tools/{toolId}/versions" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "versions": [
      {
        "version": "00.00.02",
        "mode": "ALLOW_ADDITIONAL",
        "schema": {
          "type": "object",
          "properties": {
            "customerId": {
              "type": "string",
              "description": "The id of the customer to look up."
            },
            "nameFormat": {
              "type": "string",
              "enum": [
                "FULL",
                "FIRST"
              ],
              "description": "Whether to return the full name or only the first name."
            }
          },
          "required": [
            "customerId"
          ]
        },
        "createdAt": "2025-01-18T16:45:00.000Z"
      }
    ],
    "totalToolVersions": 2,
    "page": 1,
    "pageSize": 25
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

toolIdstringRequired
The id of the tool.

Query parameters

pageintegerdefault: 1
The page to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of versions per page, at most 100. Defaults to 25.

Response

List Tool Versions succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of a tool's versions, with the total across all pages.
Show 4 propertiesHide 4 properties
- versionslist of objects
  The tool's versions for the current page, newest first.
  Show 4 propertiesHide 4 properties
  - versionstring
    The version 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
  - schemaobject
    The JSON Schema for the tool's input. List each parameter under properties with a type, and name the mandatory ones in required. A parameter can also have a description, an enum of allowed values, or items for an array. Whether extra properties are allowed is set by mode.
  - createdAtstring
    When the version was saved.
- totalToolVersionsinteger
  The number of versions this tool has.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of versions per page.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI