Batch Annotate Queue Items | Confident AI Docs

curl -X POST https://api.confident-ai.com/v1/annotation-queues/name/batch-annotate \
     -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
     -H "Content-Type: application/json" \
     -d '{
  "items": [
    {
      "queueItemId": "queue-item-uuid-1",
      "explanation": "Matches the expected answer",
      "formResponses": [
        {
          "label": "Clarity",
          "value": "Very clear"
        },
        {
          "label": "Overall",
          "value": 10
        }
      ],
      "name": "Correctness",
      "rating": 1,
      "type": "THUMBS_RATING"
    },
    {
      "queueItemId": "queue-item-uuid-2",
      "name": "Correctness",
      "rating": 0,
      "type": "THUMBS_RATING"
    }
  ],
  "annotatorEmail": "annotator@yourcompany.com",
  "markAsCompleted": true
}'

{
  "success": true,
  "data": {
    "results": [
      {
        "queueItemId": "queue-item-uuid-1",
        "success": true,
        "id": "annotation-uuid-1",
        "annotationIds": [
          "annotation-uuid-1"
        ],
        "formResponseIds": [
          "form-response-uuid-1",
          "form-response-uuid-2"
        ]
      },
      {
        "queueItemId": "queue-item-uuid-2",
        "success": false,
        "error": "No matching criterion for annotation 'Correctness' (THUMBS_RATING). Valid criteria: ..."
      }
    ]
  }
}

Annotates many items in a queue in one request. Each entry in items carries a queueItemId plus the same body as the single-item annotate endpoint.

annotatorEmail and markAsCompleted set at the top level act as defaults applied to any item that omits them; a per-item value takes precedence.

Path parameters

namestringRequired

The name of the annotation queue whose items are being annotated.

Request

This endpoint expects an object.

itemslist of objectsRequired

The items to annotate. Processed independently (best-effort).

annotatorEmailstringOptionalformat: "email"

Default annotator for items that omit it. A per-item annotatorEmail takes precedence. Required (here or per item) whenever an item submits formResponses.

markAsCompletedbooleanOptional

Default completion flag for items that omit it (effectively true). A per-item value takes precedence.

Response

Batch processed; inspect each result’s success flag

successboolean

Indicates the batch request was well-formed and processed. Per-item outcomes are in data.results.

dataobject

Path parameters

Headers

Request

Response