Get Annotation

(v2)

GET

Retrieves an annotation by id from your Confident AI project, with the ids of the trace, span or thread it was left on and the team member who left it.

GET/v2/annotations/{annotationId}

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

200

{
  "success": true,
  "data": {
    "id": "<ANNOTATION-ID>",
    "fieldType": "TEXT",
    "value": true,
    "name": null,
    "explanation": "Correct and concise.",
    "expectedOutcome": null,
    "expectedOutput": "The capital of France is Paris.",
    "createdAt": "2025-01-15T11:00:00.000Z",
    "user": {
      "id": "<USER-ID>",
      "email": "jane@acme.com",
      "name": "Jane Doe",
      "image": null
    },
    "traceUuid": "3f9c2a1e-5b7d-4c8e-9f01-2a3b4c5d6e7f",
    "spanUuid": null,
    "threadId": null,
    "testCaseId": null
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

annotationIdstringRequired
The id of the annotation.

Response

Get Annotation succeeded.

successboolean
Indicates if the request was successful.
dataobject
A human annotation left on a trace, span or thread, with the ids of what it was left on.
Show 13 propertiesHide 13 properties
- idstring
  This is the id of the annotation generated by Confident AI.
- fieldTypeenum
  The kind of value an annotation holds: TEXT, NUMBER, FLOAT or BOOLEAN for a free value, CHOICE or MULTIPLE_CHOICE for a choice from the options in the field's config, and THUMBS_RATING or FIVE_STAR_RATING for a rating.
  Show 8 enum valuesHide 8 enum values
  - TEXT
  - NUMBER
  - FLOAT
  - BOOLEAN
  - CHOICE
  - MULTIPLE_CHOICE
  - FIVE_STAR_RATING
  - THUMBS_RATING
- valuestring | number | boolean | list of strings | null
  The annotated value, in the shape its fieldType expects: a boolean for THUMBS_RATING (true is thumbs up) and BOOLEAN, a whole number from 1 to 5 for FIVE_STAR_RATING, a number for NUMBER or FLOAT, a string for TEXT and CHOICE, and a list of strings for MULTIPLE_CHOICE. Null when the annotation was left without a value.
  Show 5 variantsHide 5 variants
  - string
  - OR
  - number
  - OR
  - boolean
  - OR
  - list of strings
  - OR
  - null
- namestring | null
  The name of the annotation.
- explanationstring | null
  This is the explanation for the annotation.
- expectedOutcomestring | null
  This is the annotated expected outcome, for conversation annotations.
- expectedOutputstring | null
  This is the annotated expected output, for span and trace annotations.
- createdAtstring
  The timestamp when the annotation was created.
- userobject | null
  A Confident AI user, as referenced by the records they created.
  Show 4 propertiesHide 4 properties
  - idstring
    This is the id of the user.
  - emailstring
    This is the email address of the user.
  - namestring | null
    This is the display name of the user, or null when they have not set one.
  - imagestring | null
    This is the URL of the user's avatar, or null when they have none.
- traceUuidstring | null
  The uuid of the trace this annotation was left on, or null when it was left on a span or thread.
- spanUuidstring | null
  The uuid of the span this annotation was left on, or null when it was left on a trace or thread.
- threadIdstring | null
  The id of the thread this annotation was left on. It is also set for an annotation on a trace that belongs to a thread.
- testCaseIdstring | null
  The id of the test case the annotated trace formed, for a trace ingested into a test run.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI