Update Annotation

Updates an existing annotation’s properties such as rating, type, expected output/outcome, explanation, or flagged status.

Validation rules:

Thread annotations cannot have expectedOutput (use expectedOutcome instead)
Trace/span annotations cannot have expectedOutcome (use expectedOutput instead)
The annotation must belong to your project

Updates an existing annotation's properties such as rating, type, expected output/outcome, explanation, or flagged status. **Validation rules:** - Thread annotations cannot have `expectedOutput` (use `expectedOutcome` instead) - Trace/span annotations cannot have `expectedOutcome` (use `expectedOutput` instead) - The annotation must belong to your project

Path parameters

annotationIdstringRequired

The ID of the annotation to update.

Request

This endpoint expects an object.

ratingdoubleOptional

Updated rating score. Must be 0 or 1 for THUMBS_RATING, 1-5 for FIVE_STAR_RATING.

typeenumOptional

Updated annotation type.

Allowed values:

expectedOutputstringOptional

Updated expected output for trace/span annotations.

expectedOutcomestringOptional

Updated expected outcome for thread annotations.

explanationstringOptional

Updated explanation for the annotation.

flaggedbooleanOptional

Updated flagged status.

Response

Successfully updated annotation

successboolean

This is true if the annotation was successfully updated.

dataobject

This maps to the id of the updated annotation.

deprecatedboolean

This is true if this endpoint is deprecated.

1	import requests
2
3	url = "https://api.confident-ai.com/v1/annotations/annotationId"
4
5	payload = {
6	"rating": 5,
7	"type": "FIVE_STAR_RATING",
8	"expectedOutput": "Provide detailed password reset steps with security considerations",
9	"explanation": "Updated: Response now includes security best practices",
10	"flagged": False
11	}
12	headers = {
13	"CONFIDENT_API_KEY": "<PROJECT-API-KEY>",
14	"Content-Type": "application/json"
15	}
16
17	response = requests.put(url, json=payload, headers=headers)
18
19	print(response.json())

1	{
2	"success": true,
3	"data": {
4	"id": "ANNOTATION-ID"
5	},
6	"deprecated": false
7	}

Path parameters

Headers

Request

Response

Errors