Skip to main content
POST
/
v1
/
document_annotations
Annotate Span Documents
curl --request POST \
  --url https://api.example.com/v1/document_annotations \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": [
    {
      "name": "<string>",
      "annotator_kind": "LLM",
      "span_id": "<string>",
      "document_position": 123,
      "result": {
        "label": "<string>",
        "score": 123,
        "explanation": "<string>"
      },
      "metadata": {},
      "identifier": ""
    }
  ]
}
'
{
  "data": [
    {
      "id": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://arizeai-433a7140-update-phoenix-arize-phoenix-evals-3-1-0.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

​
sync
boolean
default:false

If set to true, the annotations are inserted synchronously.

Body

application/json
​
data
SpanDocumentAnnotationData · object[]
required

Response

Span document annotation inserted successfully

​
data
InsertedSpanDocumentAnnotation · object[]
required