Get Annotation

GEThttps://api.confident-ai.com/v1/annotations/{annotationId}

Retrieves a specific annotation by its unique ID. Returns the complete annotation details including rating, type, expected output/outcome, explanation, and associated trace/span/thread identifiers.

This endpoint verifies that the annotation belongs to your project before returning it.

GET/v1/annotations/{annotationId}

curl -X GET "https://api.confident-ai.com/v1/annotations/{annotationId}" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "annotation": {
      "id": "annotation-uuid",
      "rating": 1,
      "type": "THUMBS_RATING",
      "name": "Quality Check",
      "expectedOutput": "Provide clear password reset instructions",
      "explanation": "Response correctly guides user through password reset",
      "createdAt": "2025-11-12T10:30:00Z",
      "traceUuid": "trace-uuid-1",
      "user": {
        "id": "user-uuid-1",
        "email": "user1@example.com",
        "name": "User One",
        "image": "https://example.com/user1.png"
      }
    }
  }
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

annotationIdstringRequired
The ID of the annotation to retrieve.

Response

Successfully retrieved annotation

successboolean
Indicates if the request was successful.
dataobject
Contains the annotation information.
Show 1 propertyHide 1 property
- annotationobject
  The annotation details.
  Show 14 propertiesHide 14 properties
  - idstring
    This is the id of the annotation generated by Confident AI, not to be confused with the alias you supplied or version number.
  - ratinginteger
    This is the annotated rating score.
  - typeenum
    This is the type of annotation, which can be either thumbs rating or five star rating.
    Show 2 enum valuesHide 2 enum values
    THUMBS_RATING
    FIVE_STAR_RATING
  - namestring
    The name of the annotation.
  - expectedOutcomestring
    This is the annotated expected outcome, for conversation annotations.
  - expectedOutputstring
    This is the annotated expected output, for span and trace annotations.
  - explanationstring
    This is the explanation for the annotation.
  - createdAtstring
    The timestamp when the annotation was created.
  - traceUuidstring
    The UUID of the trace associated with this annotation, if applicable.
  - spanUuidstring
    The UUID of the span associated with this annotation, if applicable.
  - threadIdstring
    The ID of the thread associated with this annotation, if applicable.
  - testCaseIdstring
    The ID of the test case associated with this annotation, if applicable.
  - userobject
    The user who created this annotation.
    Show 4 propertiesHide 4 properties
    idstring
    The id of the user.
    emailstring
    The email address of the user.
    namestring
    The name of the user.
    imagestring
    The image of the user.
  - userEmailstring
    The email address of the user created this annotation. The field is being deprecated. Please use user.email instead.

Built byConfident AI