Annotate Single Item | Confident AI Docs

Creates an annotation for a single queue item. This endpoint automatically associates the annotation with the correct trace, span, or thread based on the queue item.

Validation rules:

For thread items: Use expectedOutcome (not expectedOutput)
For trace/span items: Use expectedOutput (not expectedOutcome)
Set markAsCompleted: true to automatically mark the queue item as completed after annotation (default: true)

Creates an annotation for a single queue item. This endpoint automatically associates the annotation with the correct trace, span, or thread based on the queue item. **Validation rules:** - For thread items: Use `expectedOutcome` (not `expectedOutput`) - For trace/span items: Use `expectedOutput` (not `expectedOutcome`) - Set `markAsCompleted: true` to automatically mark the queue item as completed after annotation (default: true)

Path parameters

itemIdstringRequired

The ID of the queue item to annotate.

Request

This endpoint expects an object.

ratingintegerRequired

Rating value (0-1 for THUMBS_RATING, 1-5 for FIVE_STAR_RATING)

typeenumOptionalDefaults to THUMBS_RATING

Type of rating

Allowed values:

namestringOptionalDefaults to Default

Name of the annotation

expectedOutcomestringOptional

Expected outcome (for threads only)

expectedOutputstringOptional

Expected output (for traces/spans only)

explanationstringOptional

Explanation for the rating

flaggedbooleanOptionalDefaults to false

Whether the item is flagged

markAsCompletedbooleanOptionalDefaults to true

Whether to mark the queue item as completed

Response

Successfully created annotation for queue item

successboolean or null

dataobject or null

1	import requests
2
3	url = "https://api.confident-ai.com/v1/annotation-queues/itemId/annotate"
4
5	payload = {
6	"rating": 1,
7	"type": "THUMBS_RATING",
8	"name": "Quality Check",
9	"explanation": "Response is accurate and helpful",
10	"flagged": False,
11	"markAsCompleted": True
12	}
13	headers = {
14	"CONFIDENT_API_KEY": "<PROJECT-API-KEY>",
15	"Content-Type": "application/json"
16	}
17
18	response = requests.post(url, json=payload, headers=headers)
19
20	print(response.json())

1	{
2	"success": true,
3	"data": {
4	"id": "annotation-uuid"
5	}
6	}

Path parameters

Headers

Request

Response