Sign in
Annotations

Update API annotation

Updates an API-created annotation while retaining its Latitude-generated identifier. Omitted fields keep their current values.

patch/v1/projects/{projectSlug}/annotations/{annotationId}

Path parameters

projectSlugstring required

Project slug (human-readable identifier)

Project slug (human-readable identifier). The CLI can also read this from the LATITUDE_PROJECT_SLUG environment variable.

annotationIdstring required

Latitude-generated annotation identifier returned when the annotation was created.

Latitude-generated annotation identifier returned when the annotation was created.

Request body

valuenumber

New normalized score value in [0, 1].

passedboolean

New pass or fail verdict.

feedbackstring

New free-text feedback explaining the score.

Response

Updated annotation

idstring required

Stable annotation identifier.

organizationIdstring required

Organization that owns this annotation.

projectIdstring required

Project this annotation lives in.

sessionIdstring nullable required

Session id lifted from the annotated trace. null when the trace has no session.

traceIdstring nullable required

Identifier of the annotated trace.

spanIdstring nullable required

Span the annotation pins to. Defaults to the trace's last LLM-completion span.

simulationIdstring nullable required

Simulation reference, if any.

signalIdstring nullable required

Signal this annotation contributes to, if any.

valuenumber required

Normalized score value in [0, 1]. Higher = better.

passedboolean required

Whether the annotation marks the output as passing.

feedbackstring required

Free-text feedback explaining the score.

errorstring nullable required

Generation error text, when the annotation itself errored. null for successful annotations.

erroredboolean required

true when the annotation could not be generated successfully.

durationinteger required

Generation duration in nanoseconds. 0 for human annotations.

tokensinteger required

Total LLM tokens consumed generating the score. 0 for human annotations.

costinteger required

Total LLM cost in microcents (100,000,000 per USD). 0 for human annotations.

draftedAtstring date-time nullable required

ISO-8601 timestamp at which the annotation was drafted. null for published annotations.

annotatorIdstring nullable required

User who authored the annotation. null when not attributed to a user.

createdAtstring date-time required

ISO-8601 timestamp at which the annotation was created.

updatedAtstring date-time required

ISO-8601 timestamp of the last metadata update.

source'annotation' required

Always "annotation" for this shape.

Changes

Changed in 1 of the 82 revisions of this API.1