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

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

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 1000 examples per request.

Required array length: 1 - 1000 elements

Response

Annotations written successfully. The annotations have been accepted and will be written. Visibility in read queries may lag by a short interval.