v2

latestOpenAPI 3.0.3Apache-2.02026-08-07119359591.9 KB
Annotation Queues

Create annotation queue records

Add new records from spans, traces, or dataset examples to an existing annotation queue.

Payload Requirements

  • At least one record source is required.
  • At most 2 record sources are allowed per request
  • For span record source: start_time must be before end_time, and the range must not exceed 7 days.
  • For dataset record source: all example_ids must be non-empty strings.
  • For project record source:
    • span records: all span_ids must be non-empty strings.
    • trace records: all trace_ids must be non-empty strings.
  • At most 500 records total may be added in one request

Valid example (span record)

{
  "record_sources": [
    {
      "record_type": "SPAN",
      "project_id": "TW9kZWw6MTIzOmFCY0Q=",
      "start_time": "2026-01-15T00:00:00Z",
      "end_time": "2026-01-16T00:00:00Z",
      "span_ids": ["U3BhbjoxOmFCY0Q="]
    }
  ]
}

Valid example (trace record)

{
  "record_sources": [
    {
      "record_type": "TRACE",
      "project_id": "TW9kZWw6MTIzOmFCY0Q=",
      "start_time": "2026-01-15T00:00:00Z",
      "end_time": "2026-01-16T00:00:00Z",
      "trace_ids": ["8fe3373f-0da4-4a8e-b57f-5c8878cfb747"]
    }
  ]
}

Invalid example (span record with start_time after end_time)

{
  "record_sources": [
    {
      "record_type": "SPAN",
      "project_id": "TW9kZWw6MTIzOmFCY0Q=",
      "start_time": "2026-01-20T00:00:00Z",
      "end_time": "2026-01-15T00:00:00Z",
      "span_ids": ["U3BhbjoxOmFCY0Q="]
    }
  ]
}

<Note>If no example_ids are provided for a dataset record source, all examples in the dataset will be added to the queue only when the total records from all sources does not exceed 500.</Note>

<Note>This endpoint is in beta, read more here.</Note>

post/v2/annotation-queues/{annotation_queue_id}/records

Path parameters

annotation_queue_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique annotation queue identifier (base64)

Request body

Response

Returns the created annotation queue records

Example response

{
  "record_sources": [
    {
      "annotations": [
        {
          "annotator": {
            "email": "user@example.com"
          }
        }
      ],
      "trace_annotations": [
        {
          "annotator": {
            "email": "user@example.com"
          }
        }
      ],
      "assigned_users": [
        {
          "user": {
            "email": "user@example.com"
          }
        }
      ]
    }
  ]
}