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

import requests

url = "https://api.arize.com/v2/annotation-queues/{annotation_queue_id}"

payload = {
    "name": "Updated Queue Name",
    "instructions": "Review each response for accuracy and helpfulness",
    "annotation_config_ids": ["ac_abc123"],
    "annotator_emails": ["reviewer@example.com"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Updated Queue Name',
    instructions: 'Review each response for accuracy and helpfulness',
    annotation_config_ids: ['ac_abc123'],
    annotator_emails: ['reviewer@example.com']
  })
};

fetch('https://api.arize.com/v2/annotation-queues/{annotation_queue_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.arize.com/v2/annotation-queues/{annotation_queue_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Updated Queue Name',
    'instructions' => 'Review each response for accuracy and helpfulness',
    'annotation_config_ids' => [
        'ac_abc123'
    ],
    'annotator_emails' => [
        'reviewer@example.com'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.arize.com/v2/annotation-queues/{annotation_queue_id}"

	payload := strings.NewReader("{\n  \"name\": \"Updated Queue Name\",\n  \"instructions\": \"Review each response for accuracy and helpfulness\",\n  \"annotation_config_ids\": [\n    \"ac_abc123\"\n  ],\n  \"annotator_emails\": [\n    \"reviewer@example.com\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.arize.com/v2/annotation-queues/{annotation_queue_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Updated Queue Name\",\n  \"instructions\": \"Review each response for accuracy and helpfulness\",\n  \"annotation_config_ids\": [\n    \"ac_abc123\"\n  ],\n  \"annotator_emails\": [\n    \"reviewer@example.com\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arize.com/v2/annotation-queues/{annotation_queue_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Updated Queue Name\",\n  \"instructions\": \"Review each response for accuracy and helpfulness\",\n  \"annotation_config_ids\": [\n    \"ac_abc123\"\n  ],\n  \"annotator_emails\": [\n    \"reviewer@example.com\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "aq_abc123",
  "name": "Quality Review Queue",
  "space_id": "spc_xyz789",
  "instructions": "Review each response for accuracy and helpfulness",
  "annotation_configs": [
    {
      "id": "ac_001",
      "name": "accuracy",
      "type": "CONTINUOUS",
      "space_id": "spc_xyz789",
      "minimum_score": 0,
      "maximum_score": 10,
      "optimization_direction": "MAXIMIZE",
      "created_at": "2024-01-10T08:00:00Z"
    },
    {
      "id": "ac_002",
      "name": "sentiment",
      "type": "CATEGORICAL",
      "space_id": "spc_xyz789",
      "values": [
        {
          "label": "positive",
          "score": 1
        },
        {
          "label": "neutral",
          "score": 0
        },
        {
          "label": "negative",
          "score": -1
        }
      ],
      "optimization_direction": "MAXIMIZE",
      "created_at": "2024-01-10T08:00:00Z"
    }
  ],
  "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"
}

{
  "status": 400,
  "title": "Invalid request parameters",
  "detail": "The 'name' field is required and must be a non-empty string.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#invalid-request"
}

{
  "status": 401,
  "title": "Authentication required",
  "detail": "You must be authenticated to access this resource.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#authentication-required"
}

{
  "status": 403,
  "title": "Access forbidden",
  "detail": "You do not have permission to access this resource.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#access-forbidden"
}

{
  "status": 404,
  "title": "Resource not found",
  "detail": "The requested resource with ID '12345' was not found.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#resource-not-found"
}

{
  "status": 409,
  "title": "Resource conflict",
  "detail": "A resource with the given identifier already exists.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#resource-conflict"
}

{
  "status": 422,
  "title": "Unprocessable Entity",
  "detail": "One or more fields failed validation.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity"
}

{
  "status": 429,
  "title": "Rate limit exceeded",
  "detail": "You have exceeded the allowed number of requests. Please try again later.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded"
}

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)

{}

PATCH

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

import requests

url = "https://api.arize.com/v2/annotation-queues/{annotation_queue_id}"

payload = {
    "name": "Updated Queue Name",
    "instructions": "Review each response for accuracy and helpfulness",
    "annotation_config_ids": ["ac_abc123"],
    "annotator_emails": ["reviewer@example.com"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Updated Queue Name',
    instructions: 'Review each response for accuracy and helpfulness',
    annotation_config_ids: ['ac_abc123'],
    annotator_emails: ['reviewer@example.com']
  })
};

fetch('https://api.arize.com/v2/annotation-queues/{annotation_queue_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.arize.com/v2/annotation-queues/{annotation_queue_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Updated Queue Name',
    'instructions' => 'Review each response for accuracy and helpfulness',
    'annotation_config_ids' => [
        'ac_abc123'
    ],
    'annotator_emails' => [
        'reviewer@example.com'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.arize.com/v2/annotation-queues/{annotation_queue_id}"

	payload := strings.NewReader("{\n  \"name\": \"Updated Queue Name\",\n  \"instructions\": \"Review each response for accuracy and helpfulness\",\n  \"annotation_config_ids\": [\n    \"ac_abc123\"\n  ],\n  \"annotator_emails\": [\n    \"reviewer@example.com\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.arize.com/v2/annotation-queues/{annotation_queue_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Updated Queue Name\",\n  \"instructions\": \"Review each response for accuracy and helpfulness\",\n  \"annotation_config_ids\": [\n    \"ac_abc123\"\n  ],\n  \"annotator_emails\": [\n    \"reviewer@example.com\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arize.com/v2/annotation-queues/{annotation_queue_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Updated Queue Name\",\n  \"instructions\": \"Review each response for accuracy and helpfulness\",\n  \"annotation_config_ids\": [\n    \"ac_abc123\"\n  ],\n  \"annotator_emails\": [\n    \"reviewer@example.com\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "aq_abc123",
  "name": "Quality Review Queue",
  "space_id": "spc_xyz789",
  "instructions": "Review each response for accuracy and helpfulness",
  "annotation_configs": [
    {
      "id": "ac_001",
      "name": "accuracy",
      "type": "CONTINUOUS",
      "space_id": "spc_xyz789",
      "minimum_score": 0,
      "maximum_score": 10,
      "optimization_direction": "MAXIMIZE",
      "created_at": "2024-01-10T08:00:00Z"
    },
    {
      "id": "ac_002",
      "name": "sentiment",
      "type": "CATEGORICAL",
      "space_id": "spc_xyz789",
      "values": [
        {
          "label": "positive",
          "score": 1
        },
        {
          "label": "neutral",
          "score": 0
        },
        {
          "label": "negative",
          "score": -1
        }
      ],
      "optimization_direction": "MAXIMIZE",
      "created_at": "2024-01-10T08:00:00Z"
    }
  ],
  "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"
}

{
  "status": 400,
  "title": "Invalid request parameters",
  "detail": "The 'name' field is required and must be a non-empty string.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#invalid-request"
}

{
  "status": 401,
  "title": "Authentication required",
  "detail": "You must be authenticated to access this resource.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#authentication-required"
}

{
  "status": 403,
  "title": "Access forbidden",
  "detail": "You do not have permission to access this resource.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#access-forbidden"
}

{
  "status": 404,
  "title": "Resource not found",
  "detail": "The requested resource with ID '12345' was not found.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#resource-not-found"
}

{
  "status": 409,
  "title": "Resource conflict",
  "detail": "A resource with the given identifier already exists.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#resource-conflict"
}

{
  "status": 422,
  "title": "Unprocessable Entity",
  "detail": "One or more fields failed validation.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity"
}

{
  "status": 429,
  "title": "Rate limit exceeded",
  "detail": "You have exceeded the allowed number of requests. Please try again later.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded"
}

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 annotation queue identifier (base64) A universally unique identifier (base64-encoded opaque string).

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 | null

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

Required string length: 1 - 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"
]

column_allowlist

string[] | null

The full list of record column names annotators assigned to this queue are allowed to see. This replaces the existing allowlist. Set to null to remove the restriction so annotators see every column. Omit to leave it unchanged.

Maximum array length: 1000

Maximum string length: 512

Example:

[
  "context.trace_id",
  "attributes.llm.input_messages",
  "column with spaces"
]

Response

An annotation queue object

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

Show child attributes

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

Option 1
Option 2
Option 3

Show child attributes

column_allowlist

string[] | null

The record column names annotators assigned to this queue are allowed to see. Absent or null means the queue is unrestricted and annotators see every column.

Example:

[
  "context.trace_id",
  "attributes.llm.input_messages",
  "column with spaces"
]

⌘I

Skills

API reference

API clients

Update an annotation queue

Authorizations

Path Parameters

Body

Response