List Classifier Labels

GEThttps://api.confident-ai.com/v1/classifiers/{classifierId}/labels

Lists a classifier's labels alphabetically, as summary rows. This is also how you read the results of a generation run — generated suggestions arrive with status RECOMMENDED. Retrieve a label by id for its description and polarity. Requires the Starter plan or above.

GET/v1/classifiers/{classifierId}/labels

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

200

{
  "success": true,
  "data": {
    "labels": [
      {
        "id": "LABEL-ID",
        "name": "Positive",
        "enabled": true,
        "status": "ACTIVE"
      }
    ]
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/workflows"
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

classifierIdstringRequired
The unique identifier of the classifier.

Response

successboolean
Indicates if the request was successful.
dataobject
Show 1 propertyHide 1 property
- labelslist of objects
  The classifier's labels, alphabetically, as summary rows.
  Show 4 propertiesHide 4 properties
  - idstring
    The unique identifier of the label.
  - namestring
    The label's name.
  - enabledboolean
    Whether the label can be applied.
  - statusenum
    ACTIVE labels are in use; RECOMMENDED ones are generated suggestions awaiting review.
    Show 2 enum valuesHide 2 enum values
    RECOMMENDED
    ACTIVE
linkstring
A link to the workflows page.

Built byConfident AI