List Items

GEThttps://api.confident-ai.com/v2/annotation-queues/{annotationQueueId}/items

Lists the items in an annotation queue one page at a time, oldest first. Filter by status to see only what is still waiting to be annotated, only what a reviewer has set aside, or only what is done.

GET/v2/annotation-queues/{annotationQueueId}/items

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

200

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "<QUEUE-ITEM-ID>",
        "traceUuid": "3f9c2a1e-5b7d-4c8e-9f01-2a3b4c5d6e7f",
        "spanUuid": null,
        "threadId": null,
        "testCaseId": null,
        "addedAt": "2025-01-15T10:30:00.000Z",
        "status": "IN_PROGRESS",
        "assignedToEmail": "jane@acme.com"
      }
    ],
    "totalAnnotationQueueItems": 40,
    "page": 1,
    "pageSize": 25
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/annotation-queues/<ANNOTATION-QUEUE-ID>",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

annotationQueueIdstringRequired
The id of the annotation queue.

Query parameters

pageintegerdefault: 1
The page of items to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of items per page, at most 100. Defaults to 25.
statusenum
Returns only items in this state. Omit to return every item whatever its state.

Response

List Items succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of queue items, with the total across all pages.
Show 4 propertiesHide 4 properties
- itemslist of objects
  The items for the current page, oldest first.
  Show 8 propertiesHide 8 properties
  - idstring
    The id of the queue item, generated by Confident AI.
  - traceUuidstring | null
    The uuid of the trace waiting to be annotated, or null for an item of another kind.
  - spanUuidstring | null
    The uuid of the span waiting to be annotated, or null for an item of another kind.
  - threadIdstring | null
    The id of the thread waiting to be annotated, or null for an item of another kind.
  - testCaseIdstring | null
    The id of the test case waiting to be annotated, for a queue Confident AI created from a test run.
  - addedAtstring
    When the item was added to the queue.
  - statusenum
    Where an item stands in the review: IN_PROGRESS while it waits to be annotated, DEFERRED once a reviewer has set it aside to come back to, and COMPLETED once it has been annotated.
    Show 3 enum valuesHide 3 enum values
    IN_PROGRESS
    DEFERRED
    COMPLETED
  - assignedToEmailstring | null
    The email address of the reviewer this item is assigned to, or null when it is open to anyone.
- totalAnnotationQueueItemsinteger
  The total number of items matching the query.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of items 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