OpenapiO11y
Enqueues traces, observations or sessions on a review queue.
Enqueues traces, observations or sessions on a review queue.
POST /v1/o11y/reviews/{id}/items
| Address | https://api.hanzo.ai/v1/o11y/reviews/{id}/items |
| Method | POST |
| Operation | post_o11y_reviews_by_id_items |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Enqueues traces, observations or sessions on a review queue. Each item names exactly one object, either by traceId / observationId / sessionId or by objectType plus objectId; every item enters PENDING. A queue id belonging to another org is a 404.
Request
9 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID is the annotation queue to add to, from the path. |
id | body | string | — | ID is the annotation queue to add to, from the path. |
items | body | o11y.itemInput[] | — | Items are the objects to enqueue for review, 1–200 per request. |
items[].assignee | body | string | — | Assignee is the reviewer this item is for, up to 512 characters. |
items[].objectId | body | string | — | ObjectID is the referenced object's id, paired with objectType. |
items[].objectType | body | string | — | ObjectType is TRACE, OBSERVATION or SESSION — the generic form, paired with objectId. |
items[].observationId | body | string | — | ObservationID references an observation — the console-friendly form of objectType=OBSERVATION. |
items[].sessionId | body | string | — | SessionID references a session — the console-friendly form of objectType=SESSION. |
items[].traceId | body | string | — | TraceID references a trace — the console-friendly form of objectType=TRACE. |
Response
| Status | Body | Meaning |
|---|---|---|
201 | o11y.annItemsCreated | created |
201 body — 13 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | o11y.annItemView[] | — | Data is every item created by this request, in request order. |
data[].assignee | body | string | — | Assignee is the reviewer it is for, omitted when unassigned. |
data[].completedAt | body | string | — | CompletedAt is when it was reviewed, omitted while pending. |
data[].createdAt | body | string | — | CreatedAt is when it was enqueued, RFC3339 in UTC. |
data[].id | body | string | — | ID is the item's id. |
data[].objectId | body | string | — | ObjectID is the referenced object's id. |
data[].objectType | body | string | — | ObjectType is what it references: TRACE, OBSERVATION or SESSION. |
data[].observationId | body | string | — | ObservationID echoes objectId when objectType is OBSERVATION. |
data[].queueId | body | string | — | QueueID is the queue it belongs to. |
data[].sessionId | body | string | — | SessionID echoes objectId when objectType is SESSION. |
data[].status | body | string | — | Status is PENDING or COMPLETED. |
data[].traceId | body | string | — | TraceID echoes objectId when objectType is TRACE. |
data[].updatedAt | body | string | — | UpdatedAt is when it last changed, RFC3339 in UTC. |
Failure carries the platform error shape — see Errors.
Examples
hanzo o11y reviews items create <id>import { Configuration, O11yApi } from 'hanzoai';
const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postO11yReviewsByIdItems({ id: 'id', id: "<id>", items: [{"assignee":"<assignee>","objectId":"<objectId>","objectType":"<objectType>","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).post_o11y_reviews_by_id_items(id='id', id="<id>", items=[{"assignee":"<assignee>","objectId":"<objectId>","objectType":"<objectType>","observationId":"<observationId>"}])cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.O11yAPI.PostO11yReviewsByIdItems(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::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::post_o11y_reviews_by_id_items(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.O11yApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new O11yApi(client).postO11yReviewsByIdItems();curl -X POST https://api.hanzo.ai/v1/o11y/reviews/<id>/items \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "<id>",
"items": [
{
"assignee": "<assignee>",
"objectId": "<objectId>",
"objectType": "<objectType>",
"observationId": "<observationId>"
}
]
}'The door reaches o11y through the o11y tool, which names its 340 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "get_o11y_alert_last"
}
}
}'How is this guide?