COconfident-ai
Annotations

List Annotations

Changed on

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.

get/v1/annotations

Request

Query parameters

traceUuidstring

Filter annotations by trace UUID.

spanUuidstring

Filter annotations by span UUID.

threadIdstring

Filter annotations by thread ID.

type'THUMBS_RATING' | 'FIVE_STAR_RATING'

Filter annotations by type.

minRatingstring

Filter annotations with minimum rating (inclusive).

maxRatingstring

Filter annotations with maximum rating (inclusive).

pageinteger

This specifies the page number of the annotations to return. Defaulted to 1.

pageSizeinteger

This specifies the maximum number of annotations per page. Defaulted to 25.

startstring date-time

This filters for annotations created after the specified start datetime. Defaulted to 30 days ago.

endstring date-time

This filters for annotations created before the specified end datetime. Defaulted to the current time.

sortBy'createdAt'

This determines the field to sort by. Defaulted to createdAt.

ascending'true' | 'false'

This determines if the field specified in sortBy should be in ascending order. Defaults to false.

Headers

CONFIDENT_API_KEYstring required

The API key of your Confident AI project.

Response

Successfully retrieved list of annotations

successboolean required

Indicates if the request was successful.

Changes

  • 75ac46e3e464Revision changes
    • info

      added the required property //////// to the response with the status

    • info

      added the required property //////// to the response with the status

  • 0b1be348f19fRevision changes
    • breaking

      the response property /// became nullable for the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      response property data/annotations/items/userEmail deprecated

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status