v2

latestOpenAPI 3.0.3Apache-2.02026-08-07119359591.9 KB

Annotation Queues

Get an annotation queue

Get an annotation queue object by its ID.

This includes the annotation queue's annotation configs, which define the structure of annotations that can be created in this queue.

This endpoint does not include queue records or annotation progress. To manage records in a queue, use the Annotation Queue Items endpoints.

<Note>This endpoint is in beta, read more here.</Note>

get/v2/annotation-queues/{annotation_queue_id}

Path parameters

annotation_queue_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique annotation queue identifier (base64)

Response

An annotation queue object

idstring required

The unique identifier for the annotation queue

namestring required

The name of the annotation queue

space_idstring required

The space id the annotation queue belongs to

instructionsstring nullable

The instructions for the annotation queue

created_atstring date-time required

The timestamp for when the annotation queue was created

updated_atstring date-time required

The timestamp for when the annotation queue was last updated

Example response

{
  "id": "aq_abc123",
  "name": "Quality Review Queue",
  "space_id": "spc_xyz789",
  "instructions": "Review each response for accuracy and helpfulness",
  "annotators": [
    {
      "email": "user@example.com"
    }
  ],
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z"
}