OpenapiO11y
Moves one queue item between PENDING and COMPLETED and sets its assignee.
Moves one queue item between PENDING and COMPLETED and sets its assignee. Completing an item stamps its completedAt.
PATCH /v1/o11y/reviews/{id}/items/{itemId}
| Address | https://api.hanzo.ai/v1/o11y/reviews/{id}/items/{itemId} |
| Method | PATCH |
| Operation | patch_o11y_reviews_by_id_items_by_itemid |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Moves one queue item between PENDING and COMPLETED and sets its assignee. Completing an item stamps its completedAt. An item that exists under a different queue answers the same 404 an unknown item does, and so does a queue belonging to another org.
Request
6 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID is the annotation queue the item belongs to, from the path. |
itemId | path | string | yes | ItemID is the item to update, from the path. |
assignee | body | string | — | Assignee replaces the reviewer this item is for, up to 512 characters. |
id | body | string | — | ID is the annotation queue the item belongs to, from the path. |
itemId | body | string | — | ItemID is the item to update, from the path. |
status | body | string | — | Status is the item's new review state: PENDING or COMPLETED. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | o11y.annItemView | ok |
200 body — 12 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
assignee | body | string | — | Assignee is the reviewer it is for, omitted when unassigned. |
completedAt | body | string | — | CompletedAt is when it was reviewed, omitted while pending. |
createdAt | body | string | — | CreatedAt is when it was enqueued, RFC3339 in UTC. |
id | body | string | — | ID is the item's id. |
objectId | body | string | — | ObjectID is the referenced object's id. |
objectType | body | string | — | ObjectType is what it references: TRACE, OBSERVATION or SESSION. |
observationId | body | string | — | ObservationID echoes objectId when objectType is OBSERVATION. |
queueId | body | string | — | QueueID is the queue it belongs to. |
sessionId | body | string | — | SessionID echoes objectId when objectType is SESSION. |
status | body | string | — | Status is PENDING or COMPLETED. |
traceId | body | string | — | TraceID echoes objectId when objectType is TRACE. |
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 update <id> <itemId>import { Configuration, O11yApi } from 'hanzoai';
const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.patchO11yReviewsByIdItemsByItemid({ id: 'id', itemId: 'itemId', assignee: "<assignee>", id: "<id>" });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).patch_o11y_reviews_by_id_items_by_itemid(id='id', item_id='itemId', assignee="<assignee>", id="<id>")cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.O11yAPI.PatchO11yReviewsByIdItemsByItemid(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::patch_o11y_reviews_by_id_items_by_itemid(&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).patchO11yReviewsByIdItemsByItemid();curl -X PATCH https://api.hanzo.ai/v1/o11y/reviews/<id>/items/<itemId> \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"assignee": "<assignee>",
"id": "<id>"
}'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?