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, and explanations.
Use query parameters to filter annotations by trace UUID, span UUID, thread ID, type, or rating range. Results are returned in descending order by creation date with pagination support.
Query parameters
Filter annotations by trace UUID.
Filter annotations by span UUID.
Filter annotations by thread ID.
Filter annotations by type.
Filter annotations with minimum rating (inclusive).
Filter annotations with maximum rating (inclusive).
This specifies the page number of the annotations to return. Defaulted to 1.
This specifies the maximum number of annotations per page. Defaulted to 25.
This filters for annotations created after the specified start datetime. Defaulted to 30 days ago.
This filters for annotations created before the specified end datetime. Defaulted to the current time.
This determines the field to sort by. Defaulted to createdAt.
This determines if the field specified in sortBy should be in ascending order. Defaults to false.
Headers
The API key of your Confident AI project.
Response
Successfully retrieved list of annotations
Changes
Changed in 3 of the 54 revisions of this API.58
- ○
added the required property
////////to the response with the statusresponse-required-property-added
- ○
added the required property
////////to the response with the statusresponse-required-property-added
- ○
- ▲
the response property
///became nullable for the statusresponse-property-became-nullable
- ▲
removed the required property
/from the response with the statusresponse-required-property-removed
- ▲
removed the required property
/from the response with the statusresponse-required-property-removed
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
response property
data/annotations/items/userEmaildeprecatedresponse-property-deprecated
- ○
added the required property
/to the response with the statusresponse-required-property-added
- ○
added the required property
/to the response with the statusresponse-required-property-added
- ▲
- ▲
removed the enum value
ascfrom thequeryrequest parameterascendingrequest-parameter-enum-value-removed
- ▲
removed the enum value
descfrom thequeryrequest parameterascendingrequest-parameter-enum-value-removed
- ○
added the new enum value
falseto thequeryrequest parameterascendingrequest-parameter-enum-value-added
- ○
added the new enum value
trueto thequeryrequest parameterascendingrequest-parameter-enum-value-added
- ▲
Of the 54 revisions, 3 have no diff computed.