Skip to main content
PATCH
/
v2
/
annotation-queues
/
{annotation_queue_id}
Update an annotation queue
curl --request PATCH \
  --url https://api.arize.com/v2/annotation-queues/{annotation_queue_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Queue Name",
  "instructions": "Review each response for accuracy and helpfulness",
  "annotation_config_ids": [
    "ac_abc123"
  ],
  "annotator_emails": [
    "reviewer@example.com"
  ]
}
'
{
  "id": "aq_abc123",
  "name": "Updated Queue Name",
  "space_id": "spc_xyz789",
  "instructions": "Review each response for accuracy and helpfulness",
  "annotation_configs": [],
  "annotators": [
    {
      "id": "usr_001",
      "email": "reviewer@example.com"
    },
    {
      "id": "usr_002",
      "email": "annotator@example.com"
    }
  ],
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z"
}

Authorizations

​
Authorization
string
header
required

Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format

Path Parameters

​
annotation_queue_id
string
required

The unique identifier of the annotation queue A universally unique identifier

Example:

"RW50aXR5OjEyMzQ1"

Body

application/json

Body containing annotation queue update parameters. At least one field must be provided.

​
name
string

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

Required string length: 1 - 255
Example:

"Updated Queue Name"

​
instructions
string

The instructions for annotators working on this queue. Send an empty string to clear the instructions.

Maximum string length: 5000
Example:

"Review each response for accuracy and helpfulness"

​
annotation_config_ids
string[]

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.

Example:
["ac_abc123", "ac_def456"]
​
annotator_emails
string<email>[]

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.

An email address

Example:
[
  "reviewer@example.com",
  "annotator@example.com"
]

Response

Annotation queue successfully updated

​
id
string
required

The unique identifier for the annotation queue

Example:

"aq_abc123"

​
name
string
required

The name of the annotation queue

Example:

"Quality Review Queue"

​
space_id
string
required

The space id the annotation queue belongs to

Example:

"spc_xyz789"

​
annotators
object[]
required

Users assigned as annotators to this queue

​
created_at
string<date-time>
required

The timestamp for when the annotation queue was created

Example:

"2024-01-15T10:30:00Z"

​
updated_at
string<date-time>
required

The timestamp for when the annotation queue was last updated

Example:

"2024-01-20T14:45:00Z"

​
instructions
string | null

The instructions for the annotation queue

Example:

"Review each response for accuracy and helpfulness"

​
annotation_configs
object[]

The annotation configs associated with this queue