Skip to main content

Enqueue an item for annotation

POST 
/api/v1/evals/enqueue-for-annotation

Adds a trace, observation or session to a review queue.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Review and score turns

Request​

Responses​

OK

Schema-valid request illustration; replace example identifiers and confirm operation prerequisites.​

Section ID: DOC-IS-evaluation-api-enqueueForAnnotation#example-evals-enqueueForAnnotation-request

Request example

{
  "queueId": "example_123",
  "targetType": "EVAL_TARGET_TYPE_TRACE",
  "targetId": "example_123"
}

Guide request for 2. Queue what needs reviewing. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-IS-evaluation-api-enqueueForAnnotation#example-cookbook-insights-evaluation-review-03-request

Request example

{
  "queueId": "q_weekly",
  "targetType": "EVAL_TARGET_TYPE_TRACE",
  "targetId": "trc_a1b2c3"
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.​

Section ID: DOC-IS-evaluation-api-enqueueForAnnotation#example-evals-enqueueForAnnotation-response

Response example

{
  "queueItemId": "example_123"
}

Document ID: DOC-IS-evaluation-api-enqueueForAnnotation. Section identities and revisions.

SectionStable reference
Enqueue an item for annotationDOC-IS-evaluation-api-enqueueForAnnotation#overview
RequestDOC-IS-evaluation-api-enqueueForAnnotation#request
ResponsesDOC-IS-evaluation-api-enqueueForAnnotation#responses