List Forms

GEThttps://api.confident-ai.com/v2/annotation-forms

Lists the annotation forms in your Confident AI project, oldest first. Each form is returned as a summary with its field and queue counts; retrieve a form by id for its questions.

GET/v2/annotation-forms

curl -X GET "https://api.confident-ai.com/v2/annotation-forms" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "annotationForms": [
      {
        "id": "<ANNOTATION-FORM-ID>",
        "name": "Answer quality review",
        "fieldCount": 3,
        "queueCount": 2,
        "createdAt": "2025-01-15T10:30:00.000Z",
        "updatedAt": "2025-01-16T09:00:00.000Z"
      }
    ]
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/project-settings/annotation",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Response

List Forms succeeded.

successboolean
Indicates if the request was successful.
dataobject
The annotation forms in the project.
Show 1 propertyHide 1 property
- annotationFormslist of objects
  The forms in this project, oldest first.
  Show 6 propertiesHide 6 properties
  - idstring
    The id of the form, generated by Confident AI.
  - namestring
    The name of the form, shown wherever a queue offers it.
  - fieldCountinteger
    How many questions the form carries.
  - queueCountinteger
    How many annotation queues currently use this form.
  - createdAtstring
    When the form was created.
  - updatedAtstring
    When the form was last changed.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI