Sign in
Annotations

Update Annotation

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

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
put/v1/annotations/{annotationId}

Path parameters

annotationIdstring required

The ID of the annotation to update.

Headers

CONFIDENT_API_KEYstring required

The API key of your Confident AI project.

Request body

ratingnumber

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

type'THUMBS_RATING' | 'FIVE_STAR_RATING'

Updated annotation type.

expectedOutputstring

Updated expected output for trace/span annotations.

expectedOutcomestring

Updated expected outcome for thread annotations.

explanationstring

Updated explanation for the annotation.

Response

Successfully updated annotation

successboolean required

This is true if the annotation was successfully updated.

deprecatedboolean required

This is true if this endpoint is deprecated.

Changes

No changes recorded. 3 of the 54 revisions have no diff computed, so they could not be searched.