Create note

Records an internal remark, stamped with who wrote it.

POST /v1/patrol/note

Patrol → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/patrol/note`
Method	`POST`
Operation	`post_patrol_note`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Records an internal remark, stamped with who wrote it.

Request

2 fields, body application/json (required).

Field	In	Type	Required	Description
`body`	body	string	—	Body is the remark.
`subject`	body	string	—	Subject is what the note is about.

Response

Status	Body	Meaning
`201`	patrol.patrolNoteOut	created
`default`	problem-details	refused

201 body — 6 fields.

Field	In	Type	Always	Description
`data`	body	patrol.patrolNote	—
`data.actor`	body	string	—	Actor is who wrote it.
`data.at`	body	string	—	At is when it was written.
`data.body`	body	string	—	Body is the remark.
`data.name`	body	string	—	Name is the note's document name.
`data.subject`	body	string	—	Subject is what the note is about.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo patrol note create

.ts

.py

.go

.rs

.java

import { Configuration, PatrolApi } from 'hanzoai';

const api = new PatrolApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postPatrolNote({ body: "<body>", subject: "<subject>" });

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = PatrolApi(client).post_patrol_note(body="<body>", subject="<subject>")

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

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

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

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

let result = patrol_api::post_patrol_note(&cfg, Default::default()).await?;

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

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

var result = new PatrolApi(client).postPatrolNote();

curl -X POST https://api.hanzo.ai/v1/patrol/note \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "body": "<body>",
       "subject": "<subject>"
     }'

MCP reaches patrol through the patrol tool, which names its 26 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": "get_patrol_camera"
         }
       }
     }'

Patrol API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousCreate move NextCreate confirm