Annotations

List Annotations

Retrieves a paginated list of annotations from your Confident AI project. Annotations are user feedback on traces, spans, or threads that include ratings, expected outputs/outcomes, explanations, and flags.

Use query parameters to filter annotations by trace UUID, span UUID, thread ID, type, rating range, or flagged status. Results are returned in descending order by creation date with pagination support.

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

traceUuidstringOptional
Filter annotations by trace UUID.
spanUuidstringOptional
Filter annotations by span UUID.
threadIdstringOptional
Filter annotations by thread ID.
typeenumOptional
Filter annotations by type.
Allowed values:
minRatingstringOptional

Filter annotations with minimum rating (inclusive).

maxRatingstringOptional

Filter annotations with maximum rating (inclusive).

flaggedenumOptional
Filter annotations by flagged status.
Allowed values:
limitstringOptionalDefaults to 50

Maximum number of annotations to return (default 50).

offsetstringOptionalDefaults to 0

Number of annotations to skip (default 0).

Response

Successfully retrieved list of annotations
successboolean
Indicates if the request was successful.
dataobject