Hanzo
OpenapiO11y

Adds a human annotation to a trace or observation, optionally in a review queue.

Adds a human annotation to a trace or observation, optionally in a review queue.

POST /v1/o11y/llm/annotation

Addresshttps://api.hanzo.ai/v1/o11y/llm/annotation
MethodPOST
OperationCreateLLMAnnotation
AuthAuthorization: Bearer $HANZO_API_KEY

Adds a human annotation to a trace or observation, optionally in a review queue.

Callers need the editor role; the runtime's own gate enforces it, and it validates the payload and stamps the annotation's author and org.

Request

5 fields, body application/json (required).

FieldInTypeRequiredDescription
contentbodystringContent is the note itself.
observationIdbodystringObservationID is the single observation the annotation attaches to, when narrowed to one.
queuebodystringQueue is the review queue to file the annotation in.
statusbodystringStatus is the annotation's initial review status.
traceIdbodystringTraceID is the trace the annotation attaches to.

Response

StatusBodyMeaning
201o11y.O11yLLMAnnotationOutcreated

201 body — 11 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yLLMAnnotation
data.authorbodystringAuthor is who wrote it.
data.contentbodystringContent is the note itself.
data.createdAtbodystring (date-time)CreatedAt is when the annotation was stored.
data.idbodystringID is the annotation's id.
data.observationIdbodystringObservationID is the observation the annotation attaches to, when narrowed.
data.queuebodystringQueue is the review queue the annotation sits in, when queued.
data.statusbodystringStatus is the annotation's review status, e.g.
data.traceIdbodystringTraceID is the trace the annotation attaches to.
data.updatedAtbodystring (date-time)UpdatedAt is when the annotation last changed.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y llm annotation create

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page