Skip to main content
GET
Get annotation by ID

Authorizations

Authorization
string
header
required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Path Parameters

id
string
required

Annotation ID.

Minimum string length: 1
Example:

"annotation_123"

Response

Annotation retrieved successfully

id
string
required
Example:

"annotation_123"

sessionId
string
required

The annotated session.

Example:

"session_123"

metricId
string
required

Metric ID, shared by every revision of the metric. A revision ID answers 404.

Example:

"metric_123"

inferenceResultId
string | null
required

The annotated turn of the session. Null for an annotation of the whole session.

Example:

"inferenceResult_123"

annotatorId
string | null
required

The user who last wrote the score. Null once that user is deleted.

Example:

"user_123"

score
number
required

The human score, from 0 to 1.

Example:

0.75

reason
string | null
required

Why the annotator gave this score.

Example:

"Accurate"

createdAt
string<date-time>
required
updatedAt
string<date-time>
required