Annotation Queue Items Query

Query items in an annotation queue with pagination and sorting.

POST /annotation_queues/{queue_id}/items/query

Annotation Queue Items Query

cURL

curl --request POST \
  --url https://api.example.com/annotation_queues/{queue_id}/items/query \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "filter": {
    "id": "<string>",
    "call_id": "<string>",
    "call_op_name": "<string>",
    "call_trace_id": "<string>",
    "added_by": "<string>",
    "annotation_states": [
      "unstarted",
      "in_progress"
    ]
  },
  "sort_by": [
    {
      "field": "<string>",
      "direction": "asc"
    }
  ],
  "limit": 50,
  "offset": 0,
  "include_position": false
}
'

200

{
  "items": [
    {
      "id": "<string>",
      "project_id": "<string>",
      "queue_id": "<string>",
      "call_id": "<string>",
      "call_started_at": "2023-11-07T05:31:56Z",
      "call_op_name": "<string>",
      "call_trace_id": "<string>",
      "display_fields": [
        "<string>"
      ],
      "annotation_state": "unstarted",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "call_ended_at": "2023-11-07T05:31:56Z",
      "added_by": "<string>",
      "annotator_user_id": "<string>",
      "deleted_at": "2023-11-07T05:31:56Z",
      "position_in_queue": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

queue_id · string · required

Body

application/json

Request body for querying items in an annotation queue (queue_id comes from path).

project_id · string · required

Example:

"entity/project"

filter · AnnotationQueueItemsFilter · object

Filter queue items by call metadata and annotation state

Show child attributes

sort_by · SortBy · object[] | null

Sort by multiple fields (e.g., created_at, updated_at)

Show child attributes

limit · integer | null

Example:

50

offset · integer | null

Example:

0

include_position · boolean · default: false

Include position_in_queue field (1-based index in full queue)

Response

200

application/json

Successful Response

Response from querying annotation queue items.

items · AnnotationQueueItemSchema · object[] · required

Show child attributes