v2

latestOpenAPI 3.0.3Apache-2.02026-08-07119359591.9 KB

Annotation Queues

Update an annotation queue

Update an annotation queue by its ID. At least one field must be provided.

Payload Requirements

At least one of name, instructions, annotation_config_ids, or annotator_emails must be provided
name must be unique within the space (409 Conflict if duplicate)
annotation_config_ids replaces all existing config associations; all configs must belong to the same space as the queue
annotator_emails replaces all existing user assignments; all users must have active accounts

Valid example

{
  "name": "Updated Review Queue",
  "annotation_config_ids": ["QW5ub3RhdGlvbkNvbmZpZzoxOmFCY0Q=", "QW5ub3RhdGlvbkNvbmZpZzoyOmFCY0Q="],
  "annotator_emails": ["reviewer@example.com"]
}

Invalid example (empty body — no fields provided)

{}

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

patch/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)

Request body

namestring

The name of the annotation queue. Must be unique within the space.

instructionsstring nullable

The instructions for annotators working on this queue. Set to null to clear the instructions.

annotation_config_idsstring[]

The full list of annotation config IDs to associate with this queue. This replaces all existing annotation config associations. All annotation configs must belong to the same space as the queue.

annotator_emailsEmail[]

The full list of user emails to assign to this queue. This replaces all existing user assignments. All users must have an active account and access to the queue's space.

Example request

{
  "name": "Updated Queue Name",
  "instructions": "Review each response for accuracy and helpfulness",
  "annotation_config_ids": [
    "ac_abc123",
    "ac_def456"
  ],
  "annotator_emails": [
    "reviewer@example.com",
    "annotator@example.com"
  ]
}

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"
}