Update reviews

Changes a review queue's name, description or score-config set.

PATCH /v1/o11y/reviews/{id}

O11y → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/o11y/reviews/{id}`
Method	`PATCH`
Operation	`patch_o11y_reviews_by_id`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Changes a review queue's name, description or score-config set. A field the request omits is left alone. A name another queue in the same project already uses is a 409; a queue id belonging to another org is a 404.

Request

5 fields, body application/json (required).

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the annotation queue to update, from the path.
`description`	body	string	—	Description replaces the free text when present, up to 512 characters.
`id`	body	string	—	ID is the annotation queue to update, from the path.
`name`	body	string	—	Name replaces the queue's display handle when present, 1–128 printable characters and unique within the project.
`scoreConfigIds`	body	string[]	—	ScoreConfigIDs replaces the whole score-config set when present.

Response

Status	Body	Meaning
`200`	o11y.annQueueView	ok
`202`	Approval	held for approval
`default`	problem-details	refused

200 body — 6 fields.

Field	In	Type	Always	Description
`createdAt`	body	string	—	CreatedAt is when it was created, RFC3339 in UTC.
`description`	body	string	—	Description is its free text, omitted when empty.
`id`	body	string	—	ID is the queue's id.
`name`	body	string	—	Name is its display handle.
`scoreConfigIds`	body	string[]	—	ScoreConfigIDs are the eval score-configs reviewers grade against.
`updatedAt`	body	string	—	UpdatedAt is when it last changed, RFC3339 in UTC.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo o11y reviews update <id>

.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.patchO11yReviewsById({ id: 'id', description: "<description>", 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(id='id', description="<description>", id="<id>")

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

resp, _, err := client.O11yAPI.PatchO11yReviewsById(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::patch_o11y_reviews_by_id(&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).patchO11yReviewsById();

curl -X PATCH https://api.hanzo.ai/v1/o11y/reviews/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "description": "<description>",
       "id": "<id>"
     }'

MCP reaches o11y through the o11y tool, which names its 307 operations with its own verbs — this one among them, under a name only MCP 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": "list_o11y_autocomplete_aggregate_attributes"
         }
       }
     }'

O11y API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousUpdate items NextUpdate dashboards