Skip to main content
POST
/
v2
/
annotation-queues
/
{annotation_queue_id}
/
records
/
{annotation_queue_record_id}
/
annotate
Annotate a record
curl --request POST \
  --url https://api.arize.com/v2/annotation-queues/{annotation_queue_id}/records/{annotation_queue_record_id}/annotate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "annotations": [
    {
      "name": "accuracy",
      "score": 0.95
    }
  ]
}
'
{
  "id": "aqr_001",
  "annotation_queue_id": "aq_abc123",
  "source_type": "spans",
  "annotations": [
    {
      "name": "accuracy",
      "label": "correct",
      "score": 1,
      "annotator": {
        "id": "usr_123",
        "email": "reviewer@example.com"
      }
    }
  ]
}

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"

​
annotation_queue_record_id
string
required

The unique annotation queue record identifier (base64) A universally unique identifier (base64-encoded opaque string).

Example:

"RW50aXR5OjEyMzQ1"

Body

application/json

Body containing annotations to submit for an annotation queue record

Annotations to submit for an annotation queue record. Annotations are upserted by annotation config name; omitted configs are left unchanged.

​
annotations
object[]
required

Annotations to upsert on this record, keyed by annotation config name. There is no maximum limit — you may submit one annotation per annotation config associated with the queue.

Minimum array length: 1

Response

Returns a snapshot of the record fields updated by the annotate operation. Only the submitted annotations are included. Evaluations and user assignments are omitted; use the list records endpoint for the full record state.

A snapshot of the annotation queue record fields that were modified by an annotate operation. Only the record identity fields and the submitted annotations are returned. Evaluations and user assignments are not fetched and are not included in this response for performance reasons; use the list records endpoint to retrieve the full record state.

​
id
string
required

The unique identifier for the record

​
annotation_queue_id
string
required

The annotation queue this record belongs to

​
source_type
enum<string>
required

Source type of the annotation queue record.

  • spans - The record originates from span data.
  • dataset - The record originates from a dataset example.
Available options:
spans,
dataset
​
annotations
object[]
required

The annotations that were submitted in this request