Create annotation queue records

curl --request POST \
  --url https://api.arize.com/v2/annotation-queues/{annotation_queue_id}/records \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "record_sources": [
    {
      "record_type": "span",
      "project_id": "proj_abc123",
      "start_time": "2024-01-15T00:00:00Z",
      "end_time": "2024-01-15T23:59:59Z",
      "span_ids": [
        "span_abc123",
        "span_def456"
      ]
    }
  ]
}
'

{
  "record_sources": [
    {
      "id": "aqr_001",
      "annotation_queue_id": "aq_abc123",
      "source_type": "spans",
      "data": {
        "input": "What is the capital of France?",
        "output": "Paris"
      },
      "annotations": [],
      "evaluations": [],
      "assigned_users": [
        {
          "user": {
            "id": "usr_123",
            "email": "reviewer@example.com"
          },
          "completion_status": "pending"
        }
      ]
    },
    {
      "id": "aqr_002",
      "annotation_queue_id": "aq_abc123",
      "source_type": "dataset",
      "data": {
        "input": "Summarize this article in one sentence.",
        "output": "The article discusses climate change impacts."
      },
      "annotations": [],
      "evaluations": [],
      "assigned_users": [
        {
          "user": {
            "id": "usr_123",
            "email": "reviewer@example.com"
          },
          "completion_status": "pending"
        }
      ]
    }
  ]
}

Annotation Queues

Create annotation queue records

Add new records from either spans (a project) or from dataset examples to an existing annotation queue.

Payload Requirements

At least one record source is required.
At most 2 record sources are allowed per request
For span record source: start_time must be before end_time, and the range must not exceed 7 days.
For dataset record source: all example_ids must be non-empty strings.
For spans record source: all span_ids must be non-empty strings.
At most 500 records total may be added in one request

Valid example

{
  "record_sources": [
    {
      "record_type": "span",
      "project_id": "TW9kZWw6MTIzOmFCY0Q=",
      "start_time": "2026-01-15T00:00:00Z",
      "end_time": "2026-01-16T00:00:00Z",
      "span_ids": ["U3BhbjoxOmFCY0Q="]
    }
  ]
}

Invalid example (span record with start_time after end_time)

{
  "record_sources": [
    {
      "record_type": "span",
      "project_id": "TW9kZWw6MTIzOmFCY0Q=",
      "start_time": "2026-01-20T00:00:00Z",
      "end_time": "2026-01-15T00:00:00Z",
      "span_ids": ["U3BhbjoxOmFCY0Q="]
    }
  ]
}

If no example_ids are provided for a dataset record source, all examples in the dataset will be added to the queue.

This endpoint is in beta, read more here.

POST

annotation-queues

{annotation_queue_id}

records

Create annotation queue records

curl --request POST \
  --url https://api.arize.com/v2/annotation-queues/{annotation_queue_id}/records \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "record_sources": [
    {
      "record_type": "span",
      "project_id": "proj_abc123",
      "start_time": "2024-01-15T00:00:00Z",
      "end_time": "2024-01-15T23:59:59Z",
      "span_ids": [
        "span_abc123",
        "span_def456"
      ]
    }
  ]
}
'

{
  "record_sources": [
    {
      "id": "aqr_001",
      "annotation_queue_id": "aq_abc123",
      "source_type": "spans",
      "data": {
        "input": "What is the capital of France?",
        "output": "Paris"
      },
      "annotations": [],
      "evaluations": [],
      "assigned_users": [
        {
          "user": {
            "id": "usr_123",
            "email": "reviewer@example.com"
          },
          "completion_status": "pending"
        }
      ]
    },
    {
      "id": "aqr_002",
      "annotation_queue_id": "aq_abc123",
      "source_type": "dataset",
      "data": {
        "input": "Summarize this article in one sentence.",
        "output": "The article discusses climate change impacts."
      },
      "annotations": [],
      "evaluations": [],
      "assigned_users": [
        {
          "user": {
            "id": "usr_123",
            "email": "reviewer@example.com"
          },
          "completion_status": "pending"
        }
      ]
    }
  ]
}

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 records to add to an annotation queue

record_sources

object[]

required

Record sources to add to the annotation queue. At most 2 record sources (projects or datasets) may be provided in a single request.

Required array length: 1 - 2 elements

Option 1
Option 2

Show child attributes

Response

Returns the created annotation queue records

record_sources

object[]

required

The created annotation queue records

Show child attributes

List annotation queue records Delete annotation queue records

⌘I