Create annotation

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

POST /v1/o11y/llm/annotation

O11y → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/o11y/llm/annotation`
Method	`POST`
Operation	`CreateLLMAnnotation`
Auth	`Authorization: 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).

Field	In	Type	Required	Description
`content`	body	string	—	Content is the note itself.
`observationId`	body	string	—	ObservationID is the single observation the annotation attaches to, when narrowed to one.
`queue`	body	string	—	Queue is the review queue to file the annotation in.
`status`	body	string	—	Status is the annotation's initial review status.
`traceId`	body	string	—	TraceID is the trace the annotation attaches to.

Response

Status	Body	Meaning
`201`	o11y.O11yLLMAnnotationOut	created
`202`	Approval	held for approval
`default`	problem-details	refused

201 body — 11 fields.

Field	In	Type	Always	Description
`data`	body	o11y.O11yLLMAnnotation	—
`data.author`	body	string	—	Author is who wrote it.
`data.content`	body	string	—	Content is the note itself.
`data.createdAt`	body	string (date-time)	—	CreatedAt is when the annotation was stored.
`data.id`	body	string	—	ID is the annotation's id.
`data.observationId`	body	string	—	ObservationID is the observation the annotation attaches to, when narrowed.
`data.queue`	body	string	—	Queue is the review queue the annotation sits in, when queued.
`data.status`	body	string	—	Status is the annotation's review status, e.g. PENDING.
`data.traceId`	body	string	—	TraceID is the trace the annotation attaches to.
`data.updatedAt`	body	string (date-time)	—	UpdatedAt is when the annotation last changed.
`status`	body	string	—	Status is "success".

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo o11y llm annotation create

.ts

.py

.go

.rs

.java

import { Configuration, O11yApi } from 'hanzoai';

const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.createLLMAnnotation({ content: "<content>", observationId: "<observationId>" });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import O11yApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = O11yApi(client).create_llm_annotation(content="<content>", observation_id="<observationId>")

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.O11yAPI.CreateLLMAnnotation(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, o11y_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = o11y_api::create_llm_annotation(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.O11yApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new O11yApi(client).createLLMAnnotation();

curl -X POST https://api.hanzo.ai/v1/o11y/llm/annotation \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "content": "<content>",
       "observationId": "<observationId>"
     }'

Tool o11y, op CreateLLMAnnotation — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "o11y",
         "arguments": {
           "op": "CreateLLMAnnotation",
           "input": {
             "content": "<content>",
             "observationId": "<observationId>"
           }
         }
       }
     }'

O11y API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousCreate limits NextCreate scores