All pages
Powered by GitBook
1 of 1

Loading...

Annotations

Get span annotations for a list of span_ids.

get
Path parameters
project_identifierstringRequired

The project identifier: either project ID or project name. If using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

Query parameters
span_idsstring[] · min: 1Required

One or more span id to fetch annotations for

include_annotation_namesany ofOptional

Optional list of annotation names to include. If provided, only annotations with these names will be returned. 'note' annotations are excluded by default unless explicitly included in this list.

string[]Optional
or
nullOptional
exclude_annotation_namesany ofOptional

Optional list of annotation names to exclude from results.

string[]Optional
or
nullOptional
cursorany ofOptional

A cursor for pagination

stringOptional
or
nullOptional
limitinteger · max: 10000Optional

The maximum number of annotations to return in a single request

Default: 10
Responses
200
Successful Response
application/json
403
Forbidden
text/plain
404
Project or spans not found
text/plain
422
Invalid parameters
text/plain
get
GET /v1/projects/{project_identifier}/span_annotations?span_ids=text HTTP/1.1
Host: 
Accept: */*
{
  "data": [
    {
      "span_id": "text",
      "name": "text",
      "annotator_kind": "LLM",
      "result": {
        "label": "text",
        "score": 1,
        "explanation": "text"
      },
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "identifier": "",
      "id": "text",
      "created_at": "2025-07-01T20:43:02.241Z",
      "updated_at": "2025-07-01T20:43:02.241Z",
      "source": "API",
      "user_id": "text"
    }
  ],
  "next_cursor": "text"
}