Skip to main content
POST
/
v2
/
datasets
/
{dataset_id}
/
examples
/
annotate
Annotate a batch of dataset examples
curl --request POST \
  --url https://api.arize.com/v2/datasets/{dataset_id}/examples/annotate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "annotations": [
    {
      "record_id": "ex_abc",
      "values": [
        {
          "name": "quality",
          "score": 0.8
        }
      ]
    }
  ]
}
'
{
  "results": [
    {
      "record_id": "ex_abc",
      "annotations": [
        {
          "name": "quality",
          "score": 0.8,
          "annotator": {
            "id": "usr_123",
            "email": "reviewer@example.com"
          },
          "updated_at": "2024-01-08T10:00: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

dataset_id
string
required

The unique identifier of the dataset A universally unique identifier

Example:

"RW50aXR5OjEyMzQ1"

Body

application/json

Body containing dataset example annotation batch

Batch annotation request for dataset examples.

annotations
object[]
required

Batch of dataset example annotations to write. Up to 500 examples per request.

Required array length: 1 - 500 elements

Response

Annotations successfully written to dataset examples

Result of a batch annotation operation. Contains one result entry per annotated record.

results
object[]
required

Per-record annotation results, in the same order as the request.