v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

LLM Observability

Create or update annotations

Create or update annotations on interactions in a queue. Each annotation is matched by interaction_id and the requesting user's identity. Results and errors in the response are linked to request items by interaction_id. Errors for individual items are returned in the errors field without blocking the rest of the batch.

post/api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotations

Path parameters

queue_idstring required

The ID of the LLM Observability annotation queue.

Request body

Example request

{
  "data": {
    "attributes": {
      "annotations": [
        {
          "interaction_id": "00000000-0000-0000-0000-000000000001",
          "label_values": [
            {
              "label_schema_id": "abc-123",
              "value": "good"
            },
            {
              "label_schema_id": "ef56gh78",
              "value": "positive"
            }
          ]
        }
      ]
    },
    "type": "annotations"
  }
}

Response

OK — annotations created or updated. Per-item errors are listed in errors.

Example response

{
  "data": {
    "attributes": {
      "annotations": [
        {
          "created_at": "2024-01-15T10:30:00Z",
          "created_by": "00000000-0000-0000-0000-000000000002",
          "id": "annotation-789",
          "interaction_id": "interaction-456",
          "label_values": [
            {
              "label_schema_id": "abc-123",
              "value": "good"
            }
          ],
          "modified_at": "2024-01-15T10:30:00Z",
          "modified_by": "00000000-0000-0000-0000-000000000002"
        }
      ],
      "errors": [
        {
          "annotation_id": "00000000-0000-0000-0000-000000000000",
          "error": "interaction not found",
          "interaction_id": "00000000-0000-0000-0000-000000000001"
        }
      ]
    },
    "id": "00000000-0000-0000-0000-000000000001",
    "type": "annotations"
  }
}