List Classifier Versions

(v2)

GET

Lists a classifier's version history, newest first, so the first entry is what the classifying model is shown today. A version is appended whenever the description or the set of labels the model can apply changes, which includes RECOMMENDED labels added by a generation run or by the model itself while the classifier classifies automatically. A version can be restored in the app, not through this API. Requires the Starter plan or above.

GET/v2/classifiers/{classifierId}/versions

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

200

{
  "success": true,
  "data": {
    "versions": [
      {
        "id": "<CLASSIFIER-VERSION-ID>",
        "classifierId": "<CLASSIFIER-ID>",
        "sequence": 2,
        "version": "00.00.02",
        "description": "Analyzes the emotional tone of user interactions.",
        "labels": [
          {
            "name": "Positive",
            "description": "User expresses satisfaction, gratitude, or positive sentiment."
          }
        ],
        "createdAt": "2025-01-18T16:45:00.000Z",
        "author": {
          "id": "<USER-ID>",
          "email": "jane@acme.com",
          "name": "Jane Doe",
          "image": null
        }
      }
    ],
    "totalClassifierVersions": 2,
    "page": 1,
    "pageSize": 25
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/workflows",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

classifierIdstringRequired
The id of the classifier.

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 Classifier Versions succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of a classifier's version history, with the total across all pages.
Show 4 propertiesHide 4 properties
- versionslist of objects
  The classifier's history for the current page, newest version first, so the first entry of the first page is the current version.
  Show 8 propertiesHide 8 properties
  - idstring
    The id of the version, generated by Confident AI.
  - classifierIdstring
    The id of the classifier this version belongs to.
  - sequenceinteger
    The position of this version in the classifier's history, counting from 1. The highest sequence is the current version, which is the one new classifications run against.
  - versionstring
    The human-readable label for sequence, written as three two-digit groups that roll over at 100, so sequence 2 is 00.00.02 and sequence 100 is 00.01.00.
  - descriptionstring | null
    The classifier description the model was shown, or null when it had none.
  - labelslist of objects
    The labels the model could apply, ordered by name: enabled ACTIVE labels, plus enabled RECOMMENDED ones when the classifier classifies automatically.
    Show 2 propertiesHide 2 properties
    namestring
    The name of the label.
    descriptionstring
    When the label applies, as the classifying model read it.
  - createdAtstring
    When this version was snapshotted.
  - authorobject | null
    A Confident AI user, as referenced by the records they created.
    Show 4 propertiesHide 4 properties
    idstring
    This is the id of the user.
    emailstring
    This is the email address of the user.
    namestring | null
    This is the display name of the user, or null when they have not set one.
    imagestring | null
    This is the URL of the user's avatar, or null when they have none.
- totalClassifierVersionsinteger
  The number of versions this classifier has, across every page.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of versions per page.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI