List Queues

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

Lists the annotation queues in your Confident AI project one page at a time, newest first. Each queue is returned as a summary with its progress; retrieve a queue by id for the per-reviewer breakdown.

GET/v2/annotation-queues

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

200

{
  "success": true,
  "data": {
    "annotationQueues": [
      {
        "id": "<ANNOTATION-QUEUE-ID>",
        "name": "Failed geography answers",
        "type": "TRACE",
        "createdAt": "2025-01-15T10:30:00.000Z",
        "updatedAt": "2025-01-16T09:00:00.000Z",
        "testRunId": null,
        "formId": "<ANNOTATION-FORM-ID>",
        "totalItems": 40,
        "completedItems": 30,
        "pendingItems": 10,
        "completionPercentage": 75
      }
    ],
    "totalAnnotationQueues": 3,
    "page": 1,
    "pageSize": 25
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

pageintegerdefault: 1
The page of queues to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of queues per page, at most 100. Defaults to 25.
typeenum
Returns only queues holding this kind of item.
searchTermstring
Returns only queues whose name contains this text.

Response

List Queues succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of annotation queues, with the total across all pages.
Show 4 propertiesHide 4 properties
- annotationQueueslist of objects
  The queues for the current page, newest first.
  Show 11 propertiesHide 11 properties
  - idstring
    The id of the queue, generated by Confident AI.
  - namestring
    The name of the queue, unique within the project.
  - typeenum
    What a queue holds, fixed when it is created: TRACE, SPAN or THREAD queues are filled from your production data, while GOLDEN and TEST_RUN queues are filled by Confident AI.
    Show 5 enum valuesHide 5 enum values
    TRACE
    SPAN
    THREAD
    GOLDEN
    TEST_RUN
  - createdAtstring
    When the queue was created.
  - updatedAtstring
    When the queue was last changed.
  - testRunIdstring | null
    The id of the test run this queue reviews, for a queue Confident AI created from a test run. Null for a queue you created.
  - formIdstring | null
    The id of the annotation form asked of every item in this queue, or null when annotators only rate the criteria.
  - totalItemsinteger
    How many items the queue holds.
  - completedItemsinteger
    How many of those items have been annotated.
  - pendingItemsinteger
    How many items are still waiting to be annotated.
  - completionPercentageinteger
    The share of the queue that has been annotated, from 0 to 100, rounded to a whole number.
- totalAnnotationQueuesinteger
  The total number of queues matching the query.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of queues per page.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI