# Hanzo

> The AI operating system for business. Building business software since 2014. Techstars '17.

Every page below is Markdown: a page's address with `.md` appended. How an agent authenticates: [auth.md](https://docs.hanzo.ai/auth.md). Everything in one file: [llms-full.txt](https://docs.hanzo.ai/llms-full.txt).

## For agents

Sign up free with a wallet. Get an API key free. A small free allowance to try it. Top up in USDC or USDT over the API to raise your limits and pay as you go. No human required.

- Wallet sign-up: `GET /v1/iam/web3/nonce?chain=evm&address=<address>` on hanzo.id, sign the message it describes with EIP-191, `POST /v1/iam/web3/verify`, exchange the code with `POST /v1/iam/oauth/token`, then `POST /v1/account/keys` on api.hanzo.ai. A first-seen wallet gets its own account and organization with a small free allowance to try it. The whole flow as one TypeScript file: [Agents: start here](https://docs.hanzo.ai/docs/agents.md).
- [Headless, step by step](https://docs.hanzo.ai/docs/agents/headless.md): each request and its answer: challenge, signature, verify, token, key, limits, a 429, the USDC or USDT deposit and the balance.
- [auth.md](https://docs.hanzo.ai/auth.md): the wallet flow, the device flow, API keys and revocation, with IAM's discovery documents.
- [Agents: start here](https://docs.hanzo.ai/docs/agents.md): a credential, the free tier, the first call, MCP, Kai, rate limits and spend control.
- [The prompt](https://docs.hanzo.ai/docs/agents/prompt.md): one block to hand any agent that builds on Hanzo.
- Key: `hanzo auth login`, then `hanzo account keys create --name agent --type secret`. With an inbox, the four-request email-code sequence on /docs/agents ends in the same key mint.
- Free: a wallet account gets a small free allowance to try it; read it live with `GET /v1/allowance` and `GET /v1/billing/tier` on api.hanzo.ai. A person on the Free plan gets 50 requests a day on `zen-free` and `enso-free`, and 50 Kai decisions a day. No card.
- Limits: a 429 with code `free_plan_cap` means the free allowance is used. Wait for `resets_at`, or raise it: `POST /v1/billing/crypto/deposit`, send to the address it returns, and calls past the allowance draw on the balance (`GET /v1/billing/balance`).
- Pay: plans from $20 a month ([pricing](https://hanzo.ai/pricing)), card, Apple Pay or Google Pay at [hanzo.ai/pay](https://hanzo.ai/pay), or USDC and USDT over the API: `POST /v1/billing/crypto/deposit`.
- Evaluate Kai: `POST /v1/decisions`; the frozen harness is [hanzoai/benchmarks](https://github.com/hanzoai/benchmarks) (`decision/`); published runs: [app.phishing](https://api.hanzo.ai/v1/research/runs?org=hanzo&benchmark=app.phishing).
- Skills: [hanzoskills.com](https://hanzoskills.com)

## Company

- Since 2014: founded as Crowdstart, renamed Hanzo in 2016. First commit 2014-09-29; Go-native since October 2014. First customer SKULLY raised $1M in about 45 hours, the fastest fully funded campaign on Indiegogo.
- AI and machine learning in commercial use since 2014; GPT models by 2019.
- 2017: the first blockchain-native commerce platform; the Unikrn ICO raised over 120,000 ETH. Techstars '17.
- 2020: Damon Motorcycles sold $8.4M of motorcycles in 30 days at a 541:1 return on ad spend, on AI-generated ads.
- Hundreds of venture-funded startups served, funded by Y Combinator, 500 Startups and Techstars; billions in client revenue; two companies past 100 million users; two went public on Nasdaq in 2024, Damon Motorcycles and Triller.
- People: Antje Worring, CEO; Zach Kelling, CTO.
- Talk to us: [cal.com/hanzo](https://cal.com/hanzo), [hanzo.ai/contact](https://hanzo.ai/contact). Investors: ir@hanzo.ai.
- [About Hanzo](https://docs.hanzo.ai/docs/about/company.md); the full history is [hanzo.ai/about](https://hanzo.ai/about).

## Agents — start here, the prompt to hand one, and a campaign run from one

- [Agents: start here](https://docs.hanzo.ai/docs/agents.md): Sign up free with a wallet. Get an API key free. A small free allowance to try it. Top up in USDC or USDT over the API to raise your limits and pay as you go. No human required.
- [Run a campaign from your agent](https://docs.hanzo.ai/docs/agents/campaign.md): Measure the site, write the ads with a model, draft the campaign, hand the launch to its owner, then read the results. One request a step.
- [Headless, step by step](https://docs.hanzo.ai/docs/agents/headless.md): Sign up free with a wallet. Get an API key free. A small free allowance to try it. Top up in USDC or USDT over the API to raise your limits and pay as you go. No human required.
- [Give your agent this prompt](https://docs.hanzo.ai/docs/agents/prompt.md): The standard prompt for an agent that builds on Hanzo. One block carries the sign-up, the key, the allowance, the top-up and the first call.

## API reference — one page per capability, one per operation

- [Capabilities](https://docs.hanzo.ai/docs/openapi.md): Every Hanzo capability — 131 of them, 2481 operations, generated from the OpenAPI document.
- [Account](https://docs.hanzo.ai/docs/openapi/account.md): Your own account: API keys you mint and revoke, and org onboarding.
- [Delete keys](https://docs.hanzo.ai/docs/openapi/account/delete-account-keys-by-id.md): Revokes exactly one API key, by id.
- [List appearance](https://docs.hanzo.ai/docs/openapi/account/get-account-appearance.md): Returns the signed-in caller's own appearance preference — text size, density and accent — read from their IAM account so it is the same on every device and every Hanzo surface.
- [Get avatar](https://docs.hanzo.ai/docs/openapi/account/get-account-avatar-by-org-by-user-by-digest.md): Streams a profile photo's raw BYTES.
- [List csrf](https://docs.hanzo.ai/docs/openapi/account/get-account-csrf.md): Mints the anti-forgery token a browser echoes as X-CSRF-Token on every change it asks for.
- [List embed](https://docs.hanzo.ai/docs/openapi/account/get-account-embed.md): Reports whether one of this brand's shared embedded apps (cms, erp, help) may be framed by the caller and is actually running, so a console module can choose between the embed and the provision panel.
- [List keys](https://docs.hanzo.ai/docs/openapi/account/get-account-keys.md): Returns the API keys the caller may see, newest first: their own, or every key the org holds when the caller administers it.
- [Update keys](https://docs.hanzo.ai/docs/openapi/account/patch-account-keys-by-id.md): Changes one key's name, permissions, budget, rate or expiry.
- [Create appearance](https://docs.hanzo.ai/docs/openapi/account/post-account-appearance.md): Stores the caller's appearance preference on their IAM account, preserving every other field of the row.
- [Create avatar](https://docs.hanzo.ai/docs/openapi/account/post-account-avatar.md): Stores one image as the signed-in user's profile photo and answers the URL it is served from, which is also written to the user's IAM record — so every surface that already renders `avatar` picks it up with no further call.
- [Create keys](https://docs.hanzo.ai/docs/openapi/account/post-account-keys.md): Creates a NEW API key and returns its secret ONCE.
- [Create orgs](https://docs.hanzo.ai/docs/openapi/account/post-account-orgs.md): Creates the caller's organization.
- [Ad](https://docs.hanzo.ai/docs/openapi/ad.md): Your paid ad campaigns, launched and paused from one place.
- [Delete campaigns](https://docs.hanzo.ai/docs/openapi/ad/delete-ad-campaigns-by-id.md): Removes one of the caller org's campaigns and answers 204 with no body.
- [List campaigns](https://docs.hanzo.ai/docs/openapi/ad/get-ad-campaigns.md): Returns the caller org's ad campaigns, most recently updated first, optionally narrowed to one lifecycle status.
- [Get campaigns](https://docs.hanzo.ai/docs/openapi/ad/get-ad-campaigns-by-id.md): Returns one of the caller org's campaigns.
- [List summary](https://docs.hanzo.ai/docs/openapi/ad/get-ad-summary.md): Rolls the caller org's ad campaigns up into four numbers: how many campaigns exist, how many are active, and the summed budget and spend across all of them.
- [Create campaigns](https://docs.hanzo.ai/docs/openapi/ad/post-ad-campaigns.md): Registers a new ad campaign for the caller's org and answers 201 with the stored row.
- [Launch campaigns](https://docs.hanzo.ai/docs/openapi/ad/post-ad-campaigns-by-id-launch.md): Creates the campaign on its platform under the CALLER ORG'S own connected ad account, records the provider campaign id, flips the stored campaign to active and answers the updated record.
- [Replace campaigns](https://docs.hanzo.ai/docs/openapi/ad/put-ad-campaigns-by-id.md): Replaces the user-owned fields of one of the caller org's campaigns and answers the stored row.
- [Admin](https://docs.hanzo.ai/docs/openapi/admin.md): Admin — reached at /v1/admin; not in the public REST contract.
- [Affiliate](https://docs.hanzo.ai/docs/openapi/affiliate.md): A partner program that pays commission on what your referrals spend.
- [List affiliate](https://docs.hanzo.ai/docs/openapi/affiliate/get-affiliate.md): Answers the caller org's OWN affiliate standing: status, referral code and share link, commission rate, how many orgs it has referred, and its lifetime accrued, still-pending and already-paid commission in integer cents, with its payout history.
- [List leaderboard](https://docs.hanzo.ai/docs/openapi/affiliate/get-affiliate-leaderboard.md): Answers the top affiliates by lifetime accrued commission, shown by OPT-IN HANDLE with aggregate figures only, plus the caller's own exact rank.
- [List me](https://docs.hanzo.ai/docs/openapi/affiliate/get-affiliate-me.md): Answers the richer self-view: the same lifetime accrued, pending and paid commission and payout history, plus the caller's downline broken out by upline LEVEL — direct, second, third — each with the rate paid at that level and how many orgs sit there.
- [List earnings](https://docs.hanzo.ai/docs/openapi/affiliate/get-affiliate-me-earnings.md): Answers the caller's own commission ledger: per period, the margin it earned against and the commission taken from that margin; and per referred org, that referral's aggregate contribution.
- [List links](https://docs.hanzo.ai/docs/openapi/affiliate/get-affiliate-me-links.md): Answers the caller's share links, each with its URL and its funnel: clicks tracked, signups — orgs attributed with that code — and conversions, meaning how many of those signups have actually produced commission.
- [Create apply](https://docs.hanzo.ai/docs/openapi/affiliate/post-affiliate-apply.md): Enrolls the caller's OWN org as an affiliate at status `applied`, optionally requesting a vanity code, and answers the record — 201 on the first apply, 200 with `created:false` afterwards.
- [Create attribute](https://docs.hanzo.ai/docs/openapi/affiliate/post-affiliate-attribute.md): Records the first-touch edge every later commission is computed from: the caller's org was referred by the affiliate that owns this code.
- [Create click](https://docs.hanzo.ai/docs/openapi/affiliate/post-affiliate-click.md): Counts a click on a share link.
- [Create handle](https://docs.hanzo.ai/docs/openapi/affiliate/post-affiliate-me-handle.md): Sets the caller's public leaderboard display name, or clears it.
- [Create links](https://docs.hanzo.ai/docs/openapi/affiliate/post-affiliate-me-links.md): Mints a new share link for the caller's own affiliate and answers it with its full URL, 201.
- [Agent](https://docs.hanzo.ai/docs/openapi/agent.md): Autonomous agents for your org: define them, run them, keep every run.
- [Delete agent](https://docs.hanzo.ai/docs/openapi/agent/delete-agent-by-ref.md): Removes an agent and every run recorded against it.
- [Delete shares — DELETE /v1/agent/chat/conversations/{id}/shares/{share}](https://docs.hanzo.ai/docs/openapi/agent/delete-agent-chat-conversations-by-id-shares-by-share.md): Ends one share of a conversation the caller owns, for every viewer: it leaves their lists, and its token opens nothing and reads exactly like a token that never existed.
- [Delete viewers](https://docs.hanzo.ai/docs/openapi/agent/delete-agent-chat-conversations-by-id-shares-by-share-viewers-by-viewer.md): Closes one share of a conversation the caller owns to one viewer: it leaves their list, and the token no longer opens it for them.
- [Delete shares — DELETE /v1/agent/chat/shares/{share}](https://docs.hanzo.ai/docs/openapi/agent/delete-agent-chat-shares-by-share.md): For an admin of the caller's organization: ends one share made in it, for every viewer, exactly as its owner's revoke does.
- [Delete targets](https://docs.hanzo.ai/docs/openapi/agent/delete-agent-targets-by-id.md): Deregisters one machine.
- [List agent](https://docs.hanzo.ai/docs/openapi/agent/get-agent.md): Returns every agent defined in the caller's org, each with the number of runs recorded against it.
- [List activity](https://docs.hanzo.ai/docs/openapi/agent/get-agent-activity.md): Serves the org-wide recent-activity feed.
- [List builds](https://docs.hanzo.ai/docs/openapi/agent/get-agent-builds.md): Returns the public index of every published build, most recently updated first, so a gallery can link straight to the story behind each product.
- [Get builds](https://docs.hanzo.ai/docs/openapi/agent/get-agent-builds-by-org-by-project.md): Returns the readable build of one product: the agent session that produced it, turn by turn — the prompts, the reasoning, the commits each turn produced — plus the exact `git log` that re-derives every commit binding from git itself, so nothing here has to be taken on trust.
- [Get agent](https://docs.hanzo.ai/docs/openapi/agent/get-agent-by-ref.md): Returns one agent with its system prompt and its 20 most recent runs.
- [List runs — GET /v1/agent/{ref}/runs](https://docs.hanzo.ai/docs/openapi/agent/get-agent-by-ref-runs.md): Returns one agent's execution history, newest first — each run's input, its output or its error, and how long it took.
- [List spend](https://docs.hanzo.ai/docs/openapi/agent/get-agent-by-ref-spend.md): Answers what one of your org's agents has spent, in integer micro-USD.
- [List conversations](https://docs.hanzo.ai/docs/openapi/agent/get-agent-chat-conversations.md): Returns a summary of every agent conversation in the caller's org — id, derived title, and when it was last appended to — for populating a thread list.
- [Get conversations](https://docs.hanzo.ai/docs/openapi/agent/get-agent-chat-conversations-by-id.md): Returns every message of one conversation in order — role, content, the assistant's tool calls where it made any, and each message's creation time — which is the transcript a client replays to resume a thread.
- [List shares — GET /v1/agent/chat/conversations/{id}/shares](https://docs.hanzo.ai/docs/openapi/agent/get-agent-chat-conversations-by-id-shares.md): Returns each unrevoked share of a conversation the caller owns: its id, its access (`read`), when it was made, and its `viewers` — each signed-in person who opened it, with the name they signed in with and when.
- [List presets](https://docs.hanzo.ai/docs/openapi/agent/get-agent-chat-presets.md): Returns the preset catalog: each entry's id, its description and whether it is server-executing — the flag that decides if a preset's tool calls run here or come back for the client to apply.
- [List shared](https://docs.hanzo.ai/docs/openapi/agent/get-agent-chat-shared.md): Returns each live share the caller opened signed in: its id, the conversation's title and when the caller first opened it, most recent first.
- [Get shared](https://docs.hanzo.ai/docs/openapi/agent/get-agent-chat-shared-by-share.md): Returns the snapshot of a share the caller is a viewer of, without its token, in the shape POST /shares/read answers a signed-in person.
- [List shares — GET /v1/agent/chat/shares](https://docs.hanzo.ai/docs/openapi/agent/get-agent-chat-shares.md): For an admin of the caller's organization: every unrevoked share made in it, with the conversation's id and title, the member who made it, when, and how many people it is open to.
- [List artifacts](https://docs.hanzo.ai/docs/openapi/agent/get-agent-coding-by-session-artifacts.md): Lists what a coding run left, kept after its sandbox is gone: every file it added or changed and its whole change as `changes.patch`, stored beside the run; the ports it served, each a preview while its sandbox is kept; its pull request and where its work was published.
- [List blob](https://docs.hanzo.ai/docs/openapi/agent/get-agent-coding-by-session-blob.md): Returns one file of a coding run's repository, read where the tree is read, in the shape GET /v1/git/repos/{name}/blob answers: text verbatim, anything else base64, and a file past the 1 MiB view cap marked truncated with no content.
- [List changes](https://docs.hanzo.ai/docs/openapi/agent/get-agent-coding-by-session-changes.md): Returns what a coding run changed, read from the forge it pushed its branch to: the commits on its branch that the base does not have, newest first; the net change of the branch against its base, one entry per file with that file's patch; and its pull request with the reviews it has had, or null while it has none.
- [List tree — GET /v1/agent/coding/{session}/tree](https://docs.hanzo.ai/docs/openapi/agent/get-agent-coding-by-session-tree.md): Lists one directory of a coding run's repository, one level down with directories first: at the run's own branch once the forge holds it, and at the branch it started from until then — `ref` says which.
- [List metrics](https://docs.hanzo.ai/docs/openapi/agent/get-agent-metrics.md): Serves the invocations-over-time histogram for the org's Agents dashboard.
- [List runs — GET /v1/agent/runs](https://docs.hanzo.ai/docs/openapi/agent/get-agent-runs.md): Returns the org's agent runs across EVERY agent, newest first — what ran here, for whom, on which model, how long it took, and why it failed.
- [List sessions](https://docs.hanzo.ai/docs/openapi/agent/get-agent-sessions.md): Returns the caller org's live sessions, newest first — each with its event count, its direct-child count and a one-line preview of its latest event.
- [Get sessions](https://docs.hanzo.ai/docs/openapi/agent/get-agent-sessions-by-id.md): Returns one session with its direct child sessions and its 50 most recent events, oldest of those first.
- [List control](https://docs.hanzo.ai/docs/openapi/agent/get-agent-sessions-by-id-control.md): Returns the steering commands (pause/resume/stop/message) recorded against the caller's own session that are newer than the cursor, oldest first, with the cursor to poll from next.
- [List progress](https://docs.hanzo.ai/docs/openapi/agent/get-agent-sessions-by-id-progress.md): Returns how far along one run is: the share of its goal that is done, whether it is running, blocked or finished, and a line saying what it is doing right now.
- [List tree — GET /v1/agent/sessions/{id}/tree](https://docs.hanzo.ai/docs/openapi/agent/get-agent-sessions-by-id-tree.md): Returns the subagent-flow graph rooted at this session: the session, its children, their children, each node carrying its own event count.
- [List stream](https://docs.hanzo.ai/docs/openapi/agent/get-agent-sessions-stream.md): Holds the connection open as text/event-stream and pushes a frame each time the org's registry moves: an `event: session` frame carrying the same session shape the list and detail reads answer with (a registration, an update, or a login-manager revoke tearing a session down), and an `event: event` frame carrying one appended turn.
- [List targets](https://docs.hanzo.ai/docs/openapi/agent/get-agent-targets.md): Returns every machine registered to the caller's org, newest first, each with its live session load.
- [Get targets](https://docs.hanzo.ai/docs/openapi/agent/get-agent-targets-by-id.md): Returns one registered machine, with its live session load.
- [Update agent](https://docs.hanzo.ai/docs/openapi/agent/patch-agent-by-ref.md): Changes an agent in place.
- [Update sessions](https://docs.hanzo.ai/docs/openapi/agent/patch-agent-sessions-by-id.md): Updates a session's surface-owned truth: its status, its title, the run-target it is dispatched to, and the product it built plus whether that build's story is public.
- [Update targets](https://docs.hanzo.ai/docs/openapi/agent/patch-agent-targets-by-id.md): Updates one machine in place.
- [Create agent](https://docs.hanzo.ai/docs/openapi/agent/post-agent.md): Defines an agent in the caller's org: a model, a system prompt (instructions) and a set of tool names.
- [Create ask](https://docs.hanzo.ai/docs/openapi/agent/post-agent-ask.md): Speaks MCP over streamable HTTP and serves one tool, ask_user: a question and 2 to 8 options, shown as buttons in the run's thread, answered by the person the run is for.
- [Run agent](https://docs.hanzo.ai/docs/openapi/agent/post-agent-by-ref-run.md): Composes the agent's stored instructions with the caller's `input`, executes one real chat completion through the same in-process AI client the rest of the console uses, and answers with the run that was recorded: its id, status, model, output, duration and error.
- [Create chat](https://docs.hanzo.ai/docs/openapi/agent/post-agent-chat.md): Answers one turn of a conversation with four things: the model's `reply`, the `actions` the server executed on the caller's behalf, the `ops` the client must apply itself, and the `conversationId` the turn was recorded under.
- [Create conversations](https://docs.hanzo.ai/docs/openapi/agent/post-agent-chat-conversations.md): Writes turns to the caller's thread store without running a completion, and answers the `conversationId` they were written under.
- [Create shares](https://docs.hanzo.ai/docs/openapi/agent/post-agent-chat-conversations-by-id-shares.md): Makes a read-only link to a conversation the caller owns and answers the share and its `token`.
- [Create read](https://docs.hanzo.ai/docs/openapi/agent/post-agent-chat-shares-read.md): Takes `{token}` in the body, so the token never sits in a URL a log keeps.
- [Create coding](https://docs.hanzo.ai/docs/openapi/agent/post-agent-coding.md): Runs a coding task on a repository: clones it into a sandbox, lets a model read and edit the code, run the tests, and push the work to a branch.
- [Create merge](https://docs.hanzo.ai/docs/openapi/agent/post-agent-coding-by-session-merge.md): Merges a coding run's pull request into the branch it proposes into, on the forge the run pushed to, and answers the pull request after.
- [Create mcp](https://docs.hanzo.ai/docs/openapi/agent/post-agent-mcp-by-server.md): Speaks MCP over streamable HTTP for one of the org's MCP servers, named by its id: tools/list answers the tools of it an admin of the org activated, and tools/call calls one.
- [Create sessions](https://docs.hanzo.ai/docs/openapi/agent/post-agent-sessions.md): Opens a live agent session in the caller's org — the row every surface (the CLI's outer agent, hanzo.bot, the console, chat) hangs its activity off.
- [Create budget](https://docs.hanzo.ai/docs/openapi/agent/post-agent-sessions-by-id-budget.md): Sets, raises, or removes a session's cap.
- [Create events](https://docs.hanzo.ai/docs/openapi/agent/post-agent-sessions-by-id-events.md): Records one turn of a session's transcript and answers 201 with it.
- [Create message](https://docs.hanzo.ai/docs/openapi/agent/post-agent-sessions-by-id-message.md): Sends a steering message to a running session — the endpoint a human or another agent interrupts through.
- [Create pause](https://docs.hanzo.ai/docs/openapi/agent/post-agent-sessions-by-id-pause.md): Asks a running session to pause.
- [Resume sessions](https://docs.hanzo.ai/docs/openapi/agent/post-agent-sessions-by-id-resume.md): Asks a paused session to continue, on the same terms as a pause.
- [Stop sessions](https://docs.hanzo.ai/docs/openapi/agent/post-agent-sessions-by-id-stop.md): Ends a running session.
- [Create targets](https://docs.hanzo.ai/docs/openapi/agent/post-agent-targets.md): Registers a machine as an agent target, or re-links one that is already registered.
- [Claim targets](https://docs.hanzo.ai/docs/openapi/agent/post-agent-targets-by-id-claim.md): The machine's long poll for work: it authenticates the daemon, stamps the liveness the dispatch gate reads (the poll IS the proof a runner is listening), and waits up to 25 seconds for the next run addressed to THIS machine.
- [Create key](https://docs.hanzo.ai/docs/openapi/agent/post-agent-targets-by-id-key.md): Mints (or rotates) the claim key a `hanzo code --serve` daemon presents to claim work for this machine, and returns it ONCE: only its SHA-256 hash is stored.
- [Create report](https://docs.hanzo.ai/docs/openapi/agent/post-agent-targets-by-id-runs-by-runid-report.md): Completes a claimed run: it delivers the terminal result to the run's durable owner, which is what lets that workflow finish.
- [AI](https://docs.hanzo.ai/docs/openapi/ai.md): Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's surface) — mounted into a cloud binary with the money, ingest and telemetry callbacks cloud BUILDS but cannot INSTALL.
- [Create chat — POST /v1/ai/mcp/chat](https://docs.hanzo.ai/docs/openapi/ai/aichat.md): Asks one model one prompt and answers the reply, which model served it and who paid.
- [Create decisions — POST /v1/ai/mcp/decisions](https://docs.hanzo.ai/docs/openapi/ai/aidecide.md): Runs one decision — the caller's own POST /v1/decisions, gated and billed exactly as that route is — and answers the decision, which model served it and who paid.
- [List limits](https://docs.hanzo.ai/docs/openapi/ai/ailimits.md): Reads the caller's plan usage: for each class of model the plan includes, the share used of the billing period and of its short window, who pays for the next request, and whether the caller is in limited mode and why; the share used of the session and the day; and the ways on.
- [List tools](https://docs.hanzo.ai/docs/openapi/ai/aimcptools.md): Reports what THIS PROCESS's MCP server carries: how many tools its own registry projects, optionally their names, and which subsystems this process composed.
- [List models — GET /v1/ai/mcp/models](https://docs.hanzo.ai/docs/openapi/ai/aimodels.md): Searches the model catalog — the one GET /v1/models lists — by text, class, family or capability, and answers each match with its class, family, list price (per token and per million; variable for a router billed at the answering model's price), context window and capabilities.
- [Replace limits](https://docs.hanzo.ai/docs/openapi/ai/aisetlimits.md): Sets the payer's choice to keep using a model on credits once the plan's included usage of it is spent.
- [Delete articles](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-articles-by-owner-by-name.md): Delete one article.
- [Delete assets](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-assets-by-owner-by-name.md): Delete one asset.
- [Delete chats](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-chats-by-owner-by-name.md): Delete one chat.
- [Delete connections](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-connections-by-provider.md): Disconnects a third-party AI account: it deactivates the org's row so completion resolution falls back to the global Hanzo account (no BYO), and best-effort tombstones the sealed secret.
- [Delete deployments](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-deployments-by-owner-by-name.md): Delete one application.
- [Delete files](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-files-by-owner-by-name.md): Delete one file.
- [Delete forms](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-forms-by-owner-by-name.md): Delete one form.
- [Delete graphs](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-graphs-by-owner-by-name.md): Delete one graph.
- [Delete messages](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-messages-by-owner-by-name.md): Delete one message.
- [Delete welcome](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-messages-welcome.md): Welcome (message)
- [Delete nodes](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-nodes-by-owner-by-name.md): Delete one node.
- [Delete settings](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-org-settings.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [List settings — DELETE /v1/ai/org/settings/list](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-org-settings-list.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Delete providers](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-providers-by-owner-by-name.md): Delete one provider.
- [Delete records](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-records-by-owner-by-name.md): Delete one record.
- [Delete remote connections](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-remote-connections-by-owner-by-name.md): Delete one connection.
- [Delete artifact meta](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-router-artifact-meta.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Delete data](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-router-data.md): Router Data
- [Delete defaults](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-router-defaults.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Delete ledger](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-router-ledger.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Delete policy](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-router-policy.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Delete rewards](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-router-rewards.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Delete routes](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-routes-by-owner-by-name.md): Delete one model-route.
- [Delete scales](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-scales-by-owner-by-name.md): Delete one scale.
- [Delete scans](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-scans-by-owner-by-name.md): Delete one scan.
- [Delete signin sessions](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-signin-sessions-by-owner-by-name.md): Delete one session.
- [Delete stores](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-stores-by-owner-by-name.md): Delete one store.
- [Delete tasks](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-tasks-by-owner-by-name.md): Delete one task.
- [Delete templates](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-templates-by-owner-by-name.md): Delete one template.
- [Delete tree files](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-tree-files-by-owner-by-name.md): Delete one tree-file.
- [Delete all](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-vectors-all.md): All (vector)
- [Delete vectors](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-vectors-by-owner-by-name.md): Delete one vector.
- [Delete videos](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-videos-by-owner-by-name.md): Delete one video.
- [Delete workflows](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-workflows-by-owner-by-name.md): Delete one workflow.
- [Delete transcript](https://docs.hanzo.ai/docs/openapi/ai/delete-audio-transcript-by-id.md): Serves the growing transcript over HTTP: POST opens one, POST to its id pushes raw pcm16 at 16 kHz, and DELETE closes it with the settled text.
- [Get 3d](https://docs.hanzo.ai/docs/openapi/ai/get-3d-by-id.md): Implements GET /v1/3d/:id (Retrieve 3D status).
- [List content — GET /v1/3d/{id}/content](https://docs.hanzo.ai/docs/openapi/ai/get-3d-by-id-content.md): Implements GET /v1/3d/:id/content (Download 3D splat/glb content).
- [List account](https://docs.hanzo.ai/docs/openapi/ai/get-ai-account.md): Account
- [List activities](https://docs.hanzo.ai/docs/openapi/ai/get-ai-activities.md): List the caller's activities.
- [List answer — GET /v1/ai/answer](https://docs.hanzo.ai/docs/openapi/ai/get-ai-answer.md): Answer
- [List articles](https://docs.hanzo.ai/docs/openapi/ai/get-ai-articles.md): List the caller's articles.
- [Get articles](https://docs.hanzo.ai/docs/openapi/ai/get-ai-articles-by-owner-by-name.md): Read one article by its (owner, name) key.
- [List global — GET /v1/ai/articles/global](https://docs.hanzo.ai/docs/openapi/ai/get-ai-articles-global.md): Cross-tenant listing.
- [List assets](https://docs.hanzo.ai/docs/openapi/ai/get-ai-assets.md): List the caller's assets.
- [Get assets](https://docs.hanzo.ai/docs/openapi/ai/get-ai-assets-by-owner-by-name.md): Read one asset by its (owner, name) key.
- [List chats](https://docs.hanzo.ai/docs/openapi/ai/get-ai-chats.md): List the caller's chats.
- [Get chats](https://docs.hanzo.ai/docs/openapi/ai/get-ai-chats-by-owner-by-name.md): Read one chat by its (owner, name) key.
- [List global — GET /v1/ai/chats/global](https://docs.hanzo.ai/docs/openapi/ai/get-ai-chats-global.md): Cross-tenant listing.
- [List connections](https://docs.hanzo.ai/docs/openapi/ai/get-ai-connections.md): Lists the org's connectable AI accounts and whether each is currently connected.
- [List authorize](https://docs.hanzo.ai/docs/openapi/ai/get-ai-connections-by-provider-authorize.md): Begins an OAuth connection for the caller's org: it binds the org into a signed state and sends the caller to the provider's authorize URL.
- [List callback](https://docs.hanzo.ai/docs/openapi/ai/get-ai-connections-by-provider-callback.md): Completes OAuth: the org is recovered from the SIGNED state (not a header), the code is exchanged for a token, the token is SEALED into KMS (never the row/logs) through the same path as a BYOK key, and the org's provider row is upserted to "connected".
- [List usage](https://docs.hanzo.ai/docs/openapi/ai/get-ai-connections-by-provider-usage.md): Imports the caller org's usage for a connected third-party account.
- [List agents](https://docs.hanzo.ai/docs/openapi/ai/get-ai-dashboards-agents.md): Dashboards Agents
- [List vm](https://docs.hanzo.ai/docs/openapi/ai/get-ai-dashboards-vm.md): Dashboards Vm
- [List deployments](https://docs.hanzo.ai/docs/openapi/ai/get-ai-deployments.md): List the caller's deployments.
- [Get deployments](https://docs.hanzo.ai/docs/openapi/ai/get-ai-deployments-by-owner-by-name.md): Read one application by its (owner, name) key.
- [List files](https://docs.hanzo.ai/docs/openapi/ai/get-ai-files.md): List the caller's files.
- [List active](https://docs.hanzo.ai/docs/openapi/ai/get-ai-files-active.md): Active (file)
- [Get files](https://docs.hanzo.ai/docs/openapi/ai/get-ai-files-by-owner-by-name.md): Read one file by its (owner, name) key.
- [List global — GET /v1/ai/files/global](https://docs.hanzo.ai/docs/openapi/ai/get-ai-files-global.md): Cross-tenant listing.
- [List datasets](https://docs.hanzo.ai/docs/openapi/ai/get-ai-finetune-hf-datasets.md): Proxies a HuggingFace dataset search (dataset picker).
- [List models — GET /v1/ai/finetune/hf/models](https://docs.hanzo.ai/docs/openapi/ai/get-ai-finetune-hf-models.md): Proxies a HuggingFace model search (base-model picker).
- [List repo](https://docs.hanzo.ai/docs/openapi/ai/get-ai-finetune-hf-repo.md): Returns a repo's detail (files, gated/private state).
- [List job](https://docs.hanzo.ai/docs/openapi/ai/get-ai-finetune-job.md): Returns one job with refreshed live status.
- [List jobs](https://docs.hanzo.ai/docs/openapi/ai/get-ai-finetune-jobs.md): Returns the org's jobs, refreshing live status for active ones.
- [List presets](https://docs.hanzo.ai/docs/openapi/ai/get-ai-finetune-presets.md): Returns the new-job catalog plus, when a selection is passed (?baseModel&method&task&preset[&datasetExamples]), the recommended config so the console can render "Recommended" as a one-click, ready-to-run default.
- [List forms](https://docs.hanzo.ai/docs/openapi/ai/get-ai-forms.md): List the caller's forms.
- [Get forms](https://docs.hanzo.ai/docs/openapi/ai/get-ai-forms-by-owner-by-name.md): Read one form by its (owner, name) key.
- [List data — GET /v1/ai/forms/data](https://docs.hanzo.ai/docs/openapi/ai/get-ai-forms-data.md): Data (form)
- [List global — GET /v1/ai/forms/global](https://docs.hanzo.ai/docs/openapi/ai/get-ai-forms-global.md): Cross-tenant listing.
- [List graphs](https://docs.hanzo.ai/docs/openapi/ai/get-ai-graphs.md): List the caller's graphs.
- [Get graphs](https://docs.hanzo.ai/docs/openapi/ai/get-ai-graphs-by-owner-by-name.md): Read one graph by its (owner, name) key.
- [List global — GET /v1/ai/graphs/global](https://docs.hanzo.ai/docs/openapi/ai/get-ai-graphs-global.md): Cross-tenant listing.
- [List k8s status](https://docs.hanzo.ai/docs/openapi/ai/get-ai-k8s-status.md): K8s Status
- [List facts](https://docs.hanzo.ai/docs/openapi/ai/get-ai-memory-facts.md): List the authenticated user's stored facts
- [List memory](https://docs.hanzo.ai/docs/openapi/ai/get-ai-memory-list.md): List the authenticated user's memories, newest first
- [List recall](https://docs.hanzo.ai/docs/openapi/ai/get-ai-memory-recall.md): Recall recent/relevant memories for context injection; with q it ranks semantically, without q it returns the most recent
- [Search memory](https://docs.hanzo.ai/docs/openapi/ai/get-ai-memory-search.md): Search the authenticated user's memories (semantic, text fallback)
- [List messages](https://docs.hanzo.ai/docs/openapi/ai/get-ai-messages.md): List the caller's messages.
- [Get messages](https://docs.hanzo.ai/docs/openapi/ai/get-ai-messages-by-owner-by-name.md): Read one message by its (owner, name) key.
- [List answer — GET /v1/ai/messages/{owner}/{name}/answer](https://docs.hanzo.ai/docs/openapi/ai/get-ai-messages-by-owner-by-name-answer.md): Answer (message)
- [List nodes](https://docs.hanzo.ai/docs/openapi/ai/get-ai-nodes.md): List the caller's nodes.
- [Get nodes](https://docs.hanzo.ai/docs/openapi/ai/get-ai-nodes-by-owner-by-name.md): Read one node by its (owner, name) key.
- [List tunnel](https://docs.hanzo.ai/docs/openapi/ai/get-ai-nodes-by-owner-by-name-tunnel.md): Tunnel (node)
- [List settings — GET /v1/ai/org/settings](https://docs.hanzo.ai/docs/openapi/ai/get-ai-org-settings.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [List settings — GET /v1/ai/org/settings/list](https://docs.hanzo.ai/docs/openapi/ai/get-ai-org-settings-list.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [List prometheus](https://docs.hanzo.ai/docs/openapi/ai/get-ai-prometheus.md): Prometheus
- [List providers — GET /v1/ai/providers](https://docs.hanzo.ai/docs/openapi/ai/get-ai-providers.md): List the caller's providers.
- [Get providers](https://docs.hanzo.ai/docs/openapi/ai/get-ai-providers-by-owner-by-name.md): Read one provider by its (owner, name) key.
- [List global — GET /v1/ai/providers/global](https://docs.hanzo.ai/docs/openapi/ai/get-ai-providers-global.md): Cross-tenant listing.
- [List context](https://docs.hanzo.ai/docs/openapi/ai/get-ai-rag-context.md): Return every stored chunk of one file_id (full document context).
- [List records](https://docs.hanzo.ai/docs/openapi/ai/get-ai-records.md): List the caller's records.
- [Get records](https://docs.hanzo.ai/docs/openapi/ai/get-ai-records-by-owner-by-name.md): Read one record by its (owner, name) key.
- [Query records](https://docs.hanzo.ai/docs/openapi/ai/get-ai-records-query.md): Query (record)
- [List query second](https://docs.hanzo.ai/docs/openapi/ai/get-ai-records-query-second.md): Query Second (record)
- [List remote connections](https://docs.hanzo.ai/docs/openapi/ai/get-ai-remote-connections.md): List the caller's remote-connections.
- [Get remote connections](https://docs.hanzo.ai/docs/openapi/ai/get-ai-remote-connections-by-owner-by-name.md): Read one connection by its (owner, name) key.
- [List artifact meta](https://docs.hanzo.ai/docs/openapi/ai/get-ai-router-artifact-meta.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [List catalog](https://docs.hanzo.ai/docs/openapi/ai/get-ai-router-catalog.md): Lists the Zen and Enso routing catalogs: what each serves, its accounts and model health, and its version history.
- [List data — GET /v1/ai/router/data](https://docs.hanzo.ai/docs/openapi/ai/get-ai-router-data.md): Router Data
- [List defaults](https://docs.hanzo.ai/docs/openapi/ai/get-ai-router-defaults.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [List history](https://docs.hanzo.ai/docs/openapi/ai/get-ai-router-history.md): Returns the router-improvement time-series.
- [List judge panel](https://docs.hanzo.ai/docs/openapi/ai/get-ai-router-judge-panel.md): Returns the LIVE Mean-Field Judge Panel state: the configured panel + dynamic judge posture (enabled/sample) resolved from the "*" GlobalDefaultOwner row, the live in-process per-judge calibration (weight/mean/n), and the static published benchmark.
- [List ledger](https://docs.hanzo.ai/docs/openapi/ai/get-ai-router-ledger.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [List policy](https://docs.hanzo.ai/docs/openapi/ai/get-ai-router-policy.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [List rewards](https://docs.hanzo.ai/docs/openapi/ai/get-ai-router-rewards.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [List stats](https://docs.hanzo.ai/docs/openapi/ai/get-ai-router-stats.md): Returns the router observability aggregate.
- [List routes](https://docs.hanzo.ai/docs/openapi/ai/get-ai-routes.md): List the caller's routes.
- [Get routes](https://docs.hanzo.ai/docs/openapi/ai/get-ai-routes-by-owner-by-name.md): Read one model-route by its (owner, name) key.
- [List scales](https://docs.hanzo.ai/docs/openapi/ai/get-ai-scales.md): List the caller's scales.
- [Get scales](https://docs.hanzo.ai/docs/openapi/ai/get-ai-scales-by-owner-by-name.md): Read one scale by its (owner, name) key.
- [List global — GET /v1/ai/scales/global](https://docs.hanzo.ai/docs/openapi/ai/get-ai-scales-global.md): Cross-tenant listing.
- [List public](https://docs.hanzo.ai/docs/openapi/ai/get-ai-scales-public.md): Public (scale)
- [List scans](https://docs.hanzo.ai/docs/openapi/ai/get-ai-scans.md): List the caller's scans.
- [Get scans](https://docs.hanzo.ai/docs/openapi/ai/get-ai-scans-by-owner-by-name.md): Read one scan by its (owner, name) key.
- [List signin sessions](https://docs.hanzo.ai/docs/openapi/ai/get-ai-signin-sessions.md): List the caller's signin-sessions.
- [Get signin sessions](https://docs.hanzo.ai/docs/openapi/ai/get-ai-signin-sessions-by-owner-by-name.md): Read one session by its (owner, name) key.
- [List duplicated](https://docs.hanzo.ai/docs/openapi/ai/get-ai-signin-sessions-duplicated.md): Duplicated (session)
- [List stores](https://docs.hanzo.ai/docs/openapi/ai/get-ai-stores.md): List the caller's stores.
- [Get stores](https://docs.hanzo.ai/docs/openapi/ai/get-ai-stores-by-owner-by-name.md): Read one store by its (owner, name) key.
- [List global — GET /v1/ai/stores/global](https://docs.hanzo.ai/docs/openapi/ai/get-ai-stores-global.md): Cross-tenant listing.
- [List names](https://docs.hanzo.ai/docs/openapi/ai/get-ai-stores-names.md): Names (store)
- [List providers — GET /v1/ai/stores/providers](https://docs.hanzo.ai/docs/openapi/ai/get-ai-stores-providers.md): Providers (store)
- [List system](https://docs.hanzo.ai/docs/openapi/ai/get-ai-system.md): System
- [List tasks](https://docs.hanzo.ai/docs/openapi/ai/get-ai-tasks.md): List the caller's tasks.
- [Get tasks](https://docs.hanzo.ai/docs/openapi/ai/get-ai-tasks-by-owner-by-name.md): Read one task by its (owner, name) key.
- [List global — GET /v1/ai/tasks/global](https://docs.hanzo.ai/docs/openapi/ai/get-ai-tasks-global.md): Cross-tenant listing.
- [List templates](https://docs.hanzo.ai/docs/openapi/ai/get-ai-templates.md): List the caller's templates.
- [Get templates](https://docs.hanzo.ai/docs/openapi/ai/get-ai-templates-by-owner-by-name.md): Read one template by its (owner, name) key.
- [List globe](https://docs.hanzo.ai/docs/openapi/ai/get-ai-traffic-globe.md): Returns the PUBLIC live request-geo aggregate for the world.hanzo.ai "Hanzo mode" globe: WHERE requests to api.hanzo.ai are coming from, as country/region points with per-service-class counts, plus headline throughput rates.
- [List training contribution](https://docs.hanzo.ai/docs/openapi/ai/get-ai-training-contribution.md): Training Contribution
- [List usages](https://docs.hanzo.ai/docs/openapi/ai/get-ai-usages.md): List the caller's usages.
- [List by user](https://docs.hanzo.ai/docs/openapi/ai/get-ai-usages-by-user.md): By User (usage)
- [List cloud](https://docs.hanzo.ai/docs/openapi/ai/get-ai-usages-cloud.md): Cloud (usage)
- [List range](https://docs.hanzo.ai/docs/openapi/ai/get-ai-usages-range.md): Range (usage)
- [List user names](https://docs.hanzo.ai/docs/openapi/ai/get-ai-usages-user-names.md): User Names (usage)
- [List vectors](https://docs.hanzo.ai/docs/openapi/ai/get-ai-vectors.md): List the caller's vectors.
- [Get vectors](https://docs.hanzo.ai/docs/openapi/ai/get-ai-vectors-by-owner-by-name.md): Read one vector by its (owner, name) key.
- [List global — GET /v1/ai/vectors/global](https://docs.hanzo.ai/docs/openapi/ai/get-ai-vectors-global.md): Cross-tenant listing.
- [List version](https://docs.hanzo.ai/docs/openapi/ai/get-ai-version.md): Version
- [List videos](https://docs.hanzo.ai/docs/openapi/ai/get-ai-videos.md): List the caller's videos.
- [Get videos — GET /v1/ai/videos/{owner}/{name}](https://docs.hanzo.ai/docs/openapi/ai/get-ai-videos-by-owner-by-name.md): Read one video by its (owner, name) key.
- [List global — GET /v1/ai/videos/global](https://docs.hanzo.ai/docs/openapi/ai/get-ai-videos-global.md): Cross-tenant listing.
- [List workflows](https://docs.hanzo.ai/docs/openapi/ai/get-ai-workflows.md): List the caller's workflows.
- [Get workflows](https://docs.hanzo.ai/docs/openapi/ai/get-ai-workflows-by-owner-by-name.md): Read one workflow by its (owner, name) key.
- [List global — GET /v1/ai/workflows/global](https://docs.hanzo.ai/docs/openapi/ai/get-ai-workflows-global.md): Cross-tenant listing.
- [List models — GET /v1/models](https://docs.hanzo.ai/docs/openapi/ai/get-models.md): Returns the list of available models from the routing table.
- [List access](https://docs.hanzo.ai/docs/openapi/ai/get-models-by-model-access.md): Returns the caller's own standing for a gated model: "granted", "requested", or empty when they have never asked.
- [List providers — GET /v1/models/providers](https://docs.hanzo.ai/docs/openapi/ai/get-models-providers.md): Public, secret-free list of the providers serving the models that GET /v1/models lists — the same source, projected.
- [Get videos — GET /v1/videos/{id}](https://docs.hanzo.ai/docs/openapi/ai/get-videos-by-id.md): Implements GET /v1/videos/{id} — poll a job's status.
- [List content — GET /v1/videos/{id}/content](https://docs.hanzo.ai/docs/openapi/ai/get-videos-by-id-content.md): Implements GET /v1/videos/{id}/content — download the finished MP4.
- [Update articles](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-articles-by-owner-by-name.md): Update one article.
- [Update assets](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-assets-by-owner-by-name.md): Update one asset.
- [Update chats](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-chats-by-owner-by-name.md): Update one chat.
- [Update deployments](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-deployments-by-owner-by-name.md): Update one application.
- [Update files](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-files-by-owner-by-name.md): Update one file.
- [Update forms](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-forms-by-owner-by-name.md): Update one form.
- [Update graphs](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-graphs-by-owner-by-name.md): Update one graph.
- [Update messages](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-messages-by-owner-by-name.md): Update one message.
- [Update nodes](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-nodes-by-owner-by-name.md): Update one node.
- [Update settings](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-org-settings.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [List settings — PATCH /v1/ai/org/settings/list](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-org-settings-list.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Update preferences](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-preferences.md): Preferences
- [Update providers](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-providers-by-owner-by-name.md): Update one provider.
- [Update records](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-records-by-owner-by-name.md): Update one record.
- [Update remote connections](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-remote-connections-by-owner-by-name.md): Update one connection.
- [Update artifact meta](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-router-artifact-meta.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Update defaults](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-router-defaults.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Update ledger](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-router-ledger.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Update policy](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-router-policy.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Update rewards](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-router-rewards.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Update routes](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-routes-by-owner-by-name.md): Update one model-route.
- [Update scales](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-scales-by-owner-by-name.md): Update one scale.
- [Update scans](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-scans-by-owner-by-name.md): Update one scan.
- [Update signin sessions](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-signin-sessions-by-owner-by-name.md): Update one session.
- [Update stores](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-stores-by-owner-by-name.md): Update one store.
- [Update tasks](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-tasks-by-owner-by-name.md): Update one task.
- [Update templates](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-templates-by-owner-by-name.md): Update one template.
- [Update training contribution](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-training-contribution.md): Training Contribution
- [Update tree files](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-tree-files-by-owner-by-name.md): Update one tree-file.
- [Update vectors](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-vectors-by-owner-by-name.md): Update one vector.
- [Update videos](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-videos-by-owner-by-name.md): Update one video.
- [Update workflows](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-workflows-by-owner-by-name.md): Update one workflow.
- [Create generations — POST /v1/3d/generations](https://docs.hanzo.ai/docs/openapi/ai/post-3d-generations.md): Implements POST /v1/3d/generations (Text/Image to 3D & Gaussian Splats).
- [Create articles](https://docs.hanzo.ai/docs/openapi/ai/post-ai-articles.md): Create one article.
- [Create assets](https://docs.hanzo.ai/docs/openapi/ai/post-ai-assets.md): Create one asset.
- [Create scan — POST /v1/ai/assets/{owner}/{name}/scan](https://docs.hanzo.ai/docs/openapi/ai/post-ai-assets-by-owner-by-name-scan.md): Scan (asset)
- [Create scan — POST /v1/ai/assets/scan](https://docs.hanzo.ai/docs/openapi/ai/post-ai-assets-scan.md): Scan (asset)
- [Create chats](https://docs.hanzo.ai/docs/openapi/ai/post-ai-chats.md): Create one chat.
- [Create connections — POST /v1/ai/connections](https://docs.hanzo.ai/docs/openapi/ai/post-ai-connections.md): Connects (or reconnects) a third-party AI account for the org by sealing the supplied key into KMS and upserting the org's provider row.
- [Create connections — POST /v1/ai/connections/{provider}](https://docs.hanzo.ai/docs/openapi/ai/post-ai-connections-by-provider.md): Disconnects a third-party AI account: it deactivates the org's row so completion resolution falls back to the global Hanzo account (no BYO), and best-effort tombstones the sealed secret.
- [Create deployments](https://docs.hanzo.ai/docs/openapi/ai/post-ai-deployments.md): Create one application.
- [Deploy deployments](https://docs.hanzo.ai/docs/openapi/ai/post-ai-deployments-by-owner-by-name-deploy.md): Deploy (application)
- [Create undeploy](https://docs.hanzo.ai/docs/openapi/ai/post-ai-deployments-by-owner-by-name-undeploy.md): Undeploy (application)
- [Create feedback](https://docs.hanzo.ai/docs/openapi/ai/post-ai-feedback.md): Attaches a per-request outcome reward to the routing decision that served request_id — the enso training loop's quality signal.
- [Create files](https://docs.hanzo.ai/docs/openapi/ai/post-ai-files.md): Create one file.
- [Create activate](https://docs.hanzo.ai/docs/openapi/ai/post-ai-files-activate.md): Activate (file)
- [Create vectors — POST /v1/ai/files/{owner}/{name}/vectors](https://docs.hanzo.ai/docs/openapi/ai/post-ai-files-by-owner-by-name-vectors.md): Vectors (file)
- [Create upload — POST /v1/ai/files/upload](https://docs.hanzo.ai/docs/openapi/ai/post-ai-files-upload.md): Upload (file)
- [Cancel finetune](https://docs.hanzo.ai/docs/openapi/ai/post-ai-finetune-cancel.md): Deletes the TrainJob CR, meters the GPU-hours used so far, and marks the job cancelled.
- [Deploy finetune](https://docs.hanzo.ai/docs/openapi/ai/post-ai-finetune-deploy.md): Serves a completed job's checkpoints and registers the result as a routable model on api.hanzo.ai.
- [Create jobs](https://docs.hanzo.ai/docs/openapi/ai/post-ai-finetune-jobs.md): Validates the request, resolves efficient defaults, persists the job, and submits a real TrainJob CR.
- [Create forms](https://docs.hanzo.ai/docs/openapi/ai/post-ai-forms.md): Create one form.
- [Create graphs](https://docs.hanzo.ai/docs/openapi/ai/post-ai-graphs.md): Create one graph.
- [Delete memory](https://docs.hanzo.ai/docs/openapi/ai/post-ai-memory-delete.md): Delete one of the authenticated user's memories
- [Create remember](https://docs.hanzo.ai/docs/openapi/ai/post-ai-memory-remember.md): Store a memory for the authenticated user
- [Update memory](https://docs.hanzo.ai/docs/openapi/ai/post-ai-memory-update.md): Update one of the authenticated user's memories
- [Create messages — POST /v1/ai/messages](https://docs.hanzo.ai/docs/openapi/ai/post-ai-messages.md): Create one message.
- [Create nodes](https://docs.hanzo.ai/docs/openapi/ai/post-ai-nodes.md): Create one node.
- [Create tunnel](https://docs.hanzo.ai/docs/openapi/ai/post-ai-nodes-by-owner-by-name-tunnel.md): Tunnel (node)
- [Create settings](https://docs.hanzo.ai/docs/openapi/ai/post-ai-org-settings.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [List settings — POST /v1/ai/org/settings/list](https://docs.hanzo.ai/docs/openapi/ai/post-ai-org-settings-list.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Create providers](https://docs.hanzo.ai/docs/openapi/ai/post-ai-providers.md): Create one provider.
- [Create mcp tools](https://docs.hanzo.ai/docs/openapi/ai/post-ai-providers-mcp-tools.md): Mcp Tools (provider)
- [Delete rag](https://docs.hanzo.ai/docs/openapi/ai/post-ai-rag-delete.md): Delete all chunks of one or more uploaded files (by file_id) from the owner's Search+Vector index.
- [Create embed](https://docs.hanzo.ai/docs/openapi/ai/post-ai-rag-embed.md): Parse, chunk, and embed one uploaded file under its file_id into the unified Search+Vector index, scoped to the authenticated owner.
- [Create ingest](https://docs.hanzo.ai/docs/openapi/ai/post-ai-rag-ingest.md): Unified RAG ingest: parse + chunk + embed documents and pipe them to BOTH Hanzo Vector (semantic) AND Hanzo Search (keyword) under the tenant index {owner}-{store}-docs — the same index /v1/chat retrieval reads.
- [Query rag](https://docs.hanzo.ai/docs/openapi/ai/post-ai-rag-query.md): Retrieve the top-K chunks relevant to a query, scoped to a single uploaded file (`file_id`).
- [Create query multiple](https://docs.hanzo.ai/docs/openapi/ai/post-ai-rag-query-multiple.md): Retrieve the top-K chunks relevant to a query, scoped to a SET of uploaded files (`file_ids`).
- [Create records](https://docs.hanzo.ai/docs/openapi/ai/post-ai-records.md): Create one record.
- [Create batch](https://docs.hanzo.ai/docs/openapi/ai/post-ai-records-batch.md): Batch (record)
- [Create commit](https://docs.hanzo.ai/docs/openapi/ai/post-ai-records-commit.md): Commit (record)
- [Create commit second](https://docs.hanzo.ai/docs/openapi/ai/post-ai-records-commit-second.md): Commit Second (record)
- [Create remote connections](https://docs.hanzo.ai/docs/openapi/ai/post-ai-remote-connections.md): Create one connection.
- [Start remote connections](https://docs.hanzo.ai/docs/openapi/ai/post-ai-remote-connections-by-owner-by-name-start.md): Start (connection)
- [Stop remote connections](https://docs.hanzo.ai/docs/openapi/ai/post-ai-remote-connections-by-owner-by-name-stop.md): Stop (connection)
- [Create artifact meta](https://docs.hanzo.ai/docs/openapi/ai/post-ai-router-artifact-meta.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Create propose](https://docs.hanzo.ai/docs/openapi/ai/post-ai-router-catalog-propose.md): Answers the diff an edited catalog would apply to a family, and the version it would be made from.
- [Create rollback](https://docs.hanzo.ai/docs/openapi/ai/post-ai-router-catalog-rollback.md): Applies an earlier version of a family's catalog again, as a new version.
- [Test catalog](https://docs.hanzo.ai/docs/openapi/ai/post-ai-router-catalog-test.md): Sends one short turn to a SKU through its family and answers which upstream wrote it and how long it took.
- [Create defaults](https://docs.hanzo.ai/docs/openapi/ai/post-ai-router-defaults.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Create ledger](https://docs.hanzo.ai/docs/openapi/ai/post-ai-router-ledger.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Create policy](https://docs.hanzo.ai/docs/openapi/ai/post-ai-router-policy.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Create rewards](https://docs.hanzo.ai/docs/openapi/ai/post-ai-router-rewards.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Create routes](https://docs.hanzo.ai/docs/openapi/ai/post-ai-routes.md): Create one model-route.
- [Create scales](https://docs.hanzo.ai/docs/openapi/ai/post-ai-scales.md): Create one scale.
- [Create scans](https://docs.hanzo.ai/docs/openapi/ai/post-ai-scans.md): Create one scan.
- [Signin ai](https://docs.hanzo.ai/docs/openapi/ai/post-ai-signin.md): Signin
- [Create signin sessions](https://docs.hanzo.ai/docs/openapi/ai/post-ai-signin-sessions.md): Create one session.
- [Create signout](https://docs.hanzo.ai/docs/openapi/ai/post-ai-signout.md): Signout
- [Create stores](https://docs.hanzo.ai/docs/openapi/ai/post-ai-stores.md): Create one store.
- [Create vectors — POST /v1/ai/stores/{owner}/{name}/vectors](https://docs.hanzo.ai/docs/openapi/ai/post-ai-stores-by-owner-by-name-vectors.md): Vectors (store)
- [Create tasks](https://docs.hanzo.ai/docs/openapi/ai/post-ai-tasks.md): Create one task.
- [Create analyze](https://docs.hanzo.ai/docs/openapi/ai/post-ai-tasks-by-owner-by-name-analyze.md): Analyze (task)
- [Create document](https://docs.hanzo.ai/docs/openapi/ai/post-ai-tasks-by-owner-by-name-document.md): Document (task)
- [Create templates](https://docs.hanzo.ai/docs/openapi/ai/post-ai-templates.md): Create one template.
- [Create tree files](https://docs.hanzo.ai/docs/openapi/ai/post-ai-tree-files.md): Create one tree-file.
- [Create vectors — POST /v1/ai/vectors](https://docs.hanzo.ai/docs/openapi/ai/post-ai-vectors.md): Create one vector.
- [Create videos](https://docs.hanzo.ai/docs/openapi/ai/post-ai-videos.md): Create one video.
- [Create upload — POST /v1/ai/videos/upload](https://docs.hanzo.ai/docs/openapi/ai/post-ai-videos-upload.md): Upload (video)
- [Create workflows](https://docs.hanzo.ai/docs/openapi/ai/post-ai-workflows.md): Create one workflow.
- [Create foley](https://docs.hanzo.ai/docs/openapi/ai/post-audio-foley.md): Serves the generative audio verbs — /v1/audio/voice (TTS), /music, /foley — that the Zen family serves natively.
- [Create music](https://docs.hanzo.ai/docs/openapi/ai/post-audio-music.md): Serves the generative audio verbs — /v1/audio/voice (TTS), /music, /foley — that the Zen family serves natively.
- [Create speech](https://docs.hanzo.ai/docs/openapi/ai/post-audio-speech.md): The OpenAI-compatible TTS endpoint (POST /v1/audio/speech).
- [Create transcript — POST /v1/audio/transcript](https://docs.hanzo.ai/docs/openapi/ai/post-audio-transcript.md): Serves the growing transcript over HTTP: POST opens one, POST to its id pushes raw pcm16 at 16 kHz, and DELETE closes it with the settled text.
- [Create transcript — POST /v1/audio/transcript/{id}](https://docs.hanzo.ai/docs/openapi/ai/post-audio-transcript-by-id.md): Serves the growing transcript over HTTP: POST opens one, POST to its id pushes raw pcm16 at 16 kHz, and DELETE closes it with the settled text.
- [Create transcriptions](https://docs.hanzo.ai/docs/openapi/ai/post-audio-transcriptions.md): The OpenAI-compatible STT endpoint (POST /v1/audio/transcriptions, multipart: file + model [+ language + response_format]).
- [Create public — POST /v1/audio/transcriptions/public](https://docs.hanzo.ai/docs/openapi/ai/post-audio-transcriptions-public.md): Transcribes up to a minute of audio for a caller with no account, on Hanzo's own transcriber, within a daily allowance per visitor.
- [Create voice](https://docs.hanzo.ai/docs/openapi/ai/post-audio-voice.md): Serves the generative audio verbs — /v1/audio/voice (TTS), /music, /foley — that the Zen family serves natively.
- [Create chat — POST /v1/chat](https://docs.hanzo.ai/docs/openapi/ai/post-chat.md): Implements the OpenAI-compatible chat completions API
- [Create completions — POST /v1/chat/completions](https://docs.hanzo.ai/docs/openapi/ai/post-chat-completions.md): Implements the OpenAI-compatible chat completions API
- [Create public — POST /v1/chat/public](https://docs.hanzo.ai/docs/openapi/ai/post-chat-public.md): Serves one completion to a caller with no account.
- [Create completions — POST /v1/completions](https://docs.hanzo.ai/docs/openapi/ai/post-completions.md): Implements the OpenAI-compatible chat completions API
- [Create decisions — POST /v1/decisions](https://docs.hanzo.ai/docs/openapi/ai/post-decisions.md): Implements POST /v1/decisions (the Decisions API).
- [Create embeddings](https://docs.hanzo.ai/docs/openapi/ai/post-embeddings.md): Implements POST /v1/embeddings (OpenAI-compatible).
- [Create generations — POST /v1/images/generations](https://docs.hanzo.ai/docs/openapi/ai/post-images-generations.md): Implements POST /v1/images/generations (OpenAI-compatible).
- [Create messages — POST /v1/messages](https://docs.hanzo.ai/docs/openapi/ai/post-messages.md): Implements the Anthropic Messages API.
- [Create count tokens](https://docs.hanzo.ai/docs/openapi/ai/post-messages-count-tokens.md): Implements POST /v1/messages/count_tokens.
- [Create access](https://docs.hanzo.ai/docs/openapi/ai/post-models-by-model-access.md): Records the caller's waitlist request for a gated model and answers their new standing.
- [Create rerank](https://docs.hanzo.ai/docs/openapi/ai/post-rerank.md): Implements POST /v1/rerank (Cohere/Jina-compatible).
- [Create responses](https://docs.hanzo.ai/docs/openapi/ai/post-responses.md): Implements POST /v1/responses.
- [Create generations — POST /v1/videos/generations](https://docs.hanzo.ai/docs/openapi/ai/post-videos-generations.md): Implements POST /v1/videos/generations — the ASYNC create.
- [Replace articles](https://docs.hanzo.ai/docs/openapi/ai/put-ai-articles-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace assets](https://docs.hanzo.ai/docs/openapi/ai/put-ai-assets-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace chats](https://docs.hanzo.ai/docs/openapi/ai/put-ai-chats-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace deployments](https://docs.hanzo.ai/docs/openapi/ai/put-ai-deployments-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace files](https://docs.hanzo.ai/docs/openapi/ai/put-ai-files-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace forms](https://docs.hanzo.ai/docs/openapi/ai/put-ai-forms-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace graphs](https://docs.hanzo.ai/docs/openapi/ai/put-ai-graphs-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace messages](https://docs.hanzo.ai/docs/openapi/ai/put-ai-messages-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace nodes](https://docs.hanzo.ai/docs/openapi/ai/put-ai-nodes-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace settings](https://docs.hanzo.ai/docs/openapi/ai/put-ai-org-settings.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [List settings — PUT /v1/ai/org/settings/list](https://docs.hanzo.ai/docs/openapi/ai/put-ai-org-settings-list.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Replace preferences](https://docs.hanzo.ai/docs/openapi/ai/put-ai-preferences.md): Preferences
- [Replace providers](https://docs.hanzo.ai/docs/openapi/ai/put-ai-providers-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace records](https://docs.hanzo.ai/docs/openapi/ai/put-ai-records-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace remote connections](https://docs.hanzo.ai/docs/openapi/ai/put-ai-remote-connections-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace artifact meta](https://docs.hanzo.ai/docs/openapi/ai/put-ai-router-artifact-meta.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Replace catalog](https://docs.hanzo.ai/docs/openapi/ai/put-ai-router-catalog.md): Applies an edited catalog to one family, made from its newest version, and records the new version.
- [Replace defaults](https://docs.hanzo.ai/docs/openapi/ai/put-ai-router-defaults.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Replace ledger](https://docs.hanzo.ai/docs/openapi/ai/put-ai-router-ledger.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Replace policy](https://docs.hanzo.ai/docs/openapi/ai/put-ai-router-policy.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Replace rewards](https://docs.hanzo.ai/docs/openapi/ai/put-ai-router-rewards.md): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and /v1/ai/org/settings[/list]).
- [Replace routes](https://docs.hanzo.ai/docs/openapi/ai/put-ai-routes-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace scales](https://docs.hanzo.ai/docs/openapi/ai/put-ai-scales-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace scans](https://docs.hanzo.ai/docs/openapi/ai/put-ai-scans-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace signin sessions](https://docs.hanzo.ai/docs/openapi/ai/put-ai-signin-sessions-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace stores](https://docs.hanzo.ai/docs/openapi/ai/put-ai-stores-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace tasks](https://docs.hanzo.ai/docs/openapi/ai/put-ai-tasks-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace templates](https://docs.hanzo.ai/docs/openapi/ai/put-ai-templates-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace training contribution](https://docs.hanzo.ai/docs/openapi/ai/put-ai-training-contribution.md): Training Contribution
- [Replace tree files](https://docs.hanzo.ai/docs/openapi/ai/put-ai-tree-files-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace vectors](https://docs.hanzo.ai/docs/openapi/ai/put-ai-vectors-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace videos](https://docs.hanzo.ai/docs/openapi/ai/put-ai-videos-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Replace workflows](https://docs.hanzo.ai/docs/openapi/ai/put-ai-workflows-by-owner-by-name.md): Identical to PATCH — the handler takes a whole object either way.
- [Allowance](https://docs.hanzo.ai/docs/openapi/allowance.md): How much a plan lets you do without paying, and how much of it you have left today.
- [List allowance](https://docs.hanzo.ai/docs/openapi/allowance/get-allowance.md): Answers what the CALLER has left of their plan's free-call allowance this period, and the instant the count starts again.
- [AMQP](https://docs.hanzo.ai/docs/openapi/amqp.md): AMQP — reached at :5672; not in the public REST contract.
- [Ask](https://docs.hanzo.ai/docs/openapi/ask.md): A plain-language question about your business, answered with real numbers.
- [Create ask](https://docs.hanzo.ai/docs/openapi/ask/post-ask.md): Answers a natural-language question about the CALLER'S OWN org, from real figures rather than from the model's memory.
- [Create web](https://docs.hanzo.ai/docs/openapi/ask/research-web.md): Researches a question on the live web and answers it with its sources cited.
- [Audit](https://docs.hanzo.ai/docs/openapi/audit.md): Your org's tamper-evident audit trail: every security-relevant event, hash-chained and readable.
- [List audit](https://docs.hanzo.ai/docs/openapi/audit/get-audit.md): Reads the caller's OWN org audit trail, newest first, with the total the filter matched so a console can page it.
- [Author](https://docs.hanzo.ai/docs/openapi/author.md): A royalty for open-source work: your repo runs, you get paid.
- [List author](https://docs.hanzo.ai/docs/openapi/author/get-author.md): Returns the caller's author-program dashboard: enrolment status, linked forge login, verified repositories and owner-wide claims, recorded deploys, accrued / pending / paid royalty, and the payout history.
- [List basis](https://docs.hanzo.ai/docs/openapi/author/get-author-basis.md): Returns the AUDIT TRAIL behind the caller's own royalty: every ledger row with the spend it was computed from, the share applied at the time, the platform's matching half, whether each row satisfies the formula, and the attribution edges that already existed when the row was written.
- [Connect author](https://docs.hanzo.ai/docs/openapi/author/post-author-connect.md): Enrols the caller's org in the author program at status "connected" and returns its enrolment, including the verify code the file method needs.
- [Create record](https://docs.hanzo.ai/docs/openapi/author/post-author-deploys-record.md): Records that the caller's org deployed a project built from a source repository, which is the edge that makes an author's work earn royalty.
- [Verify repos](https://docs.hanzo.ai/docs/openapi/author/post-author-repos-verify.md): Proves that the caller owns a repository — or a whole OWNER — and records the claim, which is what makes deploys of that code earn royalty.
- [Authz](https://docs.hanzo.ai/docs/openapi/authz.md): The access decision behind an org-scoped call: who may do what, where, answered allow or deny.
- [List health](https://docs.hanzo.ai/docs/openapi/authz/get-authz-health.md): Reports that the authz process is up.
- [List readyz](https://docs.hanzo.ai/docs/openapi/authz/get-authz-readyz.md): Reports that the authz process is ready to serve decisions.
- [Create check](https://docs.hanzo.ai/docs/openapi/authz/post-authz-check.md): Answers one policy question — may this subject take this action on this object — against the CALLER'S OWN org policy set, and answers it with a bare allow/deny.
- [Auto](https://docs.hanzo.ai/docs/openapi/auto.md): Workflows that run themselves, on a schedule or a webhook.
- [Delete automations](https://docs.hanzo.ai/docs/openapi/auto/delete-auto-automations-by-id.md): Deletes an automation, its schedule and its run history, and stops a Dev run it has going.
- [Delete flows](https://docs.hanzo.ai/docs/openapi/auto/delete-auto-flows-by-id.md): Deletes one automation, its versions and its run history.
- [List automations](https://docs.hanzo.ai/docs/openapi/auto/get-auto-automations.md): Returns the org's automations.
- [Get automations](https://docs.hanzo.ai/docs/openapi/auto/get-auto-automations-by-id.md): Returns one automation.
- [List runs — GET /v1/auto/automations/{id}/runs](https://docs.hanzo.ai/docs/openapi/auto/get-auto-automations-by-id-runs.md): Returns one automation's runs, newest first, to the person it runs as or an admin of the org.
- [List flows](https://docs.hanzo.ai/docs/openapi/auto/get-auto-flows.md): Returns the caller org's automations, most-recently-updated first.
- [Get flows](https://docs.hanzo.ai/docs/openapi/auto/get-auto-flows-by-id.md): Returns one automation and its latest version.
- [List versions](https://docs.hanzo.ai/docs/openapi/auto/get-auto-flows-by-id-versions.md): Returns one flow's versions, newest first.
- [List provider](https://docs.hanzo.ai/docs/openapi/auto/get-auto-provider.md): Returns the connector catalogue.
- [List runs — GET /v1/auto/runs](https://docs.hanzo.ai/docs/openapi/auto/get-auto-runs.md): Returns the caller org's run history, newest first.
- [Get runs](https://docs.hanzo.ai/docs/openapi/auto/get-auto-runs-by-id.md): Returns one run.
- [List templates](https://docs.hanzo.ai/docs/openapi/auto/get-auto-templates.md): Returns the starter automations: a name, what it does, the instructions it runs and the schedule it suggests, in the caller's own zone.
- [Update automations](https://docs.hanzo.ai/docs/openapi/auto/patch-auto-automations-by-id.md): Changes an automation, for the person it runs as or an admin of the org: any field it was created with, and `enabled`, which arms or disarms its schedule.
- [Update flows](https://docs.hanzo.ai/docs/openapi/auto/patch-auto-flows-by-id.md): Updates one automation's metadata in place.
- [Create automations](https://docs.hanzo.ai/docs/openapi/auto/post-auto-automations.md): Creates an automation and arms its schedule.
- [Run automations](https://docs.hanzo.ai/docs/openapi/auto/post-auto-automations-by-id-run.md): Starts one run now, whether or not its schedule is armed.
- [Create review](https://docs.hanzo.ai/docs/openapi/auto/post-auto-automations-by-id-runs-by-run-review.md): Answers a run that holds a post for review, for the person the automation runs as or an admin of the org: `post` true posts it to the automation's accounts and answers the run while it posts; false discards it.
- [Create flows](https://docs.hanzo.ai/docs/openapi/auto/post-auto-flows.md): Creates an automation and its initial DRAFT version in one call.
- [Disable flows](https://docs.hanzo.ai/docs/openapi/auto/post-auto-flows-by-id-disable.md): Disarms a flow's trigger and marks it DISABLED.
- [Enable flows](https://docs.hanzo.ai/docs/openapi/auto/post-auto-flows-by-id-enable.md): Arms a flow's trigger and marks it ENABLED.
- [Create operations](https://docs.hanzo.ai/docs/openapi/auto/post-auto-flows-by-id-operations.md): Applies ONE flow operation and answers the thing it changed.
- [Run flows](https://docs.hanzo.ai/docs/openapi/auto/post-auto-flows-by-id-run.md): Starts one durable run of a flow now.
- [Create versions](https://docs.hanzo.ai/docs/openapi/auto/post-auto-flows-by-id-versions.md): Adds a new DRAFT version to a flow.
- [Create hooks](https://docs.hanzo.ai/docs/openapi/auto/post-auto-hooks-by-source-by-event.md): Delivers one event to the org's automation triggers and answers `{matched:n}` — how many enabled flows had a webhook trigger on this `(source, event)` key and were started by it.
- [Run provider](https://docs.hanzo.ai/docs/openapi/auto/post-auto-provider-by-id-run.md): Executes one provider action in-process and answers the outcome.
- [Resume runs](https://docs.hanzo.ai/docs/openapi/auto/post-auto-runs-by-id-resume.md): Delivers the durable `resume` signal to a run parked on a `wait_for_approval` waitpoint and answers `{resumed:true}` once the engine has taken it.
- [Base](https://docs.hanzo.ai/docs/openapi/base.md): Managed Hanzo Base: a hosted backend for your app — collections, records, access rules and sign-in.
- [List bases](https://docs.hanzo.ai/docs/openapi/base/get-base-bases.md): Lists every Base the caller can reach, one per org their token carries.
- [Get bases](https://docs.hanzo.ai/docs/openapi/base/get-base-bases-by-org.md): Describes ONE org's Base — whether its store exists, and what it occupies.
- [List health](https://docs.hanzo.ai/docs/openapi/base/get-base-health.md): Reports that the base subsystem is serving.
- [Benchmark](https://docs.hanzo.ai/docs/openapi/benchmark.md): One honest score for any model, on the tests everyone quotes.
- [List catalog](https://docs.hanzo.ai/docs/openapi/benchmark/get-benchmark-catalog.md): The canonical public benchmarks this arena runs — the id, title, axis, item count and upstream source of each, with native marking the ones the standardized harness runs today; the rest are registered and adapter-pending.
- [List claims](https://docs.hanzo.ai/docs/openapi/benchmark/get-benchmark-claims.md): Lists the effective claims the caller may read, each labelled with the org that made it and the user who recorded it.
- [List compare](https://docs.hanzo.ai/docs/openapi/benchmark/get-benchmark-compare.md): The ONLY valid arm-vs-arm test: it pairs the two models on the items BOTH completed, and answers rescue and damage counts with an exact-McNemar p.
- [List history](https://docs.hanzo.ai/docs/openapi/benchmark/get-benchmark-history.md): Returns each model's measured score per run over time, oldest first, with the change between runs.
- [List leaderboard](https://docs.hanzo.ai/docs/openapi/benchmark/get-benchmark-leaderboard.md): Answers one row per model for the benchmark named — what our own harness measured, beside what the vendor claims, and the gap between them.
- [List presets](https://docs.hanzo.ai/docs/openapi/benchmark/get-benchmark-presets.md): Are the router blends available to compose from — a named set of model arms, the rank they escalate through and the panel width that bounds fan-out — each served by the model layer as enso-<name>.
- [Create claims](https://docs.hanzo.ai/docs/openapi/benchmark/post-benchmark-claims.md): Records claims for the caller's org: one to correct a number, many to import a leaderboard.
- [Create presets](https://docs.hanzo.ai/docs/openapi/benchmark/post-benchmark-presets.md): Validates a router blend — its name, its arms, the rank they escalate through and the panel fan-out width — and answers 202 with the preset and the enso-<name> it would be served as.
- [Create runs](https://docs.hanzo.ai/docs/openapi/benchmark/post-benchmark-runs.md): Admits and queues a benchmark run against a model or your own endpoint, and answers 202 with the receipt.
- [Billing](https://docs.hanzo.ai/docs/openapi/billing.md): Your org's balance, what it has spent, and the cards it pays with.
- [Cancel subscriptions](https://docs.hanzo.ai/docs/openapi/billing/cancelsubscription.md): Ends a subscription.
- [Create collect](https://docs.hanzo.ai/docs/openapi/billing/collectinvoice.md): Collects an issued invoice: credit grants first, then prepaid balance, then the card on file — the same waterfall the dunning workflow runs.
- [Delete alerts](https://docs.hanzo.ai/docs/openapi/billing/delete-billing-alerts-by-id.md): Removes one of the caller's spend caps and answers 204.
- [Delete methods — DELETE /v1/billing/methods/{id}](https://docs.hanzo.ai/docs/openapi/billing/delete-billing-methods-by-id.md): Removes one card or account the caller has saved.
- [Delete methods — DELETE /v1/billing/portal/methods/{id}](https://docs.hanzo.ai/docs/openapi/billing/delete-billing-portal-methods-by-id.md): Removes one card or account the caller has saved, at the address a hosted checkout reaches it by.
- [List accounts — GET /v1/billing/accounts](https://docs.hanzo.ai/docs/openapi/billing/get-billing-accounts.md): Answers the caller's billing accounts: the org itself, its currency, when it was opened, and the caller's own standing in it.
- [List members](https://docs.hanzo.ai/docs/openapi/billing/get-billing-accounts-by-id-members.md): Answers one billing account's roster.
- [List alerts](https://docs.hanzo.ai/docs/openapi/billing/get-billing-alerts.md): Lists this org's spend caps: the ceiling, its scope, whether it enforces, and how much of it has been spent this period.
- [List authorize](https://docs.hanzo.ai/docs/openapi/billing/get-billing-alerts-authorize.md): Answers whether one proposed spend fits inside this org's caps.
- [List balance](https://docs.hanzo.ai/docs/openapi/billing/get-billing-balance.md): Answers the spendable prepaid balance of the wallet this caller bills from — the same wallet the AI prepaid gate reads before admitting a paid request, the edge meter debits, and a top-up credits.
- [List credit balance](https://docs.hanzo.ai/docs/openapi/billing/get-billing-credit-balance.md): Answers what the caller can spend right now, one entry per currency.
- [List breakdown](https://docs.hanzo.ai/docs/openapi/billing/get-billing-credit-balance-breakdown.md): Answers that same spendable credit split by grant tag, with the earliest expiry under each and the total across all of them.
- [List credits](https://docs.hanzo.ai/docs/openapi/billing/get-billing-credits.md): Lists the caller's credit grants — every one of them, spent and lapsed and voided included.
- [Get deposit](https://docs.hanzo.ai/docs/openapi/billing/get-billing-crypto-deposit-by-id.md): Reads one of the caller's own deposit intents back — pending, confirming, or succeeded.
- [List options](https://docs.hanzo.ai/docs/openapi/billing/get-billing-crypto-options.md): Answers which chains and tokens the crypto rail accepts — what an asset picker renders.
- [List invoices](https://docs.hanzo.ai/docs/openapi/billing/get-billing-invoices.md): Lists the caller's invoices, newest first, with the count beside them.
- [List pdf](https://docs.hanzo.ai/docs/openapi/billing/get-billing-invoices-by-id-pdf.md): Answers the invoice as an attachment — `application/pdf` under a Content-Disposition naming the invoice number — rather than as a JSON value, which is why this one route is untyped where its five siblings are typed: a PDF is bytes with a filename, and the two headers are the whole contract.
- [List ledger](https://docs.hanzo.ai/docs/openapi/billing/get-billing-ledger.md): Answers the org's own postings inside `range=`, each as a signed entry: a DEPOSIT CREDITS the wallet (positive, account `credits:<org>`), a HOLD sets money aside for a payment agreed and not yet made (negative, account `held:<org>`) and its return gives it back (positive), and every other posting DEBITS it (negative, account `usage:<org>`), described by its notes or its tags.
- [List methods — GET /v1/billing/methods](https://docs.hanzo.ai/docs/openapi/billing/get-billing-methods.md): Answers every payment method the caller has saved, newest first.
- [List payouts](https://docs.hanzo.ai/docs/openapi/billing/get-billing-payouts.md): Answers the org's outbound payouts, newest first — amount, destination, status, and the failure reason where one applies.
- [List plans](https://docs.hanzo.ai/docs/openapi/billing/get-billing-plans.md): Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.
- [List methods — GET /v1/billing/portal/methods](https://docs.hanzo.ai/docs/openapi/billing/get-billing-portal-methods.md): Answers every payment method the caller has saved, newest first.
- [List recharge](https://docs.hanzo.ai/docs/openapi/billing/get-billing-recharge.md): Reads the caller's auto-reload rule: top the balance up by `amountCents` whenever it falls below `thresholdCents`, charging the card on file off-session.
- [List settings](https://docs.hanzo.ai/docs/openapi/billing/get-billing-settings.md): Answers the PUBLIC half of this org's processor configuration — the ids a browser needs to tokenize a card, and the environment it must tokenize against.
- [List subscriptions](https://docs.hanzo.ai/docs/openapi/billing/get-billing-subscriptions.md): Lists the plans the caller holds, with the count beside them.
- [List tier](https://docs.hanzo.ai/docs/openapi/billing/get-billing-tier.md): Answers which tier the caller is on, what it allows, and what is left to spend.
- [List transactions](https://docs.hanzo.ai/docs/openapi/billing/get-billing-transactions.md): Answers one page of the caller's own ledger, newest first: what moved, how much, when, and what it was tagged with.
- [Get transactions](https://docs.hanzo.ai/docs/openapi/billing/get-billing-transactions-by-id.md): Reads one ledger entry by its id.
- [List usage](https://docs.hanzo.ai/docs/openapi/billing/get-billing-usage.md): Answers one row per BILLED call against the caller's org — transaction id, amount, timestamp and the metered unit.
- [List accounts — GET /v1/billing/usage/accounts](https://docs.hanzo.ai/docs/openapi/billing/get-billing-usage-accounts.md): Answers per-account totals for the linked provider accounts the gateway ROUTED this caller's traffic through — requests, prompt and completion tokens, recorded cost — plus their honest sum.
- [List rollup](https://docs.hanzo.ai/docs/openapi/billing/get-billing-usage-rollup.md): Answers the caller's month: what their plan includes, what has been consumed against it, and the wallet beside it.
- [List wire](https://docs.hanzo.ai/docs/openapi/billing/get-billing-wire.md): Answers where to send a wire top-up: the receiving bank details, with the caller's own payment reference.
- [Get invoices](https://docs.hanzo.ai/docs/openapi/billing/getinvoice.md): Reads one invoice out of the caller's org.
- [Create issue](https://docs.hanzo.ai/docs/openapi/billing/issueinvoice.md): Issues a draft invoice: moves it to OPEN, assigns its number, and makes it collectible.
- [Update alerts](https://docs.hanzo.ai/docs/openapi/billing/patch-billing-alerts-by-id.md): Changes one spend cap: raise or lower the ceiling, flip enforcement, retune the rate limit.
- [Create alerts](https://docs.hanzo.ai/docs/openapi/billing/post-billing-alerts.md): Opens a spend cap on the caller's own org.
- [Create deposit](https://docs.hanzo.ai/docs/openapi/billing/post-billing-crypto-deposit.md): Issues a deposit address the caller can send crypto to, on the asset they ask for.
- [Create methods — POST /v1/billing/methods](https://docs.hanzo.ai/docs/openapi/billing/post-billing-methods.md): Vaults the instrument at the processor and stores the row.
- [Create mode](https://docs.hanzo.ai/docs/openapi/billing/post-billing-mode.md): Moves this org between sandbox money and real money.
- [Create methods — POST /v1/billing/portal/methods](https://docs.hanzo.ai/docs/openapi/billing/post-billing-portal-methods.md): Vaults the instrument at the processor and stores the row.
- [Create run all](https://docs.hanzo.ai/docs/openapi/billing/post-billing-recharge-run-all.md): Sweeps every org's auto-recharge and answers what it did.
- [Create card](https://docs.hanzo.ai/docs/openapi/billing/post-billing-subscribe-card.md): Vaults the card (or reuses one already on file), charges the plan's FIRST period at the catalog price, and opens the subscription — one act, all of it server-side.
- [Create topup](https://docs.hanzo.ai/docs/openapi/billing/post-billing-topup.md): Charges a card the caller already saved and credits the balance.
- [Create token](https://docs.hanzo.ai/docs/openapi/billing/post-billing-topup-token.md): Charges a single-use card token and credits the caller's balance.
- [Create usage](https://docs.hanzo.ai/docs/openapi/billing/post-billing-usage.md): Debits one act an application metered to the org it acts for, and answers the receipt.
- [Replace recharge](https://docs.hanzo.ai/docs/openapi/billing/put-billing-recharge.md): Sets the caller's auto-reload rule, and answers with the rule as stored.
- [Create invoices](https://docs.hanzo.ai/docs/openapi/billing/raiseinvoice.md): Raises a DRAFT invoice against a customer in the caller's own org.
- [Create reactivate](https://docs.hanzo.ai/docs/openapi/billing/reactivatesubscription.md): Puts a canceled subscription back on its plan.
- [Create void](https://docs.hanzo.ai/docs/openapi/billing/voidinvoice.md): Voids a draft or issued invoice — the cancel.
- [Blueprint](https://docs.hanzo.ai/docs/openapi/blueprint.md): What a template costs to run, worked out before you deploy.
- [List blueprint](https://docs.hanzo.ai/docs/openapi/blueprint/get-blueprint.md): Returns every deployable blueprint with its service count and estimated monthly compute cost.
- [List health](https://docs.hanzo.ai/docs/openapi/blueprint/get-blueprint-health.md): Reports blueprint liveness and echoes the compute rate card in force.
- [List sbom](https://docs.hanzo.ai/docs/openapi/blueprint/get-blueprint-sbom.md): Answers a blueprint's SBOM — the container images its compose stack runs, each with the CPU/memory footprint that was applied to it — together with the compute cost that footprint prices out to on the active rate card.
- [Books](https://docs.hanzo.ai/docs/openapi/books.md): Double-entry accounting: chart of accounts, ledger, bank reconciliation, and the reports that prove the books balance.
- [List accounts](https://docs.hanzo.ai/docs/openapi/books/get-books-accounts.md): Returns the org's chart of accounts — the seeded fixed chart every posting key in the ledger refers to.
- [List transactions — GET /v1/books/bank/transactions](https://docs.hanzo.ai/docs/openapi/books/get-books-bank-transactions.md): Returns the org's normalized bank transactions, newest first — every row the import and connector paths have ingested, with its amount in exact cents, its direction, and whether it has been matched to a voucher yet.
- [List unreconciled](https://docs.hanzo.ai/docs/openapi/books/get-books-bank-unreconciled.md): Returns the org's unmatched bank inflows and their open clarifying questions — the queue a human answers so an unexplained deposit is never guessed into revenue.
- [Export books](https://docs.hanzo.ai/docs/openapi/books/get-books-export.md): Returns the complete financial package for the caller's org over (from, to]: the trial balance, the P&L, the balance sheet, and the GL detail behind them — the four statements a tax preparer or an investor asks for, assembled from the one ledger in a single read so they cannot disagree with each other.
- [List gl](https://docs.hanzo.ai/docs/openapi/books/get-books-gl.md): Returns the org's most recent GL Entry rows, newest first.
- [List inbox](https://docs.hanzo.ai/docs/openapi/books/get-books-inbox.md): Returns the org's open document queue — everything uploaded but not yet booked, newest first, each with its extracted summary and the confidence the scanner resolved its category at.
- [List metrics](https://docs.hanzo.ai/docs/openapi/books/get-books-metrics.md): Returns the org's deterministic SaaS-metrics snapshot over an optional (from, to] window — MRR, ARR, revenue, COGS, burn, gross margin, net income, cash, deferred revenue, monthly burn and runway — as raw int64-cent figures AND the same figures already formatted.
- [List pnl](https://docs.hanzo.ai/docs/openapi/books/get-books-pnl.md): Returns the org's accrual-basis Profit & Loss over an optional (from, to] window of RFC3339 posting times: recognized revenue, matched cost, and the net.
- [List position](https://docs.hanzo.ai/docs/openapi/books/get-books-position.md): Returns the org's Balance Sheet as of `to` (empty = all time), with the Assets == Liabilities + Equity equation proof.
- [List questions](https://docs.hanzo.ai/docs/openapi/books/get-books-questions.md): Returns the clarifying questions the caller's own recent GL raises — the unusual postings a founder should look at (outliers, reversals, round-offs, uncosted revenue, an overdrawn wallet), sharpest first.
- [List rules](https://docs.hanzo.ai/docs/openapi/books/get-books-rules.md): Returns the org's auto-categorization rules, highest priority first.
- [List transactions — GET /v1/books/transactions](https://docs.hanzo.ai/docs/openapi/books/get-books-transactions.md): Returns the org's booked ledger as a single-line register, newest first: one row per voucher, with its date, description, vendor, category, source and amount in exact cents.
- [List trial](https://docs.hanzo.ai/docs/openapi/books/get-books-trial.md): Returns the org's trial balance over an optional [from, to] window of RFC3339 posting times, including the opening/closing columns and the TotalDebit == TotalCredit proof that the books balance.
- [List vendors](https://docs.hanzo.ai/docs/openapi/books/get-books-vendors.md): Returns the org's vendor book: each canonical vendor, the alias spellings a receipt may print it under, and the expense account new bills from it default to.
- [Create ask](https://docs.hanzo.ai/docs/openapi/books/post-books-ask.md): Answers a plain-language question about the caller's own books — "what is my MRR?", "how long is my runway?" — with figures taken from their ledger, never a guessed number.
- [Import bank](https://docs.hanzo.ai/docs/openapi/books/post-books-bank-import.md): Takes a bank statement as RAW BYTES — the file exactly as downloaded, OFX, QFX or CSV, not wrapped in JSON — parses every row, books it against the caller org's own ledger, and answers the tally: how many rows were seen, how many vouchers posted, how many inflows reconciled, how many raised a question, how many were own-account transfers, and how many were skipped.
- [Sync bank](https://docs.hanzo.ai/docs/openapi/books/post-books-bank-sync.md): Pulls every connected bank (Plaid/Teller) for the caller's org, maps each fetched transaction to a posting and books it idempotently, then advances that connector's cursor so the next sync resumes where this one stopped.
- [Create inbox](https://docs.hanzo.ai/docs/openapi/books/post-books-inbox.md): Takes a document as RAW BYTES and queues it in the caller org's inbox as `unsorted`, answering the queued item.
- [Create rules](https://docs.hanzo.ai/docs/openapi/books/post-books-rules.md): Creates or updates one auto-categorization rule, keyed by its pattern — writing a pattern that already exists REPLACES that row's category and priority.
- [Create scan](https://docs.hanzo.ai/docs/openapi/books/post-books-scan.md): Takes a receipt or invoice as RAW BYTES — a PDF, an image or plain text, uploaded under its own content type, not wrapped in JSON — extracts what the document says, resolves the vendor's expense category, and answers a DRAFT carrying a balanced voucher proposed for it.
- [Create book](https://docs.hanzo.ai/docs/openapi/books/post-books-scan-book.md): Posts a reviewed scanned bill to the ledger.
- [Sync books](https://docs.hanzo.ai/docs/openapi/books/post-books-sync.md): Ingests the caller's OWN org from commerce into BOTH ledgers (live and sandbox) and reports how many new vouchers posted to each.
- [Create vendors](https://docs.hanzo.ai/docs/openapi/books/post-books-vendors.md): Creates or updates one vendor in the org's vendor book, keyed by its canonical name — writing a canonical name that already exists REPLACES that row's aliases and default category.
- [Bot](https://docs.hanzo.ai/docs/openapi/bot.md): A bot doing your work on a real desktop, live, while you watch.
- [List members](https://docs.hanzo.ai/docs/openapi/bot/get-bot-members.md): Returns the caller org's bots as space members — each with the member account uuid and the Person reference the roster addresses it by.
- [List runs](https://docs.hanzo.ai/docs/openapi/bot/get-bot-runs.md): Returns the caller org's live bot runs, read from the bot runtime and projected into the console contract with each run's live session URL derived here.
- [Sync members](https://docs.hanzo.ai/docs/openapi/bot/post-bot-members-sync.md): Re-projects the caller org's bots as members into every space of the org and removes the ones whose agent is gone.
- [Stop runs](https://docs.hanzo.ai/docs/openapi/bot/post-bot-runs-by-runid-stop.md): Terminates one of the caller org's own bot runs and reports its terminal state.
- [Campaign](https://docs.hanzo.ai/docs/openapi/campaign.md): One go-to-market push across paid, organic and email at once.
- [Delete campaign](https://docs.hanzo.ai/docs/openapi/campaign/delete-campaign-by-id.md): Removes one campaign of the caller's org and answers 204 with no body.
- [Delete channels](https://docs.hanzo.ai/docs/openapi/campaign/delete-campaign-by-id-channels-by-kind.md): Drops one channel from a campaign and returns the updated campaign.
- [List campaign](https://docs.hanzo.ai/docs/openapi/campaign/get-campaign.md): Returns the org's campaigns, newest first, optionally narrowed to one status.
- [Get campaign](https://docs.hanzo.ai/docs/openapi/campaign/get-campaign-by-id.md): Returns one campaign of the caller's org — its name, audience, creatives, channels with their per-channel launch state, schedule, budget and status.
- [List metrics](https://docs.hanzo.ai/docs/openapi/campaign/get-campaign-by-id-metrics.md): Returns a campaign's results over a window: the analytics funnel (impressions, clicks, conversions, revenue, visitors), the spend each channel's connector reports, and the derived growth KPIs — CTR, CVR, CAC and ROAS.
- [List summary](https://docs.hanzo.ai/docs/openapi/campaign/get-campaign-summary.md): Returns the org's go-to-market roll-up: how many campaigns exist, how many are live, their total budget in cents, and which channel executors this deployment can actually reach.
- [Create campaign](https://docs.hanzo.ai/docs/openapi/campaign/post-campaign.md): Creates a campaign as a DRAFT and returns it.
- [Create channels](https://docs.hanzo.ai/docs/openapi/campaign/post-campaign-by-id-channels.md): Adds a channel to a campaign, or REPLACES the one it already has of that kind, and returns the updated campaign.
- [Launch campaign](https://docs.hanzo.ai/docs/openapi/campaign/post-campaign-by-id-launch.md): Pushes the campaign live on each of its channels through that channel's executor and answers the whole campaign with the per-channel outcome written back onto it.
- [Create pause](https://docs.hanzo.ai/docs/openapi/campaign/post-campaign-by-id-pause.md): Pauses each live channel on its provider and answers the whole campaign, moved to `paused`, with the per-channel outcome written back onto it.
- [Replace campaign](https://docs.hanzo.ai/docs/openapi/campaign/put-campaign-by-id.md): Rewrites a campaign's core fields — name, audience, creatives, schedule and budget — and returns the updated campaign.
- [Captable](https://docs.hanzo.ai/docs/openapi/captable.md): Your cap table: stakeholders, share classes, grants, SAFEs, rounds, and who owns what.
- [Delete convertibles](https://docs.hanzo.ai/docs/openapi/captable/delete-captable-convertibles-by-id.md): Removes one of the caller org's convertible notes, taking its principal out of the cap table's unconverted-instrument totals.
- [Delete options](https://docs.hanzo.ai/docs/openapi/captable/delete-captable-options-by-id.md): Removes one of the caller org's option grants, taking its shares out of the cap table's granted-options and fully-diluted counts.
- [Delete safes](https://docs.hanzo.ai/docs/openapi/captable/delete-captable-safes-by-id.md): Removes one of the caller org's SAFEs, taking its capital out of the cap table's unconverted-instrument totals.
- [Delete shares](https://docs.hanzo.ai/docs/openapi/captable/delete-captable-shares-by-id.md): Removes one of the caller org's share certificates, taking its shares out of the cap table's outstanding and fully-diluted counts.
- [Delete stakeholders](https://docs.hanzo.ai/docs/openapi/captable/delete-captable-stakeholders-by-id.md): Removes one of the caller org's stakeholders.
- [List classes](https://docs.hanzo.ai/docs/openapi/captable/get-captable-classes.md): Returns the caller org's share classes, in creation order.
- [List company](https://docs.hanzo.ai/docs/openapi/captable/get-captable-company.md): Returns the caller org's cap-table company record.
- [List convertibles](https://docs.hanzo.ai/docs/openapi/captable/get-captable-convertibles.md): Returns the caller org's convertible notes, newest first.
- [List investments](https://docs.hanzo.ai/docs/openapi/captable/get-captable-investments.md): Returns the caller org's investments, newest first.
- [List options](https://docs.hanzo.ai/docs/openapi/captable/get-captable-options.md): Returns the caller org's option grants, newest first.
- [List plans](https://docs.hanzo.ai/docs/openapi/captable/get-captable-plans.md): Returns the caller org's equity plans, newest first.
- [List rounds](https://docs.hanzo.ai/docs/openapi/captable/get-captable-rounds.md): Returns the caller org's fundraising rounds, newest first.
- [Get rounds](https://docs.hanzo.ai/docs/openapi/captable/get-captable-rounds-by-id.md): Returns one of the caller org's fundraising rounds together with every investment written into it, oldest first.
- [List safes](https://docs.hanzo.ai/docs/openapi/captable/get-captable-safes.md): Returns the caller org's SAFEs, newest first.
- [List shares](https://docs.hanzo.ai/docs/openapi/captable/get-captable-shares.md): Returns the caller org's share certificates, newest first.
- [List stakeholders](https://docs.hanzo.ai/docs/openapi/captable/get-captable-stakeholders.md): Returns the caller org's stakeholders, newest first.
- [List summary](https://docs.hanzo.ai/docs/openapi/captable/get-captable-summary.md): Computes the caller org's cap table.
- [Update classes](https://docs.hanzo.ai/docs/openapi/captable/patch-captable-classes-by-id.md): Replaces one share class's terms.
- [Update stakeholders](https://docs.hanzo.ai/docs/openapi/captable/patch-captable-stakeholders-by-id.md): Changes one of the caller org's stakeholders.
- [Create classes](https://docs.hanzo.ai/docs/openapi/captable/post-captable-classes.md): Defines a new class of shares.
- [Create convertibles](https://docs.hanzo.ai/docs/openapi/captable/post-captable-convertibles.md): Records a convertible note.
- [Create options](https://docs.hanzo.ai/docs/openapi/captable/post-captable-options.md): Grants options to a stakeholder from an equity plan.
- [Create plans](https://docs.hanzo.ai/docs/openapi/captable/post-captable-plans.md): Opens an equity plan that options are granted from.
- [Create rounds](https://docs.hanzo.ai/docs/openapi/captable/post-captable-rounds.md): Opens a priced round that investments can be added to.
- [Create close](https://docs.hanzo.ai/docs/openapi/captable/post-captable-rounds-by-id-close.md): Closes one of the caller org's fundraising rounds, recording the close date and moving its status to CLOSED.
- [Create investments](https://docs.hanzo.ai/docs/openapi/captable/post-captable-rounds-by-id-investments.md): Records one investor's money into an open round.
- [Create safes](https://docs.hanzo.ai/docs/openapi/captable/post-captable-safes.md): Records a SAFE — a simple agreement for future equity.
- [Create shares](https://docs.hanzo.ai/docs/openapi/captable/post-captable-shares.md): Issues a share certificate to a stakeholder.
- [Create transfer](https://docs.hanzo.ai/docs/openapi/captable/post-captable-shares-transfer.md): Moves shares from one stakeholder to another.
- [Create stakeholders](https://docs.hanzo.ai/docs/openapi/captable/post-captable-stakeholders.md): Records the people and institutions that can hold equity — the rows every share, option, SAFE, note and investment is issued to.
- [Replace company](https://docs.hanzo.ai/docs/openapi/captable/put-captable-company.md): Sets the caller org's company name and incorporation details.
- [Catalog](https://docs.hanzo.ai/docs/openapi/catalog.md): One place to browse every project, app and site built here.
- [List catalog](https://docs.hanzo.ai/docs/openapi/catalog/get-catalog.md): Searches AND browses the cross-org catalog: every project, app and site the fleet has built, whichever org built it.
- [Channel](https://docs.hanzo.ai/docs/openapi/channel.md): One inbox for the chat apps you connect — Discord, Slack, Teams, Telegram.
- [List channel](https://docs.hanzo.ai/docs/openapi/channel/get-channel.md): Reports every chat channel this org can send through, and whether it can send through it right now.
- [List agent](https://docs.hanzo.ai/docs/openapi/channel/get-channel-agent.md): Returns which agent answers the caller org's channel: the default and every room bound to another agent.
- [List allowlist](https://docs.hanzo.ai/docs/openapi/channel/get-channel-allowlist.md): Returns the caller org's access policy for one channel: whether DMs are pairing-gated, allowlisted or open, whether group rooms are open, allowlisted or disabled, the config-managed DM and group allow entries, the senders approved through PAIRING (read-only here), and the org's named access groups.
- [List inbox](https://docs.hanzo.ai/docs/openapi/channel/get-channel-inbox.md): Returns the messages people have sent to the caller org's connected chat bots, oldest first, in the portable envelope shape every transport normalises into.
- [List pairing](https://docs.hanzo.ai/docs/openapi/channel/get-channel-pairing.md): Returns the pairing requests waiting for the caller org to approve — one per person who messaged a connected bot on a channel whose DM policy is "pairing" and who is not allowed yet.
- [Send channel](https://docs.hanzo.ai/docs/openapi/channel/post-channel-by-channel-send.md): Delivers text, attachments and actions to one room on a connected chat transport — discord, github, linear, slack, teams, telegram or whatsapp — and answers that transport's own receipt, the `messageId` it assigned and the Unix second it landed.
- [Approve pairing](https://docs.hanzo.ai/docs/openapi/channel/post-channel-pairing-approve.md): Turns one pending pairing code into a standing allow entry, so that person can DM the org's bot on that channel from now on.
- [Replace agent](https://docs.hanzo.ai/docs/openapi/channel/put-channel-agent.md): Binds agents to the caller org's channel and answers the bindings as GET would.
- [Replace allowlist](https://docs.hanzo.ai/docs/openapi/channel/put-channel-allowlist.md): Edits the caller org's access policy for one channel and answers the policy as GET would, so both verbs return ONE shape.
- [Ci](https://docs.hanzo.ai/docs/openapi/ci.md): Mounts the CI fleet dashboard as a capability of this binary.
- [List fleet](https://docs.hanzo.ai/docs/openapi/ci/get-ci-fleet.md): Compares what was written with what is running, one row per service along a single causal line: head, the commit on the branch; built, the image that commit produced; declared, the tag pinned in the universe repository; running, what the cluster serves.
- [List runs](https://docs.hanzo.ai/docs/openapi/ci/get-ci-runs.md): Lists recent builds: the repo, the branch, the commit and how each run ended, newest first.
- [Cloudflare](https://docs.hanzo.ai/docs/openapi/cloudflare.md): Your Cloudflare account, managed from Hanzo: zones, Pages, Workers, Workers AI, R2, KV and D1.
- [Delete databases](https://docs.hanzo.ai/docs/openapi/cloudflare/delete-cloudflare-d1-databases-by-database.md): Deletes a D1 database and everything stored in it.
- [Delete namespaces](https://docs.hanzo.ai/docs/openapi/cloudflare/delete-cloudflare-kv-namespaces-by-namespace.md): Deletes a Workers KV namespace and every key in it.
- [Delete values](https://docs.hanzo.ai/docs/openapi/cloudflare/delete-cloudflare-kv-namespaces-by-namespace-values-by-key.md): Removes one key from a Workers KV namespace.
- [Delete projects](https://docs.hanzo.ai/docs/openapi/cloudflare/delete-cloudflare-pages-projects-by-project.md): Deletes a Cloudflare Pages project, and with it every deployment it has ever made.
- [Delete domains](https://docs.hanzo.ai/docs/openapi/cloudflare/delete-cloudflare-pages-projects-by-project-domains-by-domain.md): Detaches a custom domain from a Cloudflare Pages project.
- [Delete buckets](https://docs.hanzo.ai/docs/openapi/cloudflare/delete-cloudflare-r2-buckets-by-bucket.md): Deletes an R2 bucket.
- [Delete scripts](https://docs.hanzo.ai/docs/openapi/cloudflare/delete-cloudflare-workers-scripts-by-script.md): Removes a Worker script from the org's Cloudflare account.
- [Delete routes](https://docs.hanzo.ai/docs/openapi/cloudflare/delete-cloudflare-workers-zones-by-zone-routes-by-route.md): Unbinds a Worker route, so its pattern stops dispatching to a script.
- [List databases](https://docs.hanzo.ai/docs/openapi/cloudflare/get-cloudflare-d1-databases.md): Lists the D1 databases on the org's Cloudflare account.
- [List namespaces](https://docs.hanzo.ai/docs/openapi/cloudflare/get-cloudflare-kv-namespaces.md): Lists the Workers KV namespaces on the org's Cloudflare account.
- [Get values](https://docs.hanzo.ai/docs/openapi/cloudflare/get-cloudflare-kv-namespaces-by-namespace-values-by-key.md): Answers one KV key's value from the org's OWN Cloudflare account as RAW BYTES under the content type it was written with — not wrapped in a JSON envelope, which is why this is not a typed op.
- [List projects](https://docs.hanzo.ai/docs/openapi/cloudflare/get-cloudflare-pages-projects.md): Lists the org's Cloudflare Pages projects.
- [Get projects](https://docs.hanzo.ai/docs/openapi/cloudflare/get-cloudflare-pages-projects-by-project.md): Reads one Cloudflare Pages project — its build config, deployment configs and latest deployment.
- [List buckets](https://docs.hanzo.ai/docs/openapi/cloudflare/get-cloudflare-r2-buckets.md): Lists the R2 buckets on the org's Cloudflare account.
- [List scripts](https://docs.hanzo.ai/docs/openapi/cloudflare/get-cloudflare-workers-scripts.md): Lists the Worker scripts on the org's Cloudflare account.
- [List subdomain](https://docs.hanzo.ai/docs/openapi/cloudflare/get-cloudflare-workers-subdomain.md): Reads the org account's workers.dev subdomain — the name under which every subdomain-enabled script is served.
- [List routes](https://docs.hanzo.ai/docs/openapi/cloudflare/get-cloudflare-workers-zones-by-zone-routes.md): Lists the Worker routes bound within one zone — the URL patterns that dispatch to a script.
- [List zones](https://docs.hanzo.ai/docs/openapi/cloudflare/get-cloudflare-zones.md): Lists the Cloudflare zones the org's connected API token can see, paged and filtered by the query parameters Cloudflare itself accepts.
- [Get zones](https://docs.hanzo.ai/docs/openapi/cloudflare/get-cloudflare-zones-by-zone.md): Reads one Cloudflare zone the org's token can see.
- [List analytics](https://docs.hanzo.ai/docs/openapi/cloudflare/get-cloudflare-zones-by-zone-analytics.md): Reads a zone's Cloudflare traffic dashboard — requests, bandwidth, threats and pageviews over the since/until window.
- [Create databases](https://docs.hanzo.ai/docs/openapi/cloudflare/post-cloudflare-d1-databases.md): Creates a D1 database on the org's Cloudflare account.
- [Query databases](https://docs.hanzo.ai/docs/openapi/cloudflare/post-cloudflare-d1-databases-by-database-query.md): Runs one SQL statement against a D1 database.
- [Create namespaces](https://docs.hanzo.ai/docs/openapi/cloudflare/post-cloudflare-kv-namespaces.md): Creates a Workers KV namespace on the org's Cloudflare account.
- [Create projects](https://docs.hanzo.ai/docs/openapi/cloudflare/post-cloudflare-pages-projects.md): Creates a Cloudflare Pages project on the org's account.
- [Create deployments](https://docs.hanzo.ai/docs/openapi/cloudflare/post-cloudflare-pages-projects-by-project-deployments.md): Starts a build and deployment of one Cloudflare Pages project on the org's OWN Cloudflare account, and relays Cloudflare's deployment record back.
- [Create domains](https://docs.hanzo.ai/docs/openapi/cloudflare/post-cloudflare-pages-projects-by-project-domains.md): Attaches a custom domain to a Cloudflare Pages project.
- [Create buckets](https://docs.hanzo.ai/docs/openapi/cloudflare/post-cloudflare-r2-buckets.md): Creates an R2 bucket on the org's Cloudflare account.
- [Create subdomain](https://docs.hanzo.ai/docs/openapi/cloudflare/post-cloudflare-workers-scripts-by-script-subdomain.md): Publishes or withdraws one Worker script on the account's workers.dev subdomain.
- [Create routes](https://docs.hanzo.ai/docs/openapi/cloudflare/post-cloudflare-workers-zones-by-zone-routes.md): Binds a URL pattern in a zone to a Worker script.
- [Create purge](https://docs.hanzo.ai/docs/openapi/cloudflare/post-cloudflare-zones-by-zone-purge.md): Drops a zone's Cloudflare edge cache — either the whole zone (purge_everything) or exactly the listed file URLs.
- [Replace values](https://docs.hanzo.ai/docs/openapi/cloudflare/put-cloudflare-kv-namespaces-by-namespace-values-by-key.md): Stores one KV key on the org's OWN Cloudflare account.
- [Replace scripts](https://docs.hanzo.ai/docs/openapi/cloudflare/put-cloudflare-workers-scripts-by-script.md): Uploads or replaces a module Worker script.
- [Code](https://docs.hanzo.ai/docs/openapi/code.md): Search and symbols across your repos, for you and your agents.
- [List ask](https://docs.hanzo.ai/docs/openapi/code/get-code-ask.md): Answers a question about the caller org's code with a CITED answer: retrieval packs grounding context, then the synthesizer writes the answer over exactly those spans, which come back alongside it.
- [List file](https://docs.hanzo.ai/docs/openapi/code/get-code-file.md): Returns the INDEXED content of one file — read_file over the chunks the search tiers hold, for pulling up code an agent just found.
- [Search code](https://docs.hanzo.ai/docs/openapi/code/get-code-search.md): Finds code in the caller org's index across three orthogonal retrieval tiers fused by reciprocal-rank fusion: lexical (FTS5 trigram over code-tokenized text), symbolic (real definition and reference edges), and semantic (embedding cosine over AST-boundary chunks).
- [List tree](https://docs.hanzo.ai/docs/openapi/code/get-code-tree.md): Returns one repository's file structure with a per-file symbol count — get_repo_structure over the org's own index, with no git checkout involved.
- [Create ask](https://docs.hanzo.ai/docs/openapi/code/post-code-ask.md): Answers a question about the caller org's code with a CITED answer, taking the question from the request BODY, for a question too long or too awkward to put in a URL.
- [Create context](https://docs.hanzo.ai/docs/openapi/code/post-code-context.md): Packs the most relevant code for a query into a token budget — THE primitive for a coding agent that has to decide what to put in a prompt.
- [Create index](https://docs.hanzo.ai/docs/openapi/code/post-code-index.md): (re)indexes a repository for the caller's org, incrementally: files whose content hash is unchanged are skipped, so re-sending a whole tree is cheap.
- [Commerce](https://docs.hanzo.ai/docs/openapi/commerce.md): Selling: checkout, subscriptions, invoices, spend alerts, payment webhooks and the storefront catalog.
- [Delete collection](https://docs.hanzo.ai/docs/openapi/commerce/delete-commerce-collection-by-collectionid.md): A collection is a merchandising group a storefront renders — a slug and name, copy and media, flat lists of the product and variant ids it holds, published, preorder and out-of-stock flags, and an availability window.
- [Delete disclosure](https://docs.hanzo.ai/docs/openapi/commerce/delete-commerce-disclosure-by-disclosureid.md): A disclosure is a published-document record — a publication body, a content hash, a type and a named receiver.
- [Delete discount](https://docs.hanzo.ai/docs/openapi/commerce/delete-commerce-discount-by-discountid.md): A discount is a price rule: a type (flat, percent, free-shipping, free-item or bulk), a window, a scope naming the store, collection, product or variant it applies to, a target, and rules pairing a trigger — a price or quantity threshold — with an action, an amount off or a percentage.
- [Delete movie](https://docs.hanzo.ai/docs/openapi/commerce/delete-commerce-movie-by-movieid.md): A movie is a film catalog record — a slug plus EIDR and IMDB ids, all three required, with title and synopsis copy, artwork, screenshots, trailers, cast and crew, and available and hidden flags.
- [Delete note](https://docs.hanzo.ai/docs/openapi/commerce/delete-commerce-note-by-noteid.md): A note is a timestamped free-text log line — a caller-supplied time, a source, a message and an enabled flag.
- [Delete product](https://docs.hanzo.ai/docs/openapi/commerce/delete-commerce-product-by-productid.md): A product is a sellable catalog item: slug, SKU and UPC, name and copy, media, availability and preorder flags, a reservation block, and its money — currency, price, MSRP, list price and inventory cost in minor units, inventory count, taxability, and the subscription interval when it is subscribeable.
- [Delete return](https://docs.hanzo.ai/docs/openapi/commerce/delete-commerce-return-by-returnid.md): A return is an RMA — the store, user and order it belongs to, the line items coming back, a fulfillment block carrying its own type, status and pricing, a summary, and eight lifecycle timestamps from submitted through delivered and processed.
- [Delete saleschannel](https://docs.hanzo.ai/docs/openapi/commerce/delete-commerce-saleschannel-by-saleschannelid.md): A sales channel is a named selling surface — a name, a description, a disabled flag and metadata.
- [Delete stocklocation](https://docs.hanzo.ai/docs/openapi/commerce/delete-commerce-stocklocation-by-stocklocationid.md): A stock location is a physical address inventory can be held at — a name, street lines, city, province, country, postal code and a phone.
- [Delete store](https://docs.hanzo.ai/docs/openapi/commerce/delete-commerce-store-by-storeid.md): Removes the addressed store and answers 204 with no body.
- [Delete listing](https://docs.hanzo.ai/docs/openapi/commerce/delete-commerce-store-by-storeid-listing-by-key.md): Drops the key from the store's listing map and re-saves the store, answering 204 with no body.
- [Delete submission](https://docs.hanzo.ai/docs/openapi/commerce/delete-commerce-submission-by-submissionid.md): A submission is one filled-in form from a site visitor — an email, an optional user id, the client details the server observed (user agent, referer, geography) and the form's own fields as free metadata.
- [Delete subscriber](https://docs.hanzo.ai/docs/openapi/commerce/delete-commerce-subscriber-by-subscriberid.md): A subscriber is a mailing-list member — name, email, the form id that captured them, unsubscribed state and date, client details, tags and metadata.
- [Delete tokentransaction](https://docs.hanzo.ai/docs/openapi/commerce/delete-commerce-tokentransaction-by-tokentransactionid.md): A token transaction records a transfer between two identified parties — amount and fees, a timestamp, sending and receiving addresses, names, user ids, states and countries, a flag per side, a protocol name and a transaction hash.
- [Delete transfer](https://docs.hanzo.ai/docs/openapi/commerce/delete-commerce-transfer-by-transferid.md): A transfer records that a payable WAS PAID — the annotation a human writes after paying out of band.
- [Delete variant](https://docs.hanzo.ai/docs/openapi/commerce/delete-commerce-variant-by-variantid.md): A variant is one purchasable SKU of a product — its product id, SKU and UPC, name, media, availability, the option name and value pairs that distinguish it, a sold counter, and its own money and stock: currency, price, MSRP, inventory cost, inventory count and taxability.
- [Delete wallet](https://docs.hanzo.ai/docs/openapi/commerce/delete-commerce-wallet-by-walletid.md): A wallet is a container of custodial blockchain accounts, and its only field is that account list — each account carrying a name, an address, a chain type, and the ENCRYPTED private key with its salt.
- [Delete watchlist](https://docs.hanzo.ai/docs/openapi/commerce/delete-commerce-watchlist-by-watchlistid.md): A watchlist is a viewer's saved list of movies — a user id, an email, and the movies themselves.
- [Delete webhook](https://docs.hanzo.ai/docs/openapi/commerce/delete-commerce-webhook-by-webhookid.md): A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY.
- [Create discard](https://docs.hanzo.ai/docs/openapi/commerce/discardcart.md): Discards a cart the shopper abandoned, and answers it in its final state.
- [List catalog](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-catalog.md): Returns the brand's published catalog — the shared source docs, the console sidebar and the pricing pages all read — with the brand taken from the query and defaulting to hanzo.
- [List collection](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-collection.md): A collection is a merchandising group a storefront renders — a slug and name, copy and media, flat lists of the product and variant ids it holds, published, preorder and out-of-stock flags, and an availability window.
- [Get collection](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-collection-by-collectionid.md): A collection is a merchandising group a storefront renders — a slug and name, copy and media, flat lists of the product and variant ids it holds, published, preorder and out-of-stock flags, and an availability window.
- [List currencies](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-currencies.md): Returns every reference currency as one global list, so a store settings form or a product price picker binds real rows instead of a hardcoded array.
- [List disclosure](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-disclosure.md): A disclosure is a published-document record — a publication body, a content hash, a type and a named receiver.
- [Get disclosure](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-disclosure-by-disclosureid.md): A disclosure is a published-document record — a publication body, a content hash, a type and a named receiver.
- [List discount](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-discount.md): A discount is a price rule: a type (flat, percent, free-shipping, free-item or bulk), a window, a scope naming the store, collection, product or variant it applies to, a target, and rules pairing a trigger — a price or quantity threshold — with an action, an amount off or a percentage.
- [Get discount](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-discount-by-discountid.md): A discount is a price rule: a type (flat, percent, free-shipping, free-item or bulk), a window, a scope naming the store, collection, product or variant it applies to, a target, and rules pairing a trigger — a price or quantity threshold — with an action, an amount off or a percentage.
- [List health](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-health.md): Answers ok whenever the commerce subsystem is mounted.
- [List movie](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-movie.md): A movie is a film catalog record — a slug plus EIDR and IMDB ids, all three required, with title and synopsis copy, artwork, screenshots, trailers, cast and crew, and available and hidden flags.
- [Get movie](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-movie-by-movieid.md): A movie is a film catalog record — a slug plus EIDR and IMDB ids, all three required, with title and synopsis copy, artwork, screenshots, trailers, cast and crew, and available and hidden flags.
- [List note](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-note.md): A note is a timestamped free-text log line — a caller-supplied time, a source, a message and an enabled flag.
- [Get note](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-note-by-noteid.md): A note is a timestamped free-text log line — a caller-supplied time, a source, a message and an enabled flag.
- [List org](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-org.md): Answers the branding, identity issuer and client id, identity-verification config, enabled payment providers, return-URL allowlist and public payment application config for the org the request HOST resolves to.
- [List product](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-product.md): A product is a sellable catalog item: slug, SKU and UPC, name and copy, media, availability and preorder flags, a reservation block, and its money — currency, price, MSRP, list price and inventory cost in minor units, inventory count, taxability, and the subscription interval when it is subscribeable.
- [Get product — GET /v1/commerce/product/{productid}](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-product-by-productid.md): A product is a sellable catalog item: slug, SKU and UPC, name and copy, media, availability and preorder flags, a reservation block, and its money — currency, price, MSRP, list price and inventory cost in minor units, inventory count, taxability, and the subscription interval when it is subscribeable.
- [List return](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-return.md): A return is an RMA — the store, user and order it belongs to, the line items coming back, a fulfillment block carrying its own type, status and pricing, a summary, and eight lifecycle timestamps from submitted through delivered and processed.
- [Get return](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-return-by-returnid.md): A return is an RMA — the store, user and order it belongs to, the line items coming back, a fulfillment block carrying its own type, status and pricing, a summary, and eight lifecycle timestamps from submitted through delivered and processed.
- [List saleschannel](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-saleschannel.md): A sales channel is a named selling surface — a name, a description, a disabled flag and metadata.
- [Get saleschannel](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-saleschannel-by-saleschannelid.md): A sales channel is a named selling surface — a name, a description, a disabled flag and metadata.
- [List stocklocation](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-stocklocation.md): A stock location is a physical address inventory can be held at — a name, street lines, city, province, country, postal code and a phone.
- [Get stocklocation](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-stocklocation-by-stocklocationid.md): A stock location is a physical address inventory can be held at — a name, street lines, city, province, country, postal code and a phone.
- [List store](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-store.md): Answers a pagination envelope — page, display, the rows, and a total count — read from the caller org's OWN namespaced database, so one tenant can never list another's stores.
- [List access](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-store-access.md): Answers allowed, the store id, and a status of trial, active, payment_required, store_required or unavailable — the entitlement check a merchant surface gates on.
- [Get store](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-store-by-storeid.md): Reads the addressed store from the caller org's own namespaced database, so an id belonging to another tenant is simply absent there and answers 404 rather than leaking its existence.
- [Get bundle](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-store-by-storeid-bundle-by-key.md): Returns the stored bundle with the store's listing for it laid over the top — every non-empty listing field wins, and the currency is forced to the store's own — so the caller reads what this storefront actually sells rather than the catalog-wide record.
- [List listing](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-store-by-storeid-listing.md): Returns every override this store applies to catalog items — name, price, list price, media, availability and the hidden flag — keyed by product or variant id, in one read.
- [Get listing](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-store-by-storeid-listing-by-key.md): Looks the key up in the store's listing map first and, failing that, matches it against each listing's slug and then its SKU — so a storefront holding only a product's URL slug can still resolve the override.
- [Get product — GET /v1/commerce/store/{storeid}/product/{key}](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-store-by-storeid-product-by-key.md): Returns the stored product with the store's listing for it laid over the top — non-empty listing fields replace the catalog values and the currency is forced to the store's own — which is what lets two storefronts sell the same catalog product at their own price, name and media.
- [Get variant — GET /v1/commerce/store/{storeid}/variant/{key}](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-store-by-storeid-variant-by-key.md): Returns the stored variant with the store's listing for it overlaid — non-empty listing fields replace the catalog values and the currency is forced to the store's own — which is what makes per-storefront pricing of a shared variant possible.
- [List current](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-store-current.md): Returns the caller org's store resolved FROM THE AUTHENTICATED ORG rather than from a path id — which is how an admin dashboard or a storefront edge learns the store id it should then read and write against.
- [List submission](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-submission.md): A submission is one filled-in form from a site visitor — an email, an optional user id, the client details the server observed (user agent, referer, geography) and the form's own fields as free metadata.
- [Get submission](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-submission-by-submissionid.md): A submission is one filled-in form from a site visitor — an email, an optional user id, the client details the server observed (user agent, referer, geography) and the form's own fields as free metadata.
- [List subscriber](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-subscriber.md): A subscriber is a mailing-list member — name, email, the form id that captured them, unsubscribed state and date, client details, tags and metadata.
- [Get subscriber](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-subscriber-by-subscriberid.md): A subscriber is a mailing-list member — name, email, the form id that captured them, unsubscribed state and date, client details, tags and metadata.
- [List tokentransaction](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-tokentransaction.md): A token transaction records a transfer between two identified parties — amount and fees, a timestamp, sending and receiving addresses, names, user ids, states and countries, a flag per side, a protocol name and a transaction hash.
- [Get tokentransaction](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-tokentransaction-by-tokentransactionid.md): A token transaction records a transfer between two identified parties — amount and fees, a timestamp, sending and receiving addresses, names, user ids, states and countries, a flag per side, a protocol name and a transaction hash.
- [List transfer](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-transfer.md): A transfer records that a payable WAS PAID — the annotation a human writes after paying out of band.
- [Get transfer](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-transfer-by-transferid.md): A transfer records that a payable WAS PAID — the annotation a human writes after paying out of band.
- [List variant](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-variant.md): A variant is one purchasable SKU of a product — its product id, SKU and UPC, name, media, availability, the option name and value pairs that distinguish it, a sold counter, and its own money and stock: currency, price, MSRP, inventory cost, inventory count and taxability.
- [Get variant — GET /v1/commerce/variant/{variantid}](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-variant-by-variantid.md): A variant is one purchasable SKU of a product — its product id, SKU and UPC, name, media, availability, the option name and value pairs that distinguish it, a sold counter, and its own money and stock: currency, price, MSRP, inventory cost, inventory count and taxability.
- [List wallet](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-wallet.md): A wallet is a container of custodial blockchain accounts, and its only field is that account list — each account carrying a name, an address, a chain type, and the ENCRYPTED private key with its salt.
- [Get wallet](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-wallet-by-walletid.md): A wallet is a container of custodial blockchain accounts, and its only field is that account list — each account carrying a name, an address, a chain type, and the ENCRYPTED private key with its salt.
- [List watchlist](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-watchlist.md): A watchlist is a viewer's saved list of movies — a user id, an email, and the movies themselves.
- [Get watchlist](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-watchlist-by-watchlistid.md): A watchlist is a viewer's saved list of movies — a user id, an email, and the movies themselves.
- [List webhook](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-webhook.md): A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY.
- [Get webhook](https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-webhook-by-webhookid.md): A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY.
- [Get cart](https://docs.hanzo.ai/docs/openapi/commerce/getcart.md): Reads one cart: its lines, its status and what it comes to.
- [Create cart](https://docs.hanzo.ai/docs/openapi/commerce/opencart.md): Opens an empty cart for a shopper to fill, and answers it with its new id.
- [Update collection](https://docs.hanzo.ai/docs/openapi/commerce/patch-commerce-collection-by-collectionid.md): A collection is a merchandising group a storefront renders — a slug and name, copy and media, flat lists of the product and variant ids it holds, published, preorder and out-of-stock flags, and an availability window.
- [Update disclosure](https://docs.hanzo.ai/docs/openapi/commerce/patch-commerce-disclosure-by-disclosureid.md): A disclosure is a published-document record — a publication body, a content hash, a type and a named receiver.
- [Update discount](https://docs.hanzo.ai/docs/openapi/commerce/patch-commerce-discount-by-discountid.md): A discount is a price rule: a type (flat, percent, free-shipping, free-item or bulk), a window, a scope naming the store, collection, product or variant it applies to, a target, and rules pairing a trigger — a price or quantity threshold — with an action, an amount off or a percentage.
- [Update movie](https://docs.hanzo.ai/docs/openapi/commerce/patch-commerce-movie-by-movieid.md): A movie is a film catalog record — a slug plus EIDR and IMDB ids, all three required, with title and synopsis copy, artwork, screenshots, trailers, cast and crew, and available and hidden flags.
- [Update note](https://docs.hanzo.ai/docs/openapi/commerce/patch-commerce-note-by-noteid.md): A note is a timestamped free-text log line — a caller-supplied time, a source, a message and an enabled flag.
- [Update product](https://docs.hanzo.ai/docs/openapi/commerce/patch-commerce-product-by-productid.md): A product is a sellable catalog item: slug, SKU and UPC, name and copy, media, availability and preorder flags, a reservation block, and its money — currency, price, MSRP, list price and inventory cost in minor units, inventory count, taxability, and the subscription interval when it is subscribeable.
- [Update return](https://docs.hanzo.ai/docs/openapi/commerce/patch-commerce-return-by-returnid.md): A return is an RMA — the store, user and order it belongs to, the line items coming back, a fulfillment block carrying its own type, status and pricing, a summary, and eight lifecycle timestamps from submitted through delivered and processed.
- [Update saleschannel](https://docs.hanzo.ai/docs/openapi/commerce/patch-commerce-saleschannel-by-saleschannelid.md): A sales channel is a named selling surface — a name, a description, a disabled flag and metadata.
- [Update stocklocation](https://docs.hanzo.ai/docs/openapi/commerce/patch-commerce-stocklocation-by-stocklocationid.md): A stock location is a physical address inventory can be held at — a name, street lines, city, province, country, postal code and a phone.
- [Update store](https://docs.hanzo.ai/docs/openapi/commerce/patch-commerce-store-by-storeid.md): Loads the stored store and decodes the body over it, so only the fields the body names change and everything else keeps its stored value — the difference from the full replace, which clears what it is not told.
- [Update listing](https://docs.hanzo.ai/docs/openapi/commerce/patch-commerce-store-by-storeid-listing-by-key.md): Requires the key to already be present — an absent one is 404 — and answers the store's listing map at 200.
- [Update submission](https://docs.hanzo.ai/docs/openapi/commerce/patch-commerce-submission-by-submissionid.md): A submission is one filled-in form from a site visitor — an email, an optional user id, the client details the server observed (user agent, referer, geography) and the form's own fields as free metadata.
- [Update subscriber](https://docs.hanzo.ai/docs/openapi/commerce/patch-commerce-subscriber-by-subscriberid.md): A subscriber is a mailing-list member — name, email, the form id that captured them, unsubscribed state and date, client details, tags and metadata.
- [Update tokentransaction](https://docs.hanzo.ai/docs/openapi/commerce/patch-commerce-tokentransaction-by-tokentransactionid.md): A token transaction records a transfer between two identified parties — amount and fees, a timestamp, sending and receiving addresses, names, user ids, states and countries, a flag per side, a protocol name and a transaction hash.
- [Update transfer](https://docs.hanzo.ai/docs/openapi/commerce/patch-commerce-transfer-by-transferid.md): A transfer records that a payable WAS PAID — the annotation a human writes after paying out of band.
- [Update variant](https://docs.hanzo.ai/docs/openapi/commerce/patch-commerce-variant-by-variantid.md): A variant is one purchasable SKU of a product — its product id, SKU and UPC, name, media, availability, the option name and value pairs that distinguish it, a sold counter, and its own money and stock: currency, price, MSRP, inventory cost, inventory count and taxability.
- [Update wallet](https://docs.hanzo.ai/docs/openapi/commerce/patch-commerce-wallet-by-walletid.md): A wallet is a container of custodial blockchain accounts, and its only field is that account list — each account carrying a name, an address, a chain type, and the ENCRYPTED private key with its salt.
- [Update watchlist](https://docs.hanzo.ai/docs/openapi/commerce/patch-commerce-watchlist-by-watchlistid.md): A watchlist is a viewer's saved list of movies — a user id, an email, and the movies themselves.
- [Update webhook](https://docs.hanzo.ai/docs/openapi/commerce/patch-commerce-webhook-by-webhookid.md): A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY.
- [Create models](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-catalog-models.md): Takes a batch of model rows and upserts each one's upstream COST and machine-observable facts, answering what was created and changed.
- [Refresh models](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-catalog-models-refresh.md): Pulls the upstream model list and lands it through the same upsert the push endpoint uses, so the rule that a sync owns cost and an administrator owns price holds no matter which endpoint a row came through.
- [Create collection — POST /v1/commerce/collection](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-collection.md): A collection is a merchandising group a storefront renders — a slug and name, copy and media, flat lists of the product and variant ids it holds, published, preorder and out-of-stock flags, and an availability window.
- [Create collection — POST /v1/commerce/collection/{collectionid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-collection-by-collectionid.md): A collection is a merchandising group a storefront renders — a slug and name, copy and media, flat lists of the product and variant ids it holds, published, preorder and out-of-stock flags, and an availability window.
- [Create disclosure — POST /v1/commerce/disclosure](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-disclosure.md): A disclosure is a published-document record — a publication body, a content hash, a type and a named receiver.
- [Create disclosure — POST /v1/commerce/disclosure/{disclosureid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-disclosure-by-disclosureid.md): A disclosure is a published-document record — a publication body, a content hash, a type and a named receiver.
- [Create discount — POST /v1/commerce/discount](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-discount.md): A discount is a price rule: a type (flat, percent, free-shipping, free-item or bulk), a window, a scope naming the store, collection, product or variant it applies to, a target, and rules pairing a trigger — a price or quantity threshold — with an action, an amount off or a percentage.
- [Create discount — POST /v1/commerce/discount/{discountid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-discount-by-discountid.md): A discount is a price rule: a type (flat, percent, free-shipping, free-item or bulk), a window, a scope naming the store, collection, product or variant it applies to, a target, and rules pairing a trigger — a price or quantity threshold — with an action, an amount off or a percentage.
- [Create movie — POST /v1/commerce/movie](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-movie.md): A movie is a film catalog record — a slug plus EIDR and IMDB ids, all three required, with title and synopsis copy, artwork, screenshots, trailers, cast and crew, and available and hidden flags.
- [Create movie — POST /v1/commerce/movie/{movieid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-movie-by-movieid.md): A movie is a film catalog record — a slug plus EIDR and IMDB ids, all three required, with title and synopsis copy, artwork, screenshots, trailers, cast and crew, and available and hidden flags.
- [Create note — POST /v1/commerce/note](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-note.md): A note is a timestamped free-text log line — a caller-supplied time, a source, a message and an enabled flag.
- [Create note — POST /v1/commerce/note/{noteid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-note-by-noteid.md): A note is a timestamped free-text log line — a caller-supplied time, a source, a message and an enabled flag.
- [Create product — POST /v1/commerce/product](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-product.md): A product is a sellable catalog item: slug, SKU and UPC, name and copy, media, availability and preorder flags, a reservation block, and its money — currency, price, MSRP, list price and inventory cost in minor units, inventory count, taxability, and the subscription interval when it is subscribeable.
- [Create product — POST /v1/commerce/product/{productid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-product-by-productid.md): A product is a sellable catalog item: slug, SKU and UPC, name and copy, media, availability and preorder flags, a reservation block, and its money — currency, price, MSRP, list price and inventory cost in minor units, inventory count, taxability, and the subscription interval when it is subscribeable.
- [Create return — POST /v1/commerce/return](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-return.md): A return is an RMA — the store, user and order it belongs to, the line items coming back, a fulfillment block carrying its own type, status and pricing, a summary, and eight lifecycle timestamps from submitted through delivered and processed.
- [Create return — POST /v1/commerce/return/{returnid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-return-by-returnid.md): A return is an RMA — the store, user and order it belongs to, the line items coming back, a fulfillment block carrying its own type, status and pricing, a summary, and eight lifecycle timestamps from submitted through delivered and processed.
- [Create saleschannel — POST /v1/commerce/saleschannel](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-saleschannel.md): A sales channel is a named selling surface — a name, a description, a disabled flag and metadata.
- [Create saleschannel — POST /v1/commerce/saleschannel/{saleschannelid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-saleschannel-by-saleschannelid.md): A sales channel is a named selling surface — a name, a description, a disabled flag and metadata.
- [Create stocklocation — POST /v1/commerce/stocklocation](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-stocklocation.md): A stock location is a physical address inventory can be held at — a name, street lines, city, province, country, postal code and a phone.
- [Create stocklocation — POST /v1/commerce/stocklocation/{stocklocationid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-stocklocation-by-stocklocationid.md): A stock location is a physical address inventory can be held at — a name, street lines, city, province, country, postal code and a phone.
- [Create store — POST /v1/commerce/store](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-store.md): Creates a store from the body inside the caller org's own namespaced database, so the row is physically isolated to that tenant from its first write, and answers it at 201 with a Location header naming its id.
- [Create store — POST /v1/commerce/store/{storeid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-store-by-storeid.md): Re-dispatches the request into the handler the intended verb would have reached, taking that verb from a _method form value or query parameter and then from the X-HTTP-Method-Override header, the header winning when both are present.
- [Create authorize — POST /v1/commerce/store/{storeid}/authorize](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-store-by-storeid-authorize.md): Tallies a new order for the addressed store from the user, payment and order body, reserves its items, runs the processor authorization and answers the saved order with a Location header pointing at it.
- [Create authorize — POST /v1/commerce/store/{storeid}/authorize/{orderid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-store-by-storeid-authorize-by-orderid.md): Continues the order named in the path rather than minting a new one, holding funds for it.
- [Create capture — POST /v1/commerce/store/{storeid}/capture/{orderid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-store-by-storeid-capture-by-orderid.md): Settles the order named in the path — the second half of the two-step flow — and answers the updated order with a Location header.
- [Create charge — POST /v1/commerce/store/{storeid}/charge](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-store-by-storeid-charge.md): Runs authorization and capture back to back against a freshly created order — the one-step flow for callers with no reason to hold funds.
- [Create authorize — POST /v1/commerce/store/{storeid}/checkout/authorize](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-store-by-storeid-checkout-authorize.md): Authorizes a new order for the addressed store and holds the funds, answering the saved order with a Location header.
- [Create authorize — POST /v1/commerce/store/{storeid}/checkout/authorize/{orderid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-store-by-storeid-checkout-authorize-by-orderid.md): Continues the order named in the path rather than minting one, and shares its handler byte for byte with the unprefixed authorize-by-id address.
- [Create capture — POST /v1/commerce/store/{storeid}/checkout/capture/{orderid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-store-by-storeid-checkout-capture-by-orderid.md): Settles the authorized order named in the path and answers the updated order with a Location header, running the same handler as the unprefixed capture address.
- [Create charge — POST /v1/commerce/store/{storeid}/checkout/charge](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-store-by-storeid-checkout-charge.md): Performs authorization and capture back to back against a newly created order for the addressed store, on the same handler as the unprefixed charge address.
- [Create cancel — POST /v1/commerce/store/{storeid}/checkout/paypal/cancel/{payKey}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-store-by-storeid-checkout-paypal-cancel-by-paykey.md): Meant to void the payments carrying the given pay key, stamp them cancelled and cancel the order, but the shared checkout handler resolves its order from an ORDER ID path parameter this route does not carry.
- [Create confirm — POST /v1/commerce/store/{storeid}/checkout/paypal/confirm/{payKey}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-store-by-storeid-checkout-paypal-confirm-by-paykey.md): Meant to mark the payments carrying the given pay key as paid and set the order to paid, it cannot reach that work from this address: the shared checkout handler takes its order from an ORDER ID path parameter this route does not carry, so the order is always fresh and untyped and the confirm dispatch refuses with 400 before the pay key is queried.
- [Create pay — POST /v1/commerce/store/{storeid}/checkout/paypal/pay](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-store-by-storeid-checkout-paypal-pay.md): Begins a PayPal authorization by running the ordinary store authorize flow, since the route binds that exact handler — body, store resolution, tally, reservations and failure behaviour are the authorize address's, unchanged.
- [Create listing](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-store-by-storeid-listing-by-key.md): Creates the override and answers the store's ENTIRE listing map at 201 with a Location header — not just the entry that was added.
- [Create cancel — POST /v1/commerce/store/{storeid}/paypal/cancel/{payKey}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-store-by-storeid-paypal-cancel-by-paykey.md): Intended to void the payments carrying the given pay key, stamp them cancelled and cancel the order, it never reaches that work: the shared checkout handler reads its order from an ORDER ID path parameter this route does not carry, leaving an untyped order that the cancel dispatch refuses with 400 before the pay key lookup runs.
- [Create confirm — POST /v1/commerce/store/{storeid}/paypal/confirm/{payKey}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-store-by-storeid-paypal-confirm-by-paykey.md): Intended to mark every payment carrying the given pay key as paid and flip the order to paid, it cannot do that from this address and does not pretend to: the shared checkout handler resolves its order from an ORDER ID path parameter that this route does not carry, so it always works against a fresh untyped order and the confirm dispatch refuses it with 400 before the pay key is ever queried.
- [Create pay — POST /v1/commerce/store/{storeid}/paypal/pay](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-store-by-storeid-paypal-pay.md): Runs the ordinary store authorize flow — the route binds that very handler, so the body, the store resolution, the tally, the reservations and the failure behaviour are the authorize address's, unchanged.
- [Create trial](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-store-by-storeid-trial.md): Creates a trialing subscription for the addressed store on the entry plan and grants that plan's trial credit, answering 201 when this call actually started one and 200 with a reason otherwise — not_new when the store already has billing history, trial_not_configured when no entry plan is wired.
- [Create token](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-store-token.md): Answers a freshly minted token carrying ONLY the published-read permission — enough for a logged-out shopper's storefront to read your published catalog and nothing more, with no write and no admin scope.
- [Create submission — POST /v1/commerce/submission](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-submission.md): A submission is one filled-in form from a site visitor — an email, an optional user id, the client details the server observed (user agent, referer, geography) and the form's own fields as free metadata.
- [Create submission — POST /v1/commerce/submission/{submissionid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-submission-by-submissionid.md): A submission is one filled-in form from a site visitor — an email, an optional user id, the client details the server observed (user agent, referer, geography) and the form's own fields as free metadata.
- [Create subscriber — POST /v1/commerce/subscriber](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-subscriber.md): A subscriber is a mailing-list member — name, email, the form id that captured them, unsubscribed state and date, client details, tags and metadata.
- [Create subscriber — POST /v1/commerce/subscriber/{subscriberid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-subscriber-by-subscriberid.md): A subscriber is a mailing-list member — name, email, the form id that captured them, unsubscribed state and date, client details, tags and metadata.
- [Create tokentransaction — POST /v1/commerce/tokentransaction](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-tokentransaction.md): A token transaction records a transfer between two identified parties — amount and fees, a timestamp, sending and receiving addresses, names, user ids, states and countries, a flag per side, a protocol name and a transaction hash.
- [Create tokentransaction — POST /v1/commerce/tokentransaction/{tokentransactionid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-tokentransaction-by-tokentransactionid.md): A token transaction records a transfer between two identified parties — amount and fees, a timestamp, sending and receiving addresses, names, user ids, states and countries, a flag per side, a protocol name and a transaction hash.
- [Create transfer — POST /v1/commerce/transfer](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-transfer.md): A transfer records that a payable WAS PAID — the annotation a human writes after paying out of band.
- [Create transfer — POST /v1/commerce/transfer/{transferid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-transfer-by-transferid.md): A transfer records that a payable WAS PAID — the annotation a human writes after paying out of band.
- [Create variant — POST /v1/commerce/variant](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-variant.md): A variant is one purchasable SKU of a product — its product id, SKU and UPC, name, media, availability, the option name and value pairs that distinguish it, a sold counter, and its own money and stock: currency, price, MSRP, inventory cost, inventory count and taxability.
- [Create variant — POST /v1/commerce/variant/{variantid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-variant-by-variantid.md): A variant is one purchasable SKU of a product — its product id, SKU and UPC, name, media, availability, the option name and value pairs that distinguish it, a sold counter, and its own money and stock: currency, price, MSRP, inventory cost, inventory count and taxability.
- [Create wallet — POST /v1/commerce/wallet](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-wallet.md): A wallet is a container of custodial blockchain accounts, and its only field is that account list — each account carrying a name, an address, a chain type, and the ENCRYPTED private key with its salt.
- [Create wallet — POST /v1/commerce/wallet/{walletid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-wallet-by-walletid.md): A wallet is a container of custodial blockchain accounts, and its only field is that account list — each account carrying a name, an address, a chain type, and the ENCRYPTED private key with its salt.
- [Create watchlist — POST /v1/commerce/watchlist](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-watchlist.md): A watchlist is a viewer's saved list of movies — a user id, an email, and the movies themselves.
- [Create watchlist — POST /v1/commerce/watchlist/{watchlistid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-watchlist-by-watchlistid.md): A watchlist is a viewer's saved list of movies — a user id, an email, and the movies themselves.
- [Create webhook — POST /v1/commerce/webhook](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-webhook.md): A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY.
- [Create webhook — POST /v1/commerce/webhook/{webhookid}](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-webhook-by-webhookid.md): A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY.
- [Create webhooks](https://docs.hanzo.ai/docs/openapi/commerce/post-commerce-webhooks-by-provider.md): Accepts a payment provider's event, verifies it, records it for audit, and applies subscription lifecycle changes to the matching local row.
- [Replace collection](https://docs.hanzo.ai/docs/openapi/commerce/put-commerce-collection-by-collectionid.md): A collection is a merchandising group a storefront renders — a slug and name, copy and media, flat lists of the product and variant ids it holds, published, preorder and out-of-stock flags, and an availability window.
- [Replace disclosure](https://docs.hanzo.ai/docs/openapi/commerce/put-commerce-disclosure-by-disclosureid.md): A disclosure is a published-document record — a publication body, a content hash, a type and a named receiver.
- [Replace discount](https://docs.hanzo.ai/docs/openapi/commerce/put-commerce-discount-by-discountid.md): A discount is a price rule: a type (flat, percent, free-shipping, free-item or bulk), a window, a scope naming the store, collection, product or variant it applies to, a target, and rules pairing a trigger — a price or quantity threshold — with an action, an amount off or a percentage.
- [Replace movie](https://docs.hanzo.ai/docs/openapi/commerce/put-commerce-movie-by-movieid.md): A movie is a film catalog record — a slug plus EIDR and IMDB ids, all three required, with title and synopsis copy, artwork, screenshots, trailers, cast and crew, and available and hidden flags.
- [Replace note](https://docs.hanzo.ai/docs/openapi/commerce/put-commerce-note-by-noteid.md): A note is a timestamped free-text log line — a caller-supplied time, a source, a message and an enabled flag.
- [Replace product](https://docs.hanzo.ai/docs/openapi/commerce/put-commerce-product-by-productid.md): A product is a sellable catalog item: slug, SKU and UPC, name and copy, media, availability and preorder flags, a reservation block, and its money — currency, price, MSRP, list price and inventory cost in minor units, inventory count, taxability, and the subscription interval when it is subscribeable.
- [Replace return](https://docs.hanzo.ai/docs/openapi/commerce/put-commerce-return-by-returnid.md): A return is an RMA — the store, user and order it belongs to, the line items coming back, a fulfillment block carrying its own type, status and pricing, a summary, and eight lifecycle timestamps from submitted through delivered and processed.
- [Replace saleschannel](https://docs.hanzo.ai/docs/openapi/commerce/put-commerce-saleschannel-by-saleschannelid.md): A sales channel is a named selling surface — a name, a description, a disabled flag and metadata.
- [Replace stocklocation](https://docs.hanzo.ai/docs/openapi/commerce/put-commerce-stocklocation-by-stocklocationid.md): A stock location is a physical address inventory can be held at — a name, street lines, city, province, country, postal code and a phone.
- [Replace store](https://docs.hanzo.ai/docs/openapi/commerce/put-commerce-store-by-storeid.md): This is a true REPLACEMENT, not a merge: the stored key is preserved but the body is decoded onto a fresh entity, so every field the body omits is written back as its zero value.
- [Replace listing](https://docs.hanzo.ai/docs/openapi/commerce/put-commerce-store-by-storeid-listing-by-key.md): Decodes the body over the existing listing when the key is present, so fields it omits keep their stored values, and builds the listing from the body alone when the key is new.
- [Replace submission](https://docs.hanzo.ai/docs/openapi/commerce/put-commerce-submission-by-submissionid.md): A submission is one filled-in form from a site visitor — an email, an optional user id, the client details the server observed (user agent, referer, geography) and the form's own fields as free metadata.
- [Replace subscriber](https://docs.hanzo.ai/docs/openapi/commerce/put-commerce-subscriber-by-subscriberid.md): A subscriber is a mailing-list member — name, email, the form id that captured them, unsubscribed state and date, client details, tags and metadata.
- [Replace tokentransaction](https://docs.hanzo.ai/docs/openapi/commerce/put-commerce-tokentransaction-by-tokentransactionid.md): A token transaction records a transfer between two identified parties — amount and fees, a timestamp, sending and receiving addresses, names, user ids, states and countries, a flag per side, a protocol name and a transaction hash.
- [Replace transfer](https://docs.hanzo.ai/docs/openapi/commerce/put-commerce-transfer-by-transferid.md): A transfer records that a payable WAS PAID — the annotation a human writes after paying out of band.
- [Replace variant](https://docs.hanzo.ai/docs/openapi/commerce/put-commerce-variant-by-variantid.md): A variant is one purchasable SKU of a product — its product id, SKU and UPC, name, media, availability, the option name and value pairs that distinguish it, a sold counter, and its own money and stock: currency, price, MSRP, inventory cost, inventory count and taxability.
- [Replace wallet](https://docs.hanzo.ai/docs/openapi/commerce/put-commerce-wallet-by-walletid.md): A wallet is a container of custodial blockchain accounts, and its only field is that account list — each account carrying a name, an address, a chain type, and the ENCRYPTED private key with its salt.
- [Replace watchlist](https://docs.hanzo.ai/docs/openapi/commerce/put-commerce-watchlist-by-watchlistid.md): A watchlist is a viewer's saved list of movies — a user id, an email, and the movies themselves.
- [Replace webhook](https://docs.hanzo.ai/docs/openapi/commerce/put-commerce-webhook-by-webhookid.md): A webhook is a merchant-registered endpoint that receives commerce event callbacks — a name, a URL, live and all flags, a per-event map, an enabled flag, and the shared access token each delivery posts IN THE BODY.
- [Create item](https://docs.hanzo.ai/docs/openapi/commerce/setcartitem.md): Sets how many of one item a cart holds, and answers the whole updated cart.
- [Company](https://docs.hanzo.ai/docs/openapi/company.md): Incorporation end to end: pick a structure, add founders, pay, file, and e-sign.
- [List company](https://docs.hanzo.ai/docs/openapi/company/get-company.md): Returns the caller org's formation and the stages reachable from it, or 404 when the org has not begun one.
- [List register](https://docs.hanzo.ai/docs/openapi/company/get-company-register.md): Returns the platform's whole formation register, newest activity first — every org's formation, not the caller's.
- [List summary](https://docs.hanzo.ai/docs/openapi/company/get-company-register-summary.md): Counts the platform's formations by stage — the register's shape in one read, so a queue that is growing is visible as a number rather than inferred by paging the list.
- [List review](https://docs.hanzo.ai/docs/openapi/company/get-company-review.md): Reports the founders whose KYC is not yet settled, oldest formation first, so the queue drains in the order founders have been waiting.
- [Create company](https://docs.hanzo.ai/docs/openapi/company/post-company.md): Starts the org's one formation and returns it with the stages reachable from it.
- [Create advance](https://docs.hanzo.ai/docs/openapi/company/post-company-advance.md): Runs the ONE guarded transition of the formation machine.
- [Create documents — POST /v1/company/documents](https://docs.hanzo.ai/docs/openapi/company/post-company-documents.md): Renders the formation documents for the chosen structure and jurisdiction, ingests each into the org's data room, and submits the state filing through the filing client.
- [Create ein](https://docs.hanzo.ai/docs/openapi/company/post-company-ein.md): Opens the EIN application and answers what it owes.
- [Create esign](https://docs.hanzo.ai/docs/openapi/company/post-company-esign.md): Sends the generated formation documents for signature by every founder and records the provider's reference on the formation.
- [Complete esign](https://docs.hanzo.ai/docs/openapi/company/post-company-esign-complete.md): Records whether the formation documents have been signed.
- [Create founders](https://docs.hanzo.ai/docs/openapi/company/post-company-founders.md): Replaces the formation's founders.
- [Create deck](https://docs.hanzo.ai/docs/openapi/company/post-company-fundraise-deck.md): Stores the request body as a document in the caller org's data room and answers with the data room id to reference it by.
- [Create round](https://docs.hanzo.ai/docs/openapi/company/post-company-fundraise-round.md): Records a fundraising round on the org's canonical cap table.
- [Create safe](https://docs.hanzo.ai/docs/openapi/company/post-company-fundraise-safe.md): Raises an e-signature request over documents already in the org's data room — a SAFE, a convertible note, or any other fundraising paper.
- [Create genesis](https://docs.hanzo.ai/docs/openapi/company/post-company-genesis.md): Seeds the canonical cap table with the founding allocation (stakeholders, a common share class, issued shares) and anchors the deterministic equity-genesis root on-chain.
- [Create captable](https://docs.hanzo.ai/docs/openapi/company/post-company-import-captable.md): Reads an existing company's cap table from a Google Sheet and adds its stakeholders to the canonical cap table.
- [Create documents — POST /v1/company/import/documents](https://docs.hanzo.ai/docs/openapi/company/post-company-import-documents.md): Ingests an existing company's corporate documents from a Google Drive folder into the org's data room.
- [Create kyc](https://docs.hanzo.ai/docs/openapi/company/post-company-kyc.md): Opens an identity-verification session for every founder with the wired provider and records each session's reference on the formation.
- [Refresh kyc](https://docs.hanzo.ai/docs/openapi/company/post-company-kyc-refresh.md): Reconciles each pending founder's KYC with the WIRED provider — the PULL path to a provider-reported terminal status.
- [Create payment](https://docs.hanzo.ai/docs/openapi/company/post-company-payment.md): Charges the caller's own org the one-time Hanzo Company formation fee.
- [Create skip](https://docs.hanzo.ai/docs/openapi/company/post-company-skip.md): Marks the org as already incorporated and moves it onto the import path, so an existing company brings its documents and cap table in instead of forming a new entity.
- [Create tariff](https://docs.hanzo.ai/docs/openapi/company/post-company-tariff.md): Itemises what a formation costs before anyone commits to it.
- [Replace structure](https://docs.hanzo.ai/docs/openapi/company/put-company-structure.md): Records the entity kind, the state of formation and the proposed name.
- [Compliance](https://docs.hanzo.ai/docs/openapi/compliance.md): Your KYC/KYB onboarding, accreditation records, and the evidence trail behind them.
- [List accreditation](https://docs.hanzo.ai/docs/openapi/compliance/get-compliance-accreditation.md): Returns the org's tracked accreditation-state records, newest first — evidence entries the org keeps, never a platform certification.
- [Get accreditation](https://docs.hanzo.ai/docs/openapi/compliance/get-compliance-accreditation-by-id.md): Returns one tracked accreditation record.
- [List audit](https://docs.hanzo.ai/docs/openapi/compliance/get-compliance-audit.md): The compliance read of the SHARED tamper-evident audit plane — the SOC 2 posture surface (privileged actions: who started/decided what, when).
- [List health](https://docs.hanzo.ai/docs/openapi/compliance/get-compliance-health.md): Reports subsystem liveness and the wired verification provider.
- [List records](https://docs.hanzo.ai/docs/openapi/compliance/get-compliance-records.md): The unified compliance-record view for the org: its verifications and accreditation records together, each provider-reported or tracked, never platform-asserted.
- [List status](https://docs.hanzo.ai/docs/openapi/compliance/get-compliance-status.md): The org's honest posture read: the wired provider and the per-status tally of its verifications.
- [List subjects](https://docs.hanzo.ai/docs/openapi/compliance/get-compliance-subjects.md): Returns the org's subjects as PII-MINIMIZED summaries — no name or email, only whether an email is on file.
- [Get subjects](https://docs.hanzo.ai/docs/openapi/compliance/get-compliance-subjects-by-id.md): Returns one subject WITH its contact PII — the only surface that returns it, and only to the owning org.
- [List verifications](https://docs.hanzo.ai/docs/openapi/compliance/get-compliance-verifications.md): Returns the org's KYC/KYB verifications, newest first — opaque subject references and provider-reported statuses only, no subject PII.
- [Get verifications](https://docs.hanzo.ai/docs/openapi/compliance/get-compliance-verifications-by-id.md): Returns one verification — its opaque subject reference and provider-reported status, no subject PII.
- [Create accreditation](https://docs.hanzo.ai/docs/openapi/compliance/post-compliance-accreditation.md): Records an ASSERTED accreditation state for a subject — the subject's own assertion, with no verifier.
- [Create decision — POST /v1/compliance/accreditation/{id}/decision](https://docs.hanzo.ai/docs/openapi/compliance/post-compliance-accreditation-by-id-decision.md): Records an org reviewer's decision on an accreditation record — a reviewer confirmation, a provider verification the reviewer has evidence of (a CPA/attorney letter, a verifier report), a rejection, or an expiry.
- [Create subjects](https://docs.hanzo.ai/docs/openapi/compliance/post-compliance-subjects.md): Records a party the org is verifying as part of its own onboarding/compliance — a team member, vendor, customer, or counterparty.
- [Create verifications](https://docs.hanzo.ai/docs/openapi/compliance/post-compliance-verifications.md): Begins a KYC/KYB verification of a subject through the wired provider — an existing subject by id, or one created inline from the request.
- [Create decision — POST /v1/compliance/verifications/{id}/decision](https://docs.hanzo.ai/docs/openapi/compliance/post-compliance-verifications-by-id-decision.md): Records a privileged reviewer's MANUAL decision on a verification — the human-in-the-loop path, and the ONLY route to a passing status when no real provider is wired.
- [Refresh verifications](https://docs.hanzo.ai/docs/openapi/compliance/post-compliance-verifications-by-id-refresh.md): Polls the wired provider for its current decision and records it, ATTRIBUTED to the provider — the internal PULL reconcile.
- [Create webhook](https://docs.hanzo.ai/docs/openapi/compliance/post-compliance-verifications-webhook.md): The external PUSH reconcile: a verification provider (or a Hanzo relay) signals that a check settled, and the reconciled check comes back.
- [Compute](https://docs.hanzo.ai/docs/openapi/compute.md): The compute you rent from Hanzo: machines, GPUs and clusters — launch one, resize it, tear it down.
- [Create clusters — POST /v1/compute/clusters](https://docs.hanzo.ai/docs/openapi/compute/attachcluster.md): Attaches a BYO cluster to the caller's org — the kubeconfig is validated, KMS-sealed and added to the fleet — and answers 201 with the cluster as it now appears on GET /v1/compute/clusters.
- [Replace agent](https://docs.hanzo.ai/docs/openapi/compute/bindmachineagent.md): Binds a cloud Agent to one of the caller org's machines: the machine is recorded as running that Agent's @hanzo/bot runtime.
- [Cancel jobs](https://docs.hanzo.ai/docs/openapi/compute/cancelfleetjob.md): Cancels a queued or running render in the caller's org.
- [Create clusters — POST /v1/compute/k8s/clusters](https://docs.hanzo.ai/docs/openapi/compute/createkubernetescluster.md): Provisions a DOKS cluster for the caller's org and answers 201.
- [Create pools](https://docs.hanzo.ai/docs/openapi/compute/createnodepool.md): Adds a node pool to one of the caller org's clusters and answers 201 with the created pool.
- [Delete clusters — DELETE /v1/compute/k8s/clusters/{id}](https://docs.hanzo.ai/docs/openapi/compute/deletekubernetescluster.md): Destroys a DOKS cluster by id and answers 204.
- [Delete machines](https://docs.hanzo.ai/docs/openapi/compute/deletemachine.md): Terminates one of the caller org's machines.
- [Delete pools](https://docs.hanzo.ai/docs/openapi/compute/deletenodepool.md): Removes a node pool from one of the caller org's clusters.
- [Delete clusters — DELETE /v1/compute/clusters/{id}](https://docs.hanzo.ai/docs/openapi/compute/detachcluster.md): Removes a BYO cluster from the caller org's fleet.
- [List regions](https://docs.hanzo.ai/docs/openapi/compute/get-compute-regions.md): Lists the regions a machine can be launched in.
- [List sizes](https://docs.hanzo.ai/docs/openapi/compute/get-compute-sizes.md): Lists the machine sizes available to launch, with their specifications.
- [Get clusters](https://docs.hanzo.ai/docs/openapi/compute/getkubernetescluster.md): Returns one cluster's detail: node pools + worker nodes.
- [Get machines](https://docs.hanzo.ai/docs/openapi/compute/getmachine.md): Returns one of the caller org's machines by its org-scoped name.
- [List agent](https://docs.hanzo.ai/docs/openapi/compute/getmachineagent.md): Returns the agent binding of one of the caller org's machines, or 404 when the machine runs no bot runtime.
- [List clusters — GET /v1/compute/clusters](https://docs.hanzo.ai/docs/openapi/compute/listclusters.md): Returns the caller org's clusters from both sources: the managed clusters projected from Visor's node pools, and the BYO clusters attached to the caller's project.
- [List fleet](https://docs.hanzo.ai/docs/openapi/compute/listfleet.md): Returns every compute unit the caller's org has, from every source, each carrying its latest utilization: agent run-targets, the BYO machines that dialed in, attached BYO clusters and Visor-provisioned machines.
- [List jobs](https://docs.hanzo.ai/docs/openapi/compute/listfleetjobs.md): Returns the caller org's gpu-jobs render queue, each row tagged with the GPU it targets (empty = the shared any-GPU lane) and the node claiming it, optionally narrowed to one GPU's queue and/or one status.
- [List samples](https://docs.hanzo.ai/docs/openapi/compute/listfleetsamples.md): Returns the caller org's utilization series, oldest first.
- [List workers](https://docs.hanzo.ai/docs/openapi/compute/listfleetworkers.md): Returns the caller org's BYO machines — the ones that dialed in via `hanzo link` — with everything each host reported about itself.
- [List alerts](https://docs.hanzo.ai/docs/openapi/compute/listgpualerts.md): An HONEST empty surface: Visor exposes no GPU alert inventory, so this returns [] rather than fabricating alerts.
- [List gpus](https://docs.hanzo.ai/docs/openapi/compute/listgpus.md): Returns one row per physical accelerator the caller's org has, derived from its real GPU machines (the size slug says how many cards a node holds) and from the accelerators BYO workers report through nvidia-smi.
- [List clusters — GET /v1/compute/k8s/clusters](https://docs.hanzo.ai/docs/openapi/compute/listkubernetesclusters.md): Lists the org's DOKS clusters (Visor, house account) folded with the org's BYO clusters — ONE fleet cluster view under the unified k8s noun.
- [List nodes](https://docs.hanzo.ai/docs/openapi/compute/listkubernetesnodes.md): Returns every DOKS worker node in the org's clusters as a machine — the SAME set the fleet folds in (managedMachines), exposed directly under the k8s noun.
- [List agents](https://docs.hanzo.ai/docs/openapi/compute/listmachineagents.md): Returns every agent↔machine binding in the caller's org — which machines are running which cloud Agent, with vm's own reconciled status.
- [List machines](https://docs.hanzo.ai/docs/openapi/compute/listmachines.md): Returns every machine the caller's org has — Visor's registry, the live DigitalOcean droplets and the DOKS worker nodes (deduped into one union), plus the BYO machines that dialed in via `hanzo link` (provider "byo").
- [Create machines — POST /v1/compute/machines](https://docs.hanzo.ai/docs/openapi/compute/post-compute-machines.md): Provisions a machine owned by the caller's org and answers 201 with the machine.
- [Create machines — POST /v1/compute/machines/{id}/{action}](https://docs.hanzo.ai/docs/openapi/compute/post-compute-machines-by-id-by-action.md): Dispatches one verb against a bot the caller's org owns.
- [Create samples](https://docs.hanzo.ai/docs/openapi/compute/recordfleetsample.md): Records a BYO worker's live GPU utilization into the SAME series the fleet board overlays.
- [Create scale](https://docs.hanzo.ai/docs/openapi/compute/scalenodepool.md): Resizes a node pool to an absolute node count and returns the pool as Visor reports it after the change.
- [Delete agent](https://docs.hanzo.ai/docs/openapi/compute/unbindmachineagent.md): Detaches the agent runtime from one of the caller org's machines.
- [Content](https://docs.hanzo.ai/docs/openapi/content.md): Marketing content from draft to published, on every channel.
- [List board](https://docs.hanzo.ai/docs/openapi/content/get-content-board.md): Aggregates the caller org's marketing content across every publishable content type into ONE queue board — the cross-type read the framework's per-DocType list cannot give.
- [List channels](https://docs.hanzo.ai/docs/openapi/content/get-content-channels.md): Lists the distribution channels the caller's org has connected — the social integrations a publish can target.
- [List lifecycle](https://docs.hanzo.ai/docs/openapi/content/get-content-lifecycle.md): Returns the ONE marketing-content state machine: the ordered lifecycle states, which state a fresh document starts in, which one is publicly live, and the legal successors of every state.
- [Create transition](https://docs.hanzo.ai/docs/openapi/content/post-content-by-doctype-by-name-transition.md): Moves one content item to a new lifecycle state and, on the move to published, fans it out to the item's channels.
- [Create generate](https://docs.hanzo.ai/docs/openapi/content/post-content-generate.md): Draft a provider of marketing content and file it in the CMS as a draft.
- [Publish content](https://docs.hanzo.ai/docs/openapi/content/post-content-publish.md): Distributes one CMS content item to the channels recorded on it and returns the honest per-channel outcome.
- [Crawl](https://docs.hanzo.ai/docs/openapi/crawl.md): Any web page turned into clean markdown a model can read.
- [Create crawl](https://docs.hanzo.ai/docs/openapi/crawl/read-page.md): Reads one URL and answers with the page as markdown.
- [Dataroom](https://docs.hanzo.ai/docs/openapi/dataroom.md): A secure document room you share by link and watch page by page.
- [Get dataroom](https://docs.hanzo.ai/docs/openapi/dataroom/get-dataroom-analytics-dataroom-by-dataroomid.md): Rolls up every share link pointing at one data room: session and page-view totals for the room, plus the per-page breakdown for each link beneath it.
- [Get link](https://docs.hanzo.ai/docs/openapi/dataroom/get-dataroom-analytics-link-by-linkid.md): Reports how one share link was actually read: total viewing sessions, total page views, and per page the view count, the summed dwell measure and its average.
- [List datarooms](https://docs.hanzo.ai/docs/openapi/dataroom/get-dataroom-datarooms.md): Returns every data room in the caller org's own store, newest first, with its short public id, name, description and timestamps.
- [Get datarooms](https://docs.hanzo.ai/docs/openapi/dataroom/get-dataroom-datarooms-by-id.md): Reads one of the caller org's data rooms together with every document in it, each carrying its membership id and order index.
- [List documents](https://docs.hanzo.ai/docs/openapi/dataroom/get-dataroom-documents.md): Returns every document in the caller org's own store, newest first — name, opaque storage key, content type, page count, size and timestamps.
- [Get documents](https://docs.hanzo.ai/docs/openapi/dataroom/get-dataroom-documents-by-id.md): Reads one of the caller org's documents — its name, opaque storage key, content type, page count, size and timestamps.
- [List file — GET /v1/dataroom/documents/{id}/file](https://docs.hanzo.ai/docs/openapi/dataroom/get-dataroom-documents-by-id-file.md): Streams the stored file back under the type read from its BYTES — a raster image or a PDF renders in place, and anything else is served as application/octet-stream with an attachment disposition, so a stored file never executes as markup in this origin.
- [List health](https://docs.hanzo.ai/docs/openapi/dataroom/get-dataroom-health.md): Reports that the data room subsystem is up.
- [List links](https://docs.hanzo.ai/docs/openapi/dataroom/get-dataroom-links.md): Returns every live share link in the caller org's own store, newest first, with the controls a visitor will meet: whether an address is required, whether a password is set, the allow and deny lists, whether download is permitted, and when the link expires.
- [List trust](https://docs.hanzo.ai/docs/openapi/dataroom/get-dataroom-trust.md): Answers the caller org's OWN trust centre: its settings, every item it holds in both tiers, the requests waiting on it, and the grants it has made.
- [Get center](https://docs.hanzo.ai/docs/openapi/dataroom/get-dataroom-trust-center-by-slug.md): Answers an org's public trust centre: its name, the text a party must accept to ask for a document, and every item it publishes.
- [Get file](https://docs.hanzo.ai/docs/openapi/dataroom/get-dataroom-trust-center-by-slug-file-by-item.md): Streams the file behind an item a trust centre publishes openly — a policy, a filled questionnaire, a knowledge-base attachment — under the type read from its bytes: a picture or a PDF renders in place, anything else downloads inert.
- [Get view](https://docs.hanzo.ai/docs/openapi/dataroom/get-dataroom-view-by-linkid.md): Answers the pre-auth face of a link to anyone holding its id: name and type, which gates apply (whether an address is required, whether a password is set), whether download is permitted, whether it has expired, and the name and description of the room behind it — or, for a single-document link, that document's name and page count.
- [List file — GET /v1/dataroom/view/{linkId}/document/{documentId}/file](https://docs.hanzo.ai/docs/openapi/dataroom/get-dataroom-view-by-linkid-document-by-documentid-file.md): Streams a document's bytes to a visitor holding an open viewing session, under the type read from those bytes: a picture or a PDF renders in place, anything else downloads inert.
- [Update artifacts](https://docs.hanzo.ai/docs/openapi/dataroom/patch-dataroom-trust-artifacts-by-id.md): Changes an item on the caller org's trust centre — replace its file with a newer edition, move it between public and gated, rewrite what it says, or retire it — and answers with the item as it now stands.
- [Create datarooms](https://docs.hanzo.ai/docs/openapi/dataroom/post-dataroom-datarooms.md): Opens a new data room for the caller org and answers with it, including the short public id it is addressed by.
- [Create documents — POST /v1/dataroom/datarooms/{id}/documents](https://docs.hanzo.ai/docs/openapi/dataroom/post-dataroom-datarooms-by-id-documents.md): Puts an already-uploaded document into one of the caller org's data rooms and answers with the new membership id.
- [Create documents — POST /v1/dataroom/documents](https://docs.hanzo.ai/docs/openapi/dataroom/post-dataroom-documents.md): Takes the file ITSELF as the raw request body — not a JSON envelope, not multipart — stores it on the object-storage client, and records the metadata row, answering with the new document.
- [Create links](https://docs.hanzo.ai/docs/openapi/dataroom/post-dataroom-links.md): Grants access: it mints a public share link over one data room (`dataroomId`) or one document (`documentId`) — one of the two is required — and answers with the link, whose `id` is the token a visitor opens it with.
- [Create artifacts](https://docs.hanzo.ai/docs/openapi/dataroom/post-dataroom-trust-artifacts.md): Puts an item on the caller org's trust centre and answers with it.
- [Create requests](https://docs.hanzo.ai/docs/openapi/dataroom/post-dataroom-trust-center-by-slug-requests.md): Records a request to read what an independent auditor signed, and answers with its id.
- [Create grant](https://docs.hanzo.ai/docs/openapi/dataroom/post-dataroom-trust-requests-by-id-grant.md): Answers a request by opening access: it mints a share link over what was asked for, addressed to the address that asked and closing at expiry, records the decision, and mails the asker.
- [Create refuse](https://docs.hanzo.ai/docs/openapi/dataroom/post-dataroom-trust-requests-by-id-refuse.md): Answers a request by declining it, recording who declined and why.
- [Create authenticate](https://docs.hanzo.ai/docs/openapi/dataroom/post-dataroom-view-by-linkid-authenticate.md): Clears the link's access controls and answers with the viewing session — a `viewId`, whether download is permitted, and the documents behind the link — which every later viewer call is authorised by.
- [Create pageview](https://docs.hanzo.ai/docs/openapi/dataroom/post-dataroom-view-by-linkid-pageview.md): Appends a single per-page analytics event — {viewId, pageNumber, documentId, versionNumber, duration} — and answers with its id.
- [Replace trust](https://docs.hanzo.ai/docs/openapi/dataroom/put-dataroom-trust.md): Opens, publishes or withdraws the caller org's trust centre and answers with the centre as it now stands.
- [Dataset](https://docs.hanzo.ai/docs/openapi/dataset.md): The per-org dataset plane of /v1/risk: a dataset is a VERSIONED, IMMUTABLE snapshot of one tenant's own event surface, and this is where it is declared, materialised, described, exported and disposed of.
- [Create dataset](https://docs.hanzo.ai/docs/openapi/dataset/riskcreatedataset.md): Declares the next version of a dataset from a bound query over this org's own feature surface.
- [Get dataset](https://docs.hanzo.ai/docs/openapi/dataset/riskdataset.md): Describes every version of one dataset, newest first — the whole history, because the point of a version is that the older ones are still there and a model fitted last quarter cites one of them.
- [List lineage](https://docs.hanzo.ai/docs/openapi/dataset/riskdatasetlineage.md): Shows where a version's rows came from and whether that can still be demonstrated.
- [List dataset](https://docs.hanzo.ai/docs/openapi/dataset/riskdatasets.md): Lists this org's datasets, each with its newest version.
- [Delete dataset](https://docs.hanzo.ai/docs/openapi/dataset/riskdeletedataset.md): Disposes of one dataset and every version of it: the rows are dropped and the register is marked with what went.
- [Export dataset](https://docs.hanzo.ai/docs/openapi/dataset/riskexportdataset.md): Reads a published version's rows back, one bounded page at a time, in the version's own stable row order.
- [Create materialize](https://docs.hanzo.ai/docs/openapi/dataset/riskmaterializedataset.md): Builds the declared version into immutable rows and answers 202 as soon as the attempt is on record.
- [Deploy](https://docs.hanzo.ai/docs/openapi/deploy.md): Hanzo CD: see what each app is running, sync it, and roll back a bad release.
- [List applications — GET /v1/deploy/applications](https://docs.hanzo.ai/docs/openapi/deploy/get-deploy-applications.md): Returns the fleet as an argocd ApplicationList: one projected Application per operator App CR, carrying the image tag the CR DECLARES, the tag actually RUNNING in the cluster's Deployment, the reconciled health, and the sync verdict those two produce (declared == running ⇒ Synced, both known and different ⇒ OutOfSync, either unknown ⇒ Unknown).
- [Get applications](https://docs.hanzo.ai/docs/openapi/deploy/get-deploy-applications-by-name.md): Returns ONE projected argocd Application by name, with status.resources filled in from its reconciled resource tree — which is what makes it the detail view rather than a row of the list.
- [List resource tree — GET /v1/deploy/applications/{name}/resource-tree](https://docs.hanzo.ai/docs/openapi/deploy/get-deploy-applications-by-name-resource-tree.md): Returns one application's argocd ApplicationTree: the objects the operator reconciled from its App CR, reached by ownerRef — the Deployment and, under it, the ReplicaSet and Pods, plus the Service, Ingress, HorizontalPodAutoscaler, PodDisruptionBudget and ConfigMaps it owns — each node carrying its parent edges and its health.
- [List metadata](https://docs.hanzo.ai/docs/openapi/deploy/get-deploy-applications-by-name-revisions-by-revision-metadata.md): Returns the argocd RevisionMetadata for one revision of one application — what the detail view shows beside a revision.
- [List syncwindows](https://docs.hanzo.ai/docs/openapi/deploy/get-deploy-applications-by-name-syncwindows.md): Returns one application's argocd ApplicationSyncWindowState — the answer to "is anything blocking a sync of this application right now?".
- [List clusters](https://docs.hanzo.ai/docs/openapi/deploy/get-deploy-clusters.md): Returns the argocd ClusterList of the destinations the caller's applications reconcile into: one entry per distinct destination server, carrying the count of applications reconciling into it.
- [List health](https://docs.hanzo.ai/docs/openapi/deploy/get-deploy-health.md): Reports whether this deployment can observe the delivery plane.
- [Login deploy](https://docs.hanzo.ai/docs/openapi/deploy/get-deploy-login.md): Redirects the browser to IAM's authorize endpoint, having minted a nonce and a PKCE verifier into a short-lived, single-use flow cookie.
- [List projects](https://docs.hanzo.ai/docs/openapi/deploy/get-deploy-projects.md): Returns the argocd AppProjectList this console groups and filters applications by.
- [List userinfo](https://docs.hanzo.ai/docs/openapi/deploy/get-deploy-session-userinfo.md): Answers "is this browser signed in, and if not where does it sign in?" — the dashboard SPA's bootstrap question, and the only route on this plane that answers for an anonymous caller.
- [List applications — GET /v1/deploy/stream/applications](https://docs.hanzo.ai/docs/openapi/deploy/get-deploy-stream-applications.md): Holds the connection open as text/event-stream and pushes one watch event per application change.
- [List resource tree — GET /v1/deploy/stream/applications/{name}/resource-tree](https://docs.hanzo.ai/docs/openapi/deploy/get-deploy-stream-applications-by-name-resource-tree.md): Holds the connection open as text/event-stream and pushes the application's whole resource tree — its live child objects and each one's derived health — once immediately and again on every keep-alive tick, so a client always has a current picture without polling.
- [Create rollback](https://docs.hanzo.ai/docs/openapi/deploy/post-deploy-applications-by-name-rollback.md): Serves the console's rollback control, and today it requests a reconcile and nothing more.
- [Logout deploy](https://docs.hanzo.ai/docs/openapi/deploy/post-deploy-logout.md): Ends the console session on this host.
- [Destination](https://docs.hanzo.ai/docs/openapi/destination.md): Your events forwarded to the ad and analytics tools you use.
- [Delete destination](https://docs.hanzo.ai/docs/openapi/destination/delete-destination-by-platform.md): Forgets a destination for the caller's org: every credential held in KMS, then the stored config.
- [List destination](https://docs.hanzo.ai/docs/openapi/destination/get-destination.md): Reports every destination this deployment can forward to, each with the caller org's connection state: whether it is connected, whether it is enabled, whether a credential resolves right now, and the config fields the console renders for it.
- [Get destination](https://docs.hanzo.ai/docs/openapi/destination/get-destination-by-platform.md): Reports one destination's card for the caller's org — its config fields, its connection state, and whether a credential resolves right now.
- [Create destination](https://docs.hanzo.ai/docs/openapi/destination/post-destination-by-platform.md): Stores the addressed platform's non-secret ids (its measurement, pixel or dataset ids) and seals its API credential into KMS under a path scoped to the caller's own org, then answers the same status card the read routes do — with live telling you whether the credential actually resolves right now.
- [Test destination](https://docs.hanzo.ai/docs/openapi/destination/post-destination-by-platform-test.md): Sends ONE synthetic conversion through the connected destination end to end and reports what the platform said.
- [DNS](https://docs.hanzo.ai/docs/openapi/dns.md): Your DNS records: the zones and records behind every name you point at Hanzo.
- [Delete zones](https://docs.hanzo.ai/docs/openapi/dns/delete-dns-zones-by-zone.md): Removes one of the calling org's zones, and the records in it, from the DNS control plane.
- [Delete records](https://docs.hanzo.ai/docs/openapi/dns/delete-dns-zones-by-zone-records-by-record.md): Removes one record from one zone.
- [List health](https://docs.hanzo.ai/docs/openapi/dns/get-dns-health.md): Reports whether the DNS control plane is answering.
- [List zones](https://docs.hanzo.ai/docs/openapi/dns/get-dns-zones.md): Lists every DNS zone the calling org holds, authoritative and provider-backed alike.
- [Get zones](https://docs.hanzo.ai/docs/openapi/dns/get-dns-zones-by-zone.md): Reads one of the calling org's zones by name.
- [List records](https://docs.hanzo.ai/docs/openapi/dns/get-dns-zones-by-zone-records.md): Lists the records in one zone.
- [Get records](https://docs.hanzo.ai/docs/openapi/dns/get-dns-zones-by-zone-records-by-record.md): Reads one record of one zone by its id.
- [Update records](https://docs.hanzo.ai/docs/openapi/dns/patch-dns-zones-by-zone-records-by-record.md): Amends one record of one zone.
- [Sync dns](https://docs.hanzo.ai/docs/openapi/dns/post-dns-sync.md): Replaces the calling org's zones and their records in bulk.
- [Create zones](https://docs.hanzo.ai/docs/openapi/dns/post-dns-zones.md): Creates a zone for the calling org — authoritative, or backed by a DNS provider the org has connected.
- [Create records](https://docs.hanzo.ai/docs/openapi/dns/post-dns-zones-by-zone-records.md): Creates a record in one zone.
- [Replace records](https://docs.hanzo.ai/docs/openapi/dns/put-dns-zones-by-zone-records-by-record.md): Amends one record of one zone.
- [Domain](https://docs.hanzo.ai/docs/openapi/domain.md): Hanzo Domains: search a name, see the price, buy it from your prepaid wallet.
- [List availability](https://docs.hanzo.ai/docs/openapi/domain/get-domain-availability.md): Checks exact names rather than searching for them, and answers the same quote shape search does — purchasable, premium, first-term and renewal price in cents.
- [List domains](https://docs.hanzo.ai/docs/openapi/domain/get-domain-domains.md): The domains your org has bought here, newest registration first, each carrying the name, when it was registered, when it expires, what the org paid, the registrar order id and the nameservers it points at.
- [List health](https://docs.hanzo.ai/docs/openapi/domain/get-domain-health.md): Reports registrar reachability honestly: ok only when the wholesale credentials are present AND name.com accepted them on a live call made while you waited.
- [Search domain](https://docs.hanzo.ai/docs/openapi/domain/get-domain-search.md): Finds names built from the keyword q, plus the registrar's alternate-TLD suggestions, and answers a quote for each: the name, whether it is purchasable, whether it is premium, the first-term and renewal price in cents, and the TLD.
- [Create register](https://docs.hanzo.ai/docs/openapi/domain/post-domain-register.md): Buys a domain for your org and answers the ownership record together with the quote it was bought at.
- [Create renew](https://docs.hanzo.ai/docs/openapi/domain/post-domain-renew.md): Extends a domain your org already owns and answers the updated record with its new expiry alongside what was paid.
- [Create transfer](https://docs.hanzo.ai/docs/openapi/domain/post-domain-transfer.md): Moves a domain you own at another registrar onto your org here, using its authCode, and answers the same record-plus-quote a purchase does.
- [Engine](https://docs.hanzo.ai/docs/openapi/engine.md): Hanzo Engine: which models the serving runtime has loaded, and the GPUs under it.
- [List model](https://docs.hanzo.ai/docs/openapi/engine/enginemodel.md): Reads one model's load state — loaded, unloading, or not_found, as the engine itself reports it.
- [List models](https://docs.hanzo.ai/docs/openapi/engine/enginemodels.md): Lists the models the engine serves, each with its load state — the server's own model table (its standard list envelope, load status included), relayed verbatim.
- [List status](https://docs.hanzo.ai/docs/openapi/engine/enginestatus.md): Reports whether the engine deployment is reachable and which build revision it runs — an honest lens for "is the serving runtime up", never a fabricated ok.
- [List system](https://docs.hanzo.ai/docs/openapi/engine/enginesystem.md): Reads the engine host's inventory: OS, CPU, memory, every accelerator device with its VRAM and compute capability, and the build's capabilities (CUDA/Metal/flash-attention) — the real hardware under the serving runtime, relayed verbatim.
- [Entitlement](https://docs.hanzo.ai/docs/openapi/entitlement.md): What your org may run: what the plan grants, and which of those products are switched on.
- [List entitlement](https://docs.hanzo.ai/docs/openapi/entitlement/get-entitlement.md): Reports which console apps the CALLER's org may open, and the plan slug that decides it.
- [Get orgs](https://docs.hanzo.ai/docs/openapi/entitlement/get-entitlement-orgs-by-org.md): Lists the products an org has ENABLED — its own intent, which the console's paid-product sidebar reads to decide what to show.
- [Create orgs](https://docs.hanzo.ai/docs/openapi/entitlement/post-entitlement-orgs-by-org.md): Turns products on or off for an org and returns the enabled set afterwards.
- [Environment](https://docs.hanzo.ai/docs/openapi/environment.md): What a codebase is before its agent starts: the commands that install it, the command that starts it, and the secrets it reads.
- [Delete environment](https://docs.hanzo.ai/docs/openapi/environment/delete-environment-by-repo.md): Forgets one codebase's environment, and its secrets with it.
- [Delete secrets](https://docs.hanzo.ai/docs/openapi/environment/delete-environment-by-repo-secrets-by-name.md): Removes one secret from a codebase.
- [List environment](https://docs.hanzo.ai/docs/openapi/environment/get-environment.md): Lists every codebase in your org that has an environment.
- [Get environment](https://docs.hanzo.ai/docs/openapi/environment/get-environment-by-repo.md): Reads one codebase's environment.
- [Replace environment](https://docs.hanzo.ai/docs/openapi/environment/put-environment-by-repo.md): Saves one codebase's install and start scripts.
- [Replace secrets](https://docs.hanzo.ai/docs/openapi/environment/put-environment-by-repo-secrets-by-name.md): Sets one secret on a codebase.
- [eSign](https://docs.hanzo.ai/docs/openapi/esign.md): A document out for signature, signed and filed with an audit trail.
- [List documents](https://docs.hanzo.ai/docs/openapi/esign/get-esign-documents.md): Returns your org's documents, newest first.
- [Get documents](https://docs.hanzo.ai/docs/openapi/esign/get-esign-documents-by-id.md): Returns one document with its recipients and field layout.
- [List audit](https://docs.hanzo.ai/docs/openapi/esign/get-esign-documents-by-id-audit.md): Returns the document's full audit trail, oldest first.
- [List download](https://docs.hanzo.ai/docs/openapi/esign/get-esign-documents-by-id-download.md): Returns the document — the sealed PDF once it is complete.
- [List health](https://docs.hanzo.ai/docs/openapi/esign/get-esign-health.md): Reports whether the e-signature surface is mounted.
- [Get sign](https://docs.hanzo.ai/docs/openapi/esign/get-esign-o-by-org-sign-by-token.md): Opens a document you were asked to sign, using your signing link.
- [Create documents](https://docs.hanzo.ai/docs/openapi/esign/post-esign-documents.md): Uploads a PDF and opens a draft ready for recipients and fields.
- [Create fields — POST /v1/esign/documents/{id}/fields](https://docs.hanzo.ai/docs/openapi/esign/post-esign-documents-by-id-fields.md): Places a field on the page for one recipient to fill.
- [Create recipients](https://docs.hanzo.ai/docs/openapi/esign/post-esign-documents-by-id-recipients.md): Adds someone to a draft and mints their signing token.
- [Send documents](https://docs.hanzo.ai/docs/openapi/esign/post-esign-documents-by-id-send.md): Sends the document out and answers each signer's link.
- [Complete sign](https://docs.hanzo.ai/docs/openapi/esign/post-esign-o-by-org-sign-by-token-complete.md): Finishes your signing — and seals the document if you were the last.
- [Create fields — POST /v1/esign/o/{org}/sign/{token}/fields/{fieldId}](https://docs.hanzo.ai/docs/openapi/esign/post-esign-o-by-org-sign-by-token-fields-by-fieldid.md): Fills in one of your fields.
- [Reject sign](https://docs.hanzo.ai/docs/openapi/esign/post-esign-o-by-org-sign-by-token-reject.md): Declines to sign, with an optional reason.
- [Eval](https://docs.hanzo.ai/docs/openapi/eval.md): Scoring a model on your own data, with a judge you choose.
- [Delete datasets](https://docs.hanzo.ai/docs/openapi/eval/delete-eval-datasets-by-name.md): Removes the named dataset of the caller's org AND all of its examples, in one transaction.
- [List datasets](https://docs.hanzo.ai/docs/openapi/eval/get-eval-datasets.md): The datasets your org has, each with its name, description, metadata and timestamps.
- [Get datasets](https://docs.hanzo.ai/docs/openapi/eval/get-eval-datasets-by-name.md): Returns one dataset of the caller's org by name, together with its live item count — the one read that answers how big the set actually is.
- [List items](https://docs.hanzo.ai/docs/openapi/eval/get-eval-datasets-by-name-items.md): The examples in one of your datasets — the set is named in the path, because this collection only exists inside one.
- [List evaluators](https://docs.hanzo.ai/docs/openapi/eval/get-eval-evaluators.md): The judges your org has defined, each with its judge model, criteria and the score name it writes under.
- [List metrics](https://docs.hanzo.ai/docs/openapi/eval/get-eval-metrics.md): Your org's AI overview board over a window: totals (generations, prompt and completion tokens, cost in cents, errors, success rate, distinct models and users), a gap-filled time series, a per-model breakdown with the long tail folded into "other", and latency percentiles read from the GenAI spans.
- [List rubrics](https://docs.hanzo.ai/docs/openapi/eval/get-eval-rubrics.md): The score shapes your org has declared — each name's data type, its numeric bounds and its allowed categories.
- [List runs](https://docs.hanzo.ai/docs/openapi/eval/get-eval-runs.md): Your past runs and how they scored — the dataset and model, the judge model, how many examples were attempted and how many scored, the average score, and when it happened.
- [List scores](https://docs.hanzo.ai/docs/openapi/eval/get-eval-scores.md): The score events your org has recorded, narrowed by any of name, runName and traceId.
- [List traces](https://docs.hanzo.ai/docs/openapi/eval/get-eval-traces.md): The traces behind your evaluations — one per model call an evaluation made, carrying its input, output, model and timing — narrowed by any of sessionId, runName and datasetName.
- [Create datasets](https://docs.hanzo.ai/docs/openapi/eval/post-eval-datasets.md): Writes a dataset — the named set of graded examples a run scores a model against — under the caller's org and answers 201 with it.
- [Create items](https://docs.hanzo.ai/docs/openapi/eval/post-eval-datasets-by-name-items.md): Writes one graded example — its input, its expected output, free-form metadata and a status — into the dataset named in the path, and answers 201 with it.
- [Create evaluators](https://docs.hanzo.ai/docs/openapi/eval/post-eval-evaluators.md): Saves a reusable judge for the caller's org — the judge model and the written criteria it grades against — and answers 201 with it.
- [Create rubrics](https://docs.hanzo.ai/docs/openapi/eval/post-eval-rubrics.md): Defines the shape of one score name for the caller's org and answers 201 with it.
- [Create runs](https://docs.hanzo.ai/docs/openapi/eval/post-eval-runs.md): Runs a real evaluation and answers the summary when it is finished — this is synchronous work, not a job id.
- [Create scores](https://docs.hanzo.ai/docs/openapi/eval/post-eval-scores.md): Files one score event for the caller's org and answers 201 with it.
- [Event](https://docs.hanzo.ai/docs/openapi/event.md): Product analytics: send an event, read back who did what.
- [List economic](https://docs.hanzo.ai/docs/openapi/event/get-event-economic.md): Returns, oldest first and paged, the payments the caller's org made or received in a year, with the ones a correction restates named and what either party disputes — for the org's admins.
- [List errors](https://docs.hanzo.ai/docs/openapi/event/get-event-errors.md): Returns the caller org's most recently captured errors, newest first.
- [List health — GET /v1/event/health](https://docs.hanzo.ai/docs/openapi/event/get-event-health.md): Reports whether the event plane can take a write and the warehouse can answer a read.
- [List events](https://docs.hanzo.ai/docs/openapi/event/get-event-insights-events.md): Returns the caller org's most recent product events, newest first.
- [List health — GET /v1/event/insights/health](https://docs.hanzo.ai/docs/openapi/event/get-event-insights-health.md): Reports that the unified insights surface is serving.
- [List overview](https://docs.hanzo.ai/docs/openapi/event/get-event-overview.md): Returns the caller org's analytics KPIs for one time window.
- [Get pixel](https://docs.hanzo.ai/docs/openapi/event/get-event-pixel-by-key.md): Answers a transparent 1x1 GIF and records one page view for the project whose publishable key names the address.
- [List tag.js](https://docs.hanzo.ai/docs/openapi/event/get-event-tagjs.md): Serves the browser tag that autocaptures pageviews (initial and SPA) and uncaught errors onto the canonical wire at POST /v1/event.
- [List timeseries](https://docs.hanzo.ai/docs/openapi/event/get-event-timeseries.md): Returns the caller org's LLM usage over time as an evenly-spaced series.
- [List top](https://docs.hanzo.ai/docs/openapi/event/get-event-top.md): Returns the caller org's ranked lenses for one window, five of them at once.
- [Create event](https://docs.hanzo.ai/docs/openapi/event/post-event.md): Stores pageviews, browser errors, identifies and custom commerce events as rows in the caller's own tenant, and answers a receipt {accepted, dropped} that always totals what was sent — a beacon is never silently discarded.
- [Create dispute](https://docs.hanzo.ai/docs/openapi/event/post-event-economic-dispute.md): Records that the caller's org disputes one payment it is party to — for the org's admins.
- [Create replay](https://docs.hanzo.ai/docs/openapi/event/post-event-replay.md): Accepts a batch of rrweb events from a browser recorder and hands it to the session-replay pipeline, which stores the recording and derives the session summary a player reads back.
- [Exec](https://docs.hanzo.ai/docs/openapi/exec.md): The code interpreter: run a snippet in a sandbox, and move files in and out of the session that sandbox IS.
- [Get files](https://docs.hanzo.ai/docs/openapi/exec/get-exec-files-by-sid.md): Lists the files in an execution session.
- [Create exec](https://docs.hanzo.ai/docs/openapi/exec/post-exec.md): Executes a program in a throwaway sandbox and answers with what it printed and what it left behind.
- [Create upload](https://docs.hanzo.ai/docs/openapi/exec/post-exec-upload.md): Takes a multipart upload and writes the file into the session's sandbox, so a later run can read it.
- [Experiment](https://docs.hanzo.ai/docs/openapi/experiment.md): A/B testing anything: a flag, an ad, a subject line, a model.
- [List experiment](https://docs.hanzo.ai/docs/openapi/experiment/get-experiment.md): Every experiment in the caller's org, with its variants, status and decision, ordered by project then id.
- [Get experiment](https://docs.hanzo.ai/docs/openapi/experiment/get-experiment-by-id.md): One experiment's definition and lifecycle: variants, weights, control arm, status and winner.
- [List assign](https://docs.hanzo.ai/docs/openapi/experiment/get-experiment-by-id-assign.md): The variant one subject is bucketed into, and the payload that variant carries.
- [List health](https://docs.hanzo.ai/docs/openapi/experiment/get-experiment-health.md): Whether the experiments subsystem is mounted and serving in this process.
- [Create experiment](https://docs.hanzo.ai/docs/openapi/experiment/post-experiment.md): Registers a controlled experiment AND puts its assignment flag live, in that order, so the arms start bucketing subjects the moment this returns 201 — the flag is created active at 100% rollout, with each variant weighted as declared.
- [Create analyze](https://docs.hanzo.ai/docs/openapi/experiment/post-experiment-by-id-analyze.md): Per-variant conversion, lift and statistical significance against the control arm.
- [Create decide](https://docs.hanzo.ai/docs/openapi/experiment/post-experiment-by-id-decide.md): Promotes one variant to the whole rollout and records who decided.
- [Explorer](https://docs.hanzo.ai/docs/openapi/explorer.md): Chain data: your block indexers and how far each has caught up, plus the on-chain price feeds.
- [List indexers](https://docs.hanzo.ai/docs/openapi/explorer/get-explorer-indexers.md): Reports the deployment's chain indexer(s) and how far each has indexed.
- [List oracles](https://docs.hanzo.ai/docs/openapi/explorer/get-explorer-oracles.md): Reports the on-chain price/data oracles from the graph's O-Chain PriceFeed registry.
- [Flag](https://docs.hanzo.ai/docs/openapi/flag.md): Feature flags: ship it dark, then turn it on for who you pick.
- [Delete defs](https://docs.hanzo.ai/docs/openapi/flag/delete-flag-defs-by-key.md): Removes one flag definition by key and records the deletion in the change log.
- [List activity](https://docs.hanzo.ai/docs/openapi/flag/get-flag-activity.md): Returns the caller's flag change log newest-first: every create, update and delete, with the actor and the time.
- [List defs](https://docs.hanzo.ai/docs/openapi/flag/get-flag-defs.md): Returns every flag definition in the caller's (org, project) store, by key, with its version and who last changed it.
- [Get defs](https://docs.hanzo.ai/docs/openapi/flag/get-flag-defs-by-key.md): Returns one flag definition by key, or 404 when the caller's store has none under that key.
- [List health](https://docs.hanzo.ai/docs/openapi/flag/get-flag-health.md): Reports that the flag engine is serving.
- [Create flag](https://docs.hanzo.ai/docs/openapi/flag/post-flag.md): Runs the caller's flag definitions for one identity and returns the flag verdict: which flags are on (or which variant), their payloads, and whether any definition failed to compute.
- [Create decide](https://docs.hanzo.ai/docs/openapi/flag/post-flag-decide.md): Runs the caller's flag definitions for one identity and returns the flag verdict: which flags are on (or which variant), their payloads, and whether any definition failed to compute.
- [Replace defs](https://docs.hanzo.ai/docs/openapi/flag/put-flag-defs-by-key.md): Creates or replaces the flag definition at the path's key and returns the stored row.
- [Flow](https://docs.hanzo.ai/docs/openapi/flow.md): Hanzo Flow: build an agent workflow on a visual canvas, run it, and read every run.
- [Delete workflows](https://docs.hanzo.ai/docs/openapi/flow/delete-flow-workflows-by-workflow.md): Deletes one of the caller's workflows and its runs.
- [List runs](https://docs.hanzo.ai/docs/openapi/flow/get-flow-runs.md): Reads one workflow's recorded runs: every component build with its result, keyed by component.
- [List status](https://docs.hanzo.ai/docs/openapi/flow/get-flow-status.md): Reports whether the flow service is reachable and which version it runs.
- [List workflows](https://docs.hanzo.ai/docs/openapi/flow/get-flow-workflows.md): Lists the caller's workflows, paged.
- [Get workflows](https://docs.hanzo.ai/docs/openapi/flow/get-flow-workflows-by-workflow.md): Reads one of the caller's workflows — the full record, graph included.
- [Update workflows](https://docs.hanzo.ai/docs/openapi/flow/patch-flow-workflows-by-workflow.md): Patches one of the caller's workflows: name, description, graph, or the locked flag — only the stated fields move.
- [Create runs](https://docs.hanzo.ai/docs/openapi/flow/post-flow-runs.md): Executes one of the caller's workflows synchronously: the graph runs in the flow service and the response carries the run's session and outputs.
- [Create workflows](https://docs.hanzo.ai/docs/openapi/flow/post-flow-workflows.md): Creates a workflow in the caller's org.
- [Framework](https://docs.hanzo.ai/docs/openapi/framework.md): Document types you define: describe a record once, then create, list, submit and cancel documents against it.
- [Delete framework](https://docs.hanzo.ai/docs/openapi/framework/delete-framework-by-doctype-by-name.md): Removes one document, after its on_trash hooks agree.
- [Delete doctypes](https://docs.hanzo.ai/docs/openapi/framework/delete-framework-doctypes-by-name.md): Removes a DocType and every document stored under it.
- [Get framework — GET /v1/framework/{doctype}](https://docs.hanzo.ai/docs/openapi/framework/get-framework-by-doctype.md): Returns the caller org's documents of one DocType, filtered, ordered and projected by the query.
- [Get framework — GET /v1/framework/{doctype}/{name}](https://docs.hanzo.ai/docs/openapi/framework/get-framework-by-doctype-by-name.md): Returns one document by name, with Password fields redacted.
- [List doctypes](https://docs.hanzo.ai/docs/openapi/framework/get-framework-doctypes.md): Returns every DocType defined in the caller's org.
- [Get doctypes](https://docs.hanzo.ai/docs/openapi/framework/get-framework-doctypes-by-name.md): Returns one DocType definition — its fields, naming rule, permissions and lifecycle flags.
- [List modules](https://docs.hanzo.ai/docs/openapi/framework/get-framework-modules.md): Returns every app lane compiled into this deployment and the DocTypes each one installs.
- [Get modules](https://docs.hanzo.ai/docs/openapi/framework/get-framework-modules-by-module.md): Returns one app lane's install state for the caller's org: the DocTypes the lane declares, and which of them already exist in the org.
- [List summary](https://docs.hanzo.ai/docs/openapi/framework/get-framework-summary.md): Reports how much of the DocType surface the caller's org uses: how many DocTypes it has defined, and how many documents exist across them.
- [Create framework](https://docs.hanzo.ai/docs/openapi/framework/post-framework-by-doctype.md): The body is the DOCUMENT'S field data: a flat JSON object whose properties are the fieldnames the DocType declares, not a fixed envelope.
- [Cancel framework](https://docs.hanzo.ai/docs/openapi/framework/post-framework-by-doctype-by-name-cancel.md): Moves a submitted document to cancelled (docstatus 1 → 2) after its on_cancel hooks agree.
- [Create submit](https://docs.hanzo.ai/docs/openapi/framework/post-framework-by-doctype-by-name-submit.md): Moves a draft to submitted (docstatus 0 → 1) after its on_submit hooks agree.
- [Create doctypes](https://docs.hanzo.ai/docs/openapi/framework/post-framework-doctypes.md): Defines a DocType in the caller's org: the metadata that gives a document surface its fields, its naming rule, whether it has a submit/cancel lifecycle, and which role may do what to it.
- [Create install](https://docs.hanzo.ai/docs/openapi/framework/post-framework-modules-by-module-install.md): Creates an app lane's DocTypes in the caller's org.
- [Replace framework](https://docs.hanzo.ai/docs/openapi/framework/put-framework-by-doctype-by-name.md): PUT semantics: the stored field data BECOMES the body, so a field the body omits is not left at its previous value.
- [Replace doctypes](https://docs.hanzo.ai/docs/openapi/framework/put-framework-doctypes-by-name.md): Replaces a DocType definition wholesale (PUT semantics): the stored definition becomes the body.
- [Function](https://docs.hanzo.ai/docs/openapi/function.md): Your serverless code: publish it, call it over HTTP, watch every run and what it cost.
- [Delete function](https://docs.hanzo.ai/docs/openapi/function/delete-function-by-name.md): Removes one of the caller org's functions and answers 204.
- [List function](https://docs.hanzo.ai/docs/openapi/function/get-function.md): Every serverless function the caller's org has published, each with its real 7-day rollup.
- [Get function](https://docs.hanzo.ai/docs/openapi/function/get-function-by-name.md): One function with everything a detail page needs in one round-trip: its definition, its 7-day rollup, its trigger, its twenty most recent invocations and the NAMES of the secrets it mounts.
- [List invocations](https://docs.hanzo.ai/docs/openapi/function/get-function-by-name-invocations.md): One function's past runs, newest first — each with its status, HTTP code, method, time and duration.
- [List logs](https://docs.hanzo.ai/docs/openapi/function/get-function-by-name-logs.md): The output of a function's most recent run — its error text when that run failed, else what it printed.
- [List deployments](https://docs.hanzo.ai/docs/openapi/function/get-function-deployments.md): What is live right now — each function's current record IS its live deployment, so this is the deployment inventory.
- [List metrics](https://docs.hanzo.ai/docs/openapi/function/get-function-metrics.md): The org's serverless dashboard over a window: a per-function invocation costLine and how those invocations ended.
- [List secrets](https://docs.hanzo.ai/docs/openapi/function/get-function-secrets.md): The NAMES of the secrets the caller org's functions mount.
- [List triggers](https://docs.hanzo.ai/docs/openapi/function/get-function-triggers.md): What calls the caller org's functions — one row per function.
- [Create function](https://docs.hanzo.ai/docs/openapi/function/post-function.md): Publishes a serverless function under the caller's org and answers 201 with it.
- [Invoke function](https://docs.hanzo.ai/docs/openapi/function/post-function-by-name-invoke.md): Runs a function and records a REAL invocation.
- [Gateway](https://docs.hanzo.ai/docs/openapi/gateway.md): Live control of the policy your API applies to every incoming request: CORS, rate limits, cache TTL and allowed methods, changed without a redeploy.
- [List traffic](https://docs.hanzo.ai/docs/openapi/gateway/gatewaytraffic.md): Reports who is calling this organization's API right now: the request count for the last minute split by AGENCY LANE — agent, human, bot, unknown — and the busiest callers behind it, each with its request count, its authentication-failure count, how many distinct paths it touched, and any verdict currently held against it.
- [List config](https://docs.hanzo.ai/docs/openapi/gateway/get-gateway-config.md): Returns the EFFECTIVE edge policy the caller is subject to: the platform CORS allowlist and pre-auth per-IP flood cap in force, plus the caller's own authenticated rate ceiling, edge-cache TTLs and accepted-method allowlist.
- [Replace config](https://docs.hanzo.ai/docs/openapi/gateway/put-gateway-config.md): Updates one policy scope and returns the policy in force after the write.
- [Git](https://docs.hanzo.ai/docs/openapi/git.md): Git hosting for your org: create repos, clone, push, and see what they cost.
- [Delete keys](https://docs.hanzo.ai/docs/openapi/git/delete-git-keys-by-id.md): Removes a registered SSH key, scoped to the caller's org: an org can only delete its own, and a key id it does not own is not found.
- [Delete repos](https://docs.hanzo.ai/docs/openapi/git/delete-git-repos-by-name.md): Removes a repo's metadata and purges its storage.
- [Delete subscriptions](https://docs.hanzo.ai/docs/openapi/git/delete-git-repos-by-name-subscriptions-by-id.md): Removes one Slack subscription from a repo; the notifier stops posting that repo's events to that channel.
- [Delete targets](https://docs.hanzo.ai/docs/openapi/git/delete-git-repos-by-name-targets-by-id.md): Removes one outbound mirror target; later pushes stop being forwarded to it.
- [List git](https://docs.hanzo.ai/docs/openapi/git/get-git.md): The repository list for the signed-in caller's org — each repo with its description, default branch, size and last update.
- [List refs — GET /v1/git/{org}/{project}/{repo}/info/refs](https://docs.hanzo.ai/docs/openapi/git/get-git-by-org-by-project-by-repo-info-refs.md): The ref-advertisement phase of git's smart-HTTP protocol — the first request a clone, a fetch and a push all make.
- [Get git](https://docs.hanzo.ai/docs/openapi/git/get-git-by-org-by-repo.md): A repository at a glance: its branches, the tree at the tip, its most recent commits, its README rendered, and the HTTPS and SSH clone URLs.
- [List commits — GET /v1/git/{org}/{repo}/commits](https://docs.hanzo.ai/docs/openapi/git/get-git-by-org-by-repo-commits.md): The hundred most recent commits on one ref, each with its author, message and date.
- [List refs — GET /v1/git/{org}/{repo}/info/refs](https://docs.hanzo.ai/docs/openapi/git/get-git-by-org-by-repo-info-refs.md): The ref-advertisement phase of git's smart-HTTP protocol — the first request a clone, a fetch and a push all make.
- [List explore](https://docs.hanzo.ai/docs/openapi/git/get-git-explore.md): The open, unauthenticated face of the git host: every PUBLIC repository in the fleet, org-qualified, so a project can be found and cloned with no account at all — signing in is for private repos and for writes.
- [List keys](https://docs.hanzo.ai/docs/openapi/git/get-git-keys.md): Returns the SSH public keys registered to the caller's org — the keys that authenticate `git clone git@<host>:<org>/<repo>.git`.
- [List pools](https://docs.hanzo.ai/docs/openapi/git/get-git-pools.md): Returns the capacity this org has declared and how many daemons have entered each pool.
- [List repos](https://docs.hanzo.ai/docs/openapi/git/get-git-repos.md): Returns the repos in the caller's scope, most recently updated first.
- [Get repos](https://docs.hanzo.ai/docs/openapi/git/get-git-repos-by-name.md): Returns one repo with its live ref state: every branch name and the resolved HEAD commit.
- [List blob](https://docs.hanzo.ai/docs/openapi/git/get-git-repos-by-name-blob.md): Returns one file's bytes at one revision.
- [List commits — GET /v1/git/repos/{name}/commits](https://docs.hanzo.ai/docs/openapi/git/get-git-repos-by-name-commits.md): Walks a ref's history newest first, or one path's history when a path is given.
- [List files](https://docs.hanzo.ai/docs/openapi/git/get-git-repos-by-name-files.md): Returns every file a glob selects at one revision, WITH its bytes and the revision they came from.
- [List pulls](https://docs.hanzo.ai/docs/openapi/git/get-git-repos-by-name-pulls.md): Returns a repo's pull requests, newest number first — what is waiting to be reviewed, and what has already landed.
- [Get pulls](https://docs.hanzo.ai/docs/openapi/git/get-git-repos-by-name-pulls-by-number.md): Returns one pull request by its per-repo number.
- [List readme](https://docs.hanzo.ai/docs/openapi/git/get-git-repos-by-name-readme.md): Returns the README at the tree root as plain text — unrendered, so the caller decides how to present it.
- [List refs — GET /v1/git/repos/{name}/refs](https://docs.hanzo.ai/docs/openapi/git/get-git-repos-by-name-refs.md): Lists a repo's branches, tags and default branch — what a branch picker needs in one call.
- [List subscriptions](https://docs.hanzo.ai/docs/openapi/git/get-git-repos-by-name-subscriptions.md): Returns a repo's Slack subscriptions — which channels the lifecycle notifier posts this repo's push and deploy events to.
- [List targets](https://docs.hanzo.ai/docs/openapi/git/get-git-repos-by-name-targets.md): Returns a repo's outbound mirror targets — the downstream remotes the mirror reactor pushes to whenever a push lands here.
- [List tree](https://docs.hanzo.ai/docs/openapi/git/get-git-repos-by-name-tree.md): Lists the immediate children of one directory at one revision, directories before files.
- [List runners](https://docs.hanzo.ai/docs/openapi/git/get-git-runners.md): Returns the daemons registered into this org's pools, newest first, with when each was last heard from.
- [List runs](https://docs.hanzo.ai/docs/openapi/git/get-git-runs.md): Returns this org's runs, newest first.
- [Get runs](https://docs.hanzo.ai/docs/openapi/git/get-git-runs-by-id.md): Returns one run.
- [List usage](https://docs.hanzo.ai/docs/openapi/git/get-git-usage.md): Returns per-repo and total storage bytes for the caller's org — the queryable, per-tenant number commerce and o11y meter on.
- [List workflows](https://docs.hanzo.ai/docs/openapi/git/get-git-workflows.md): Reports the workflows a repository declares at a ref and which declared pool would execute each job — the answer to "would a push here run, and where".
- [Update repos](https://docs.hanzo.ai/docs/openapi/git/patch-git-repos-by-name.md): Flips a repo's public bit, the one mutable repo setting today.
- [Create git receive pack — POST /v1/git/{org}/{project}/{repo}/git-receive-pack](https://docs.hanzo.ai/docs/openapi/git/post-git-by-org-by-project-by-repo-git-receive-pack.md): The pack-transfer phase of a push, and the point at which a push becomes an EVENT.
- [Create git upload pack — POST /v1/git/{org}/{project}/{repo}/git-upload-pack](https://docs.hanzo.ai/docs/openapi/git/post-git-by-org-by-project-by-repo-git-upload-pack.md): The pack-transfer phase of a clone or fetch: the request and the response are git's binary pack protocol, streamed straight through git itself — request body to git's stdin, git's stdout to the response — so a multi-gigabyte clone never lands in this process's memory.
- [Create git receive pack — POST /v1/git/{org}/{repo}/git-receive-pack](https://docs.hanzo.ai/docs/openapi/git/post-git-by-org-by-repo-git-receive-pack.md): The pack-transfer phase of a push, and the point at which a push becomes an EVENT.
- [Create git upload pack — POST /v1/git/{org}/{repo}/git-upload-pack](https://docs.hanzo.ai/docs/openapi/git/post-git-by-org-by-repo-git-upload-pack.md): The pack-transfer phase of a clone or fetch: the request and the response are git's binary pack protocol, streamed straight through git itself — request body to git's stdin, git's stdout to the response — so a multi-gigabyte clone never lands in this process's memory.
- [Create keys](https://docs.hanzo.ai/docs/openapi/git/post-git-keys.md): Registers an SSH public key so it can authenticate `git clone git@<host>:<org>/<repo>.git` for the caller's org.
- [Create pools](https://docs.hanzo.ai/docs/openapi/git/post-git-pools.md): Records the capacity an org has, and answers with the secret a runner daemon presents to enter it.
- [Create repos](https://docs.hanzo.ai/docs/openapi/git/post-git-repos.md): Provisions an empty bare repository in the caller's scope and returns it with its clone URLs.
- [Create gc](https://docs.hanzo.ai/docs/openapi/git/post-git-repos-by-name-gc.md): Repacks a repo into one bitmapped pack and rewrites its commit-graph, so the next clone reuses the bitmap instead of walking the whole object graph.
- [Create mirror](https://docs.hanzo.ai/docs/openapi/git/post-git-repos-by-name-mirror.md): Imports an external git repository into the caller's repo, provisioning it on first use.
- [Create pulls](https://docs.hanzo.ai/docs/openapi/git/post-git-repos-by-name-pulls.md): Proposes a branch for merging and returns it with its number.
- [Create merge](https://docs.hanzo.ai/docs/openapi/git/post-git-repos-by-name-pulls-by-number-merge.md): Merges an open pull request by FAST-FORWARDING base to head, and answers the proposal in its merged state with the revision base now points at.
- [Create push](https://docs.hanzo.ai/docs/openapi/git/post-git-repos-by-name-push.md): Lands a set of files as one commit without a git client — the hanzo.app builder's push.
- [Create subscriptions](https://docs.hanzo.ai/docs/openapi/git/post-git-repos-by-name-subscriptions.md): Binds a Slack channel to a repo, so the lifecycle notifier posts that repo's push and deploy events there.
- [Create targets](https://docs.hanzo.ai/docs/openapi/git/post-git-repos-by-name-targets.md): Registers a downstream remote the repo's advanced refs are pushed to whenever a push lands here.
- [Create runs](https://docs.hanzo.ai/docs/openapi/git/post-git-runs.md): Runs a repository's workflows at a ref, on demand.
- [Create webhook](https://docs.hanzo.ai/docs/openapi/git/post-git-webhook.md): GONE (410).
- [Create workspace](https://docs.hanzo.ai/docs/openapi/git/post-git-workspace.md): Sets the org's code workspace up for the caller and answers it: the namespace, made when the org has none, and the caller's forge account and seat there.
- [Create declare](https://docs.hanzo.ai/docs/openapi/git/post-runner-declare.md): Republishes what a registered runner can do, and answers with what this side understands, so the two learn about each other from one exchange.
- [Create log](https://docs.hanzo.ai/docs/openapi/git/post-runner-log.md): Adds console output to a task's log and answers with how far that log is durable, so the runner knows where to resend from.
- [Create register](https://docs.hanzo.ai/docs/openapi/git/post-runner-register.md): Trades a pool's join secret for a runner identity and the token that authenticates every later call.
- [Create state](https://docs.hanzo.ai/docs/openapi/git/post-runner-state.md): Records a task's progress and that of its steps, and answers with the result this side now holds — which is how a runner learns its task was stopped from somewhere else.
- [Create task](https://docs.hanzo.ai/docs/openapi/git/post-runner-task.md): Hands the runner a job to execute, if its pool has one, and answers immediately either way.
- [Graph](https://docs.hanzo.ai/docs/openapi/graph.md): One organization's entities and the relations between them, held as assertions: somebody, at some moment, from some evidence, asserted that this thing stands in that relation to that other thing.
- [Create answer](https://docs.hanzo.ai/docs/openapi/graph/graphanswer.md): Answers a question from the whole graph and cites the assertions it rests on.
- [Create graph](https://docs.hanzo.ai/docs/openapi/graph/graphassert.md): Records a batch of assertions and counts what became of each.
- [Create communities](https://docs.hanzo.ai/docs/openapi/graph/graphcommunities.md): Partitions the edge graph into sets of entities more densely connected to each other than to the rest.
- [Create derive](https://docs.hanzo.ai/docs/openapi/graph/graphderive.md): Concludes what the organization's rules derive from the graph, with a proof for every conclusion: the rule, and each support as the assertion in force it rests on or as the derived atom it is.
- [Create diff](https://docs.hanzo.ai/docs/openapi/graph/graphdiff.md): Reports what came into force, was superseded and was retracted between two points.
- [Create erase](https://docs.hanzo.ai/docs/openapi/graph/grapherase.md): Removes every assertion that names an entity and returns a receipt.
- [Create extract](https://docs.hanzo.ai/docs/openapi/graph/graphextract.md): Reads the relations a source states and returns them, recording nothing.
- [Create ingest](https://docs.hanzo.ai/docs/openapi/graph/graphingest.md): Reads a source and records what it states, through the same admission as assert.
- [Create neighbors](https://docs.hanzo.ai/docs/openapi/graph/graphneighbors.md): Walks the in-force edges from a set of seeds and lists every entity reached, bounded.
- [Create path](https://docs.hanzo.ai/docs/openapi/graph/graphpath.md): Finds the shortest chain of in-force edges from one entity to another.
- [List graph](https://docs.hanzo.ai/docs/openapi/graph/graphread.md): Lists the assertions recorded, every version, oldest first.
- [Resolve graph](https://docs.hanzo.ai/docs/openapi/graph/graphresolve.md): Answers what holds for one entity and relation at a point, winner first, with every weaker account that disagreed.
- [Search graph](https://docs.hanzo.ai/docs/openapi/graph/graphsearch.md): Finds assertions by their words, where read finds them by their keys, best match first.
- [List vocabulary](https://docs.hanzo.ai/docs/openapi/graph/graphvocabulary.md): Lists the relations in use, the schema declared for them and the rule that settles a conflict.
- [Create graphql](https://docs.hanzo.ai/docs/openapi/graph/post-graph-graphql.md): Runs a GraphQL query against this organization's assertions.
- [Guide](https://docs.hanzo.ai/docs/openapi/guide.md): The AI that builds an agentic company with you, one measured step at a time.
- [Delete curriculum](https://docs.hanzo.ai/docs/openapi/guide/delete-guide-curriculum.md): Clears the caller org's curriculum override and returns the journey it falls back to — the brand blueprint, else the embedded fixture.
- [List guide](https://docs.hanzo.ai/docs/openapi/guide/get-guide.md): Returns the caller org's launch journey: the active curriculum's version and title, every step with its state, whether it is available, what blocks it and whether the Business AI can run it, the done/total/percent progress with the next step to take, and the org's analytics funnel folded in.
- [List actions](https://docs.hanzo.ai/docs/openapi/guide/get-guide-actions.md): Returns the caller org's Business AI action ledger, most recent first: every "do it for me" tool call, the arguments it ran with, its result and whether it succeeded.
- [List analytics](https://docs.hanzo.ai/docs/openapi/guide/get-guide-analytics.md): Returns the caller org's funnel from the analytics lens plus the GTM recommendations derived from it.
- [List curriculum](https://docs.hanzo.ai/docs/openapi/guide/get-guide-curriculum.md): Returns the journey the caller's org is actually running, and whether it comes from the org's OWN override (custom) or from the platform default — the brand blueprint, else the embedded fixture.
- [List profile](https://docs.hanzo.ai/docs/openapi/guide/get-guide-profile.md): Returns the caller org's OBSERVED growth profile — the signal set, the classified growth stage, and the org's own key metrics.
- [List strategies](https://docs.hanzo.ai/docs/openapi/guide/get-guide-strategies.md): Returns the ENABLED tactics corpus for the caller's org: the tactics library narrowed by the explicit category/workload filters AND by the org's OBSERVED growth stage and capability signals (a tactic's tags are preconditions, so it surfaces only once the org can act on it).
- [List suggest](https://docs.hanzo.ai/docs/openapi/guide/get-guide-suggest.md): Returns the caller org's next-best quests: the available, non-terminal steps of its journey ranked by how much downstream work each unblocks, each with the grounded reason it is a good next move and whether the Business AI can run it, plus the org's funnel and the GTM recommendations derived from it.
- [Create chat](https://docs.hanzo.ai/docs/openapi/guide/post-guide-chat.md): Answers a founder's question about their launch journey as the Business AI coach: it grounds the reply in the org's REAL progress, its ranked available quests and its analytics funnel, and returns those candidate quests alongside so the caller can act on one.
- [Create do](https://docs.hanzo.ai/docs/openapi/guide/post-guide-steps-by-id-do.md): Executes one step of the caller org's journey through that principal's OWN tool plane and answers the action log — `{step, events, state}` — so the caller sees every tool call the agent made and where the step ended up.
- [Create done](https://docs.hanzo.ai/docs/openapi/guide/post-guide-steps-by-id-done.md): Marks one step of the caller org's journey complete and returns the refreshed journey.
- [Create reset](https://docs.hanzo.ai/docs/openapi/guide/post-guide-steps-by-id-reset.md): Returns one step of the caller org's journey to todo — clearing a manual mark or a skip — and returns the refreshed journey.
- [Create skip](https://docs.hanzo.ai/docs/openapi/guide/post-guide-steps-by-id-skip.md): Marks one step of the caller org's journey skipped and returns the refreshed journey.
- [Start steps](https://docs.hanzo.ai/docs/openapi/guide/post-guide-steps-by-id-start.md): Marks one step of the caller org's journey in progress and returns the refreshed journey.
- [Replace curriculum](https://docs.hanzo.ai/docs/openapi/guide/put-guide-curriculum.md): Sets the caller org's OWN curriculum — the per-customer override — and answers the journey now in force with `custom: true`.
- [Help](https://docs.hanzo.ai/docs/openapi/help.md): A support desk: customers file tickets, your team answers them.
- [List articles](https://docs.hanzo.ai/docs/openapi/help/get-help-articles.md): Returns the public knowledge base: the help center's Published, publicly-visible articles as cards.
- [Get articles](https://docs.hanzo.ai/docs/openapi/help/get-help-articles-by-slug.md): Returns one public article by slug, with its body.
- [List categories](https://docs.hanzo.ai/docs/openapi/help/get-help-categories.md): Returns the knowledge-base sections for the public center's navigation — but ONLY the sections that front at least one Published, public article, so an internal (agent-only) category name or description never leaks.
- [Create tickets](https://docs.hanzo.ai/docs/openapi/help/post-help-tickets.md): Files a customer support ticket into the public help center.
- [IAM](https://docs.hanzo.ai/docs/openapi/iam.md): Hanzo's identity provider: users, organizations, applications, and the OIDC/OAuth2 endpoints every Hanzo service authenticates against.
- [Create providers](https://docs.hanzo.ai/docs/openapi/iam/addprovider.md): Adds an identity provider your people can sign in with, or a service your applications send through — a social or enterprise login, an email or SMS sender, a storage or payment connector.
- [Create tokens](https://docs.hanzo.ai/docs/openapi/iam/addtoken.md): Records an access token — the credential an application or integration presents on a caller's behalf.
- [Create webauthn credentials](https://docs.hanzo.ai/docs/openapi/iam/addwebauthncredential.md): Registers a passkey or security key for a person, so they can sign in with their device instead of a password.
- [Create organizations](https://docs.hanzo.ai/docs/openapi/iam/createorganization.md): Makes a new organization — the account your users, applications, roles, projects and workspaces are all named inside.
- [Create sessions](https://docs.hanzo.ai/docs/openapi/iam/createsession.md): Records a sign-in and answers with the cookie id it minted.
- [Delete applications](https://docs.hanzo.ai/docs/openapi/iam/delete-iam-applications-by-owner-by-name.md): Removes an application.
- [Delete audit logs](https://docs.hanzo.ai/docs/openapi/iam/delete-iam-audit-logs-by-owner-by-name.md): Removes an audit entry.
- [Delete certs](https://docs.hanzo.ai/docs/openapi/iam/delete-iam-certs-by-owner-by-name.md): Removes a signing certificate.
- [Delete invitations](https://docs.hanzo.ai/docs/openapi/iam/delete-iam-invitations-by-owner-by-name.md): Withdraws an invitation.
- [Delete keys — DELETE /v1/iam/keys/{owner}/{name}](https://docs.hanzo.ai/docs/openapi/iam/delete-iam-keys-by-owner-by-name.md): Revokes an API key.
- [Delete mfa](https://docs.hanzo.ai/docs/openapi/iam/delete-iam-mfa.md): Turns a factor off, so sign-in stops asking for it.
- [Delete permissions](https://docs.hanzo.ai/docs/openapi/iam/delete-iam-permissions-by-owner-by-name.md): Revokes a permission.
- [Delete projects](https://docs.hanzo.ai/docs/openapi/iam/delete-iam-projects-by-owner-by-name.md): Removes a project.
- [Delete roles](https://docs.hanzo.ai/docs/openapi/iam/delete-iam-roles-by-owner-by-name.md): Removes a role.
- [Delete Users — DELETE /v1/iam/scim/v2/Users/{owner}/{name}](https://docs.hanzo.ai/docs/openapi/iam/delete-iam-scim-v2-users-by-owner-by-name.md): Deprovisions a person — how removing someone in your identity provider removes their access here.
- [Delete service accounts](https://docs.hanzo.ai/docs/openapi/iam/delete-iam-service-accounts-by-name.md): Serves DELETE /v1/iam/service-accounts/:name.
- [Delete teams](https://docs.hanzo.ai/docs/openapi/iam/delete-iam-teams-by-name.md): Removes a team.
- [Delete users — DELETE /v1/iam/users/{owner}/{name}](https://docs.hanzo.ai/docs/openapi/iam/delete-iam-users-by-owner-by-name.md): Removes a person from your organization.
- [Delete keys — DELETE /v1/iam/users/{owner}/{name}/keys](https://docs.hanzo.ai/docs/openapi/iam/delete-iam-users-by-owner-by-name-keys.md): Clears the target user's key of the requested TYPE (immediate revoke).
- [Delete workspaces](https://docs.hanzo.ai/docs/openapi/iam/delete-iam-workspaces-by-owner-by-name.md): Removes a workspace.
- [Delete organizations](https://docs.hanzo.ai/docs/openapi/iam/deleteorganization.md): Removes an organization and everything named inside it.
- [Delete providers](https://docs.hanzo.ai/docs/openapi/iam/deleteprovider.md): Removes a provider.
- [Delete sessions](https://docs.hanzo.ai/docs/openapi/iam/deletesession.md): Signs a person out of one application — the session ends and every browser carrying it stops being authenticated.
- [Delete tokens](https://docs.hanzo.ai/docs/openapi/iam/deletetoken.md): Revokes an access token.
- [Delete webauthn credentials](https://docs.hanzo.ai/docs/openapi/iam/deletewebauthncredential.md): Removes a passkey or security key — what you call when a device is lost.
- [List account](https://docs.hanzo.ai/docs/openapi/iam/get-iam-account.md): Returns the signed-in person's own account and the organization they belong to — what a console reads to draw the account menu.
- [List accounts](https://docs.hanzo.ai/docs/openapi/iam/get-iam-accounts.md): Returns the people signed in on this browser, the most recent sign-in first — what the sign-in page lists when an application asks the person to choose an account.
- [List applications](https://docs.hanzo.ai/docs/openapi/iam/get-iam-applications.md): Returns the applications in one organization, newest first — each product or site your people sign in to, with the sign-in methods and redirect URIs it allows.
- [Get applications](https://docs.hanzo.ai/docs/openapi/iam/get-iam-applications-by-owner-by-name.md): Returns one application: its sign-in methods, its allowed redirect URIs and the client credentials your integration authenticates with.
- [List audit logs](https://docs.hanzo.ai/docs/openapi/iam/get-iam-audit-logs.md): Returns your organization's audit trail, newest first — who did what, when, and from where.
- [Get audit logs](https://docs.hanzo.ai/docs/openapi/iam/get-iam-audit-logs-by-owner-by-name.md): Returns one audit entry in full: the action, the person or key behind it, and the request it came in on.
- [List application](https://docs.hanzo.ai/docs/openapi/iam/get-iam-auth-application.md): Returns everything a login screen needs to draw itself for one application: its branding, and each sign-in method it offers with the provider details that method needs.
- [List methods](https://docs.hanzo.ai/docs/openapi/iam/get-iam-auth-methods.md): Returns the sign-in methods one application actually has switched on, so a login screen can render the right buttons for it without you hard-coding a list that drifts the moment you add a provider.
- [List certs](https://docs.hanzo.ai/docs/openapi/iam/get-iam-certs.md): Returns your organization's signing certificates, newest first — the keys the tokens your applications verify are signed with.
- [Get certs](https://docs.hanzo.ai/docs/openapi/iam/get-iam-certs-by-owner-by-name.md): Returns one signing certificate — its algorithm, its validity window and its public half.
- [List consent](https://docs.hanzo.ai/docs/openapi/iam/get-iam-consent.md): Returns the calling person's own privacy and communication choices.
- [List invitations](https://docs.hanzo.ai/docs/openapi/iam/get-iam-invitations.md): Returns your organization's invitations, newest first — who has been asked to join, on what terms, and how many seats each invitation still has left.
- [Get invitations](https://docs.hanzo.ai/docs/openapi/iam/get-iam-invitations-by-owner-by-name.md): Returns one invitation: who it is for, what it grants on acceptance, and when it expires.
- [List keys](https://docs.hanzo.ai/docs/openapi/iam/get-iam-keys.md): Returns an organization's API keys, newest first — what each is called, what it may reach, its publishable half, and when it was last used.
- [Get keys](https://docs.hanzo.ai/docs/openapi/iam/get-iam-keys-by-owner-by-name.md): Returns one API key: what it is called, what it may reach, and when it was issued.
- [List org](https://docs.hanzo.ai/docs/openapi/iam/get-iam-keys-org.md): Answers which organization a publishable key belongs to — what a service calls to attribute a request that arrived carrying a key shipped in a browser.
- [List principal](https://docs.hanzo.ai/docs/openapi/iam/get-iam-keys-principal.md): Answers who a secret key belongs to — the owner and name a gateway needs to attribute and bill a request that arrived carrying an `sk-`.
- [List linked accounts](https://docs.hanzo.ai/docs/openapi/iam/get-iam-linked-accounts.md): Returns the sign-in identities linked to the calling person's account — every provider they can currently sign in with.
- [List memberships](https://docs.hanzo.ai/docs/openapi/iam/get-iam-memberships.md): Answers either question about who belongs where: which organizations one person can act in, or who can act in one organization.
- [List authorize](https://docs.hanzo.ai/docs/openapi/iam/get-iam-oauth-authorize.md): Starts a sign-in — the address you send a browser to, and the beginning of every OAuth and OpenID Connect flow.
- [List callback](https://docs.hanzo.ai/docs/openapi/iam/get-iam-oauth-callback.md): Completes the round-trip: it resolves and burns the single-use transaction (checking expiry + browser binding), exchanges and verifies the IdP response, links or provisions the local user, and mints the iam authorization code the relying party expects — then redirects to the original redirect_uri with code + state.
- [Logout oauth — GET /v1/iam/oauth/logout](https://docs.hanzo.ai/docs/openapi/iam/get-iam-oauth-logout.md): Ends a sign-in and sends the browser somewhere sensible.
- [List userinfo](https://docs.hanzo.ai/docs/openapi/iam/get-iam-oauth-userinfo.md): Returns the profile claims for whoever the access token belongs to — the standard OpenID Connect way to find out who is calling you without your application storing anything itself.
- [List permissions](https://docs.hanzo.ai/docs/openapi/iam/get-iam-permissions.md): Returns the permissions in one organization, newest first — each one a grant saying which people or roles may do what, and to which resources.
- [Get permissions](https://docs.hanzo.ai/docs/openapi/iam/get-iam-permissions-by-owner-by-name.md): Returns one permission: who it grants to, what it allows, and the resources it covers.
- [List projects](https://docs.hanzo.ai/docs/openapi/iam/get-iam-projects.md): Returns your organization's projects, newest first — the scope people pick between when their work is separated by product or client rather than by team.
- [Get projects](https://docs.hanzo.ai/docs/openapi/iam/get-iam-projects-by-owner-by-name.md): Returns one project: what it is called and how it is set up.
- [List jwks — GET /v1/iam/registry/jwks](https://docs.hanzo.ai/docs/openapi/iam/get-iam-registry-jwks.md): Publishes the public key your registry uses to verify the tokens issued above — the one URL to configure so the registry trusts logins without holding any secret of its own.
- [List token](https://docs.hanzo.ai/docs/openapi/iam/get-iam-registry-token.md): Signs a container client in to your registry.
- [List roles](https://docs.hanzo.ai/docs/openapi/iam/get-iam-roles.md): Returns your organization's roles, newest first — each a named group of people that permissions are granted to.
- [Get roles](https://docs.hanzo.ai/docs/openapi/iam/get-iam-roles-by-owner-by-name.md): Returns one role: who is in it, and the roles it includes.
- [List ResourceTypes](https://docs.hanzo.ai/docs/openapi/iam/get-iam-scim-v2-resourcetypes.md): Returns the kinds of record this directory provisions and the address of each, so your identity provider discovers them rather than having them configured by hand.
- [Get ResourceTypes](https://docs.hanzo.ai/docs/openapi/iam/get-iam-scim-v2-resourcetypes-by-name.md): Returns one provisionable record kind in full.
- [List Schemas](https://docs.hanzo.ai/docs/openapi/iam/get-iam-scim-v2-schemas.md): Returns the attribute definitions this directory understands, so your identity provider knows which fields it may send and what they mean before it sends any.
- [Get Schemas](https://docs.hanzo.ai/docs/openapi/iam/get-iam-scim-v2-schemas-by-id.md): Returns one attribute definition in full.
- [List ServiceProviderConfig](https://docs.hanzo.ai/docs/openapi/iam/get-iam-scim-v2-serviceproviderconfig.md): Tells your identity provider which parts of SCIM this directory supports, so it configures itself instead of you filling in a form.
- [List Users — GET /v1/iam/scim/v2/Users](https://docs.hanzo.ai/docs/openapi/iam/get-iam-scim-v2-users.md): Returns the people in your organization to your identity provider, in the standard SCIM shape, so an IdP can reconcile its directory against ours.
- [Get Users — GET /v1/iam/scim/v2/Users/{owner}/{name}](https://docs.hanzo.ai/docs/openapi/iam/get-iam-scim-v2-users-by-owner-by-name.md): Returns one person in the standard SCIM shape.
- [List service accounts](https://docs.hanzo.ai/docs/openapi/iam/get-iam-service-accounts.md): Returns your organization's service accounts — what each is called and when it was created.
- [List teams](https://docs.hanzo.ai/docs/openapi/iam/get-iam-teams.md): Returns your organization's teams, newest first — each a named set of people that roles and permissions are granted to.
- [Get teams](https://docs.hanzo.ai/docs/openapi/iam/get-iam-teams-by-name.md): Returns one team: who is in it.
- [List users — GET /v1/iam/users](https://docs.hanzo.ai/docs/openapi/iam/get-iam-users.md): Returns a page of the people in an organization, with the total so you can page through the rest.
- [Get users — GET /v1/iam/users/{owner}/{name}](https://docs.hanzo.ai/docs/openapi/iam/get-iam-users-by-owner-by-name.md): Returns one person in your organization, addressed by their username or by their email address.
- [List nonce](https://docs.hanzo.ai/docs/openapi/iam/get-iam-web3-nonce.md): Starts a wallet sign-in: it returns a one-time challenge for the wallet to sign.
- [List begin — GET /v1/iam/webauthn/signin/begin](https://docs.hanzo.ai/docs/openapi/iam/get-iam-webauthn-signin-begin.md): Starts a passkey sign-in: it returns the challenge the person's authenticator signs.
- [List begin — GET /v1/iam/webauthn/signup/begin](https://docs.hanzo.ai/docs/openapi/iam/get-iam-webauthn-signup-begin.md): Starts enrolling a passkey for the signed-in person: it returns the options their browser hands to the authenticator.
- [List jwks — GET /v1/iam/.well-known/jwks](https://docs.hanzo.ai/docs/openapi/iam/get-iam-well-known-jwks.md): Publishes the public keys that verify the tokens issued here — the one URL you point a service at so it can check a token itself, offline, without calling back and without holding any secret of ours.
- [List oauth authorization server](https://docs.hanzo.ai/docs/openapi/iam/get-iam-well-known-oauth-authorization-server.md): Returns the OpenID Connect discovery document — the one URL you point a standards-compliant client at so it can find every other endpoint on its own, instead of you configuring them by hand.
- [List openid configuration](https://docs.hanzo.ai/docs/openapi/iam/get-iam-well-known-openid-configuration.md): Returns the OpenID Connect discovery document — the one URL you point a standards-compliant client at so it can find every other endpoint on its own, instead of you configuring them by hand.
- [List whoami](https://docs.hanzo.ai/docs/openapi/iam/get-iam-whoami.md): Tells you who the current caller is — the lightweight check a page makes on load to decide whether to render signed-in or signed-out.
- [List workspaces](https://docs.hanzo.ai/docs/openapi/iam/get-iam-workspaces.md): Returns your organization's workspaces, newest first — the scope a team works in, alongside projects rather than instead of them.
- [Get workspaces](https://docs.hanzo.ai/docs/openapi/iam/get-iam-workspaces-by-owner-by-name.md): Returns one workspace: what it is called and how it is set up.
- [Get organizations](https://docs.hanzo.ai/docs/openapi/iam/getorganization.md): Returns one organization: its display, its defaults and the sign-in rules everyone in it inherits.
- [Get tombstones](https://docs.hanzo.ai/docs/openapi/iam/getorganizationtombstone.md): Returns what holds a deleted organization's name: when it was deleted and who founded it.
- [Get providers](https://docs.hanzo.ai/docs/openapi/iam/getprovider.md): Returns one provider: what it connects to and how it is configured.
- [Get sessions](https://docs.hanzo.ai/docs/openapi/iam/getsession.md): Returns one person's session in one application — when it began and which browsers or devices are still carrying it.
- [Get tokens](https://docs.hanzo.ai/docs/openapi/iam/gettoken.md): Returns one access token: who and what it was issued to, and when it expires.
- [Get webauthn credentials](https://docs.hanzo.ai/docs/openapi/iam/getwebauthncredential.md): Returns one passkey or security key: whose it is, what device it lives on, and when it was registered.
- [List organizations](https://docs.hanzo.ai/docs/openapi/iam/listorganizations.md): Returns the organizations you can act in, the ones you belong to first and the rest after, newest first, narrowed by an optional query against the name or the display name.
- [List providers](https://docs.hanzo.ai/docs/openapi/iam/listproviders.md): Returns your organization's providers, newest first — the identity providers your people sign in with, and the senders and connectors your applications go through.
- [List sessions](https://docs.hanzo.ai/docs/openapi/iam/listsessions.md): Returns who is currently signed in to an organization, newest first, and can be narrowed to one person or one application.
- [List tokens](https://docs.hanzo.ai/docs/openapi/iam/listtokens.md): Returns the access tokens issued in your organization, newest first, and can be narrowed to one organization.
- [List webauthn credentials](https://docs.hanzo.ai/docs/openapi/iam/listwebauthncredentials.md): Returns the passkeys and security keys registered to one person, newest first — which device each lives on and when it was registered.
- [Update Users](https://docs.hanzo.ai/docs/openapi/iam/patch-iam-scim-v2-users-by-owner-by-name.md): Applies a partial change from your identity provider — one attribute moved, not the whole record resent.
- [Create provision](https://docs.hanzo.ai/docs/openapi/iam/post-iam-admin-provision.md): Sets up an account on someone's behalf — the same onboarding a person gets themselves, driven by one of your own services instead of by them.
- [Create applications](https://docs.hanzo.ai/docs/openapi/iam/post-iam-applications.md): Registers an application in your organization — one product or site your people sign in to, with its own client credentials, sign-in methods and allowed redirect URIs.
- [Create audit logs](https://docs.hanzo.ai/docs/openapi/iam/post-iam-audit-logs.md): Records an audit entry, so activity from your own systems lands in the same trail as everything the Hanzo Cloud records for you.
- [Create identifier](https://docs.hanzo.ai/docs/openapi/iam/post-iam-auth-identifier.md): Answers whether an account holds an email address at an application, and whether that account signs in with a password.
- [Create certs](https://docs.hanzo.ai/docs/openapi/iam/post-iam-certs.md): Adds a signing certificate your applications can verify tokens against — the call you make to stage the next one before a rotation.
- [Create delete membership](https://docs.hanzo.ai/docs/openapi/iam/post-iam-delete-membership.md): Takes away a person's or an application's right to act in an organization.
- [Create invitations](https://docs.hanzo.ai/docs/openapi/iam/post-iam-invitations.md): Issues an invitation to join your organization — the code or link a new member redeems, with the role they arrive holding and the date it stops working.
- [Create accept](https://docs.hanzo.ai/docs/openapi/iam/post-iam-invitations-accept.md): Joins the caller to an organization through an invitation, for a person who already has an account.
- [Send invitations](https://docs.hanzo.ai/docs/openapi/iam/post-iam-invitations-by-owner-by-name-send.md): Emails an invitation to the address it is pinned to: who invited them, to which organization, and the link that joins them.
- [Create keys — POST /v1/iam/keys](https://docs.hanzo.ai/docs/openapi/iam/post-iam-keys.md): Issues an API key.
- [Create link](https://docs.hanzo.ai/docs/openapi/iam/post-iam-link.md): Starts connecting another sign-in identity to the account you are already signed in as.
- [Login iam](https://docs.hanzo.ai/docs/openapi/iam/post-iam-login.md): Signs a person in with the credential they typed, and — when the request is part of an OAuth flow — hands back the one-time code that finishes it.
- [Create memberships](https://docs.hanzo.ai/docs/openapi/iam/post-iam-memberships.md): Lets a person or an application act in an organization.
- [Create preferred](https://docs.hanzo.ai/docs/openapi/iam/post-iam-mfa-preferred.md): Picks which second factor an account is asked for first when it has more than one.
- [Enable setup](https://docs.hanzo.ai/docs/openapi/iam/post-iam-mfa-setup-enable.md): Finishes the enrolment: from here the account's sign-ins ask for this factor.
- [Create initiate](https://docs.hanzo.ai/docs/openapi/iam/post-iam-mfa-setup-initiate.md): Starts enrolling a factor and hands over whatever the person needs to prove they hold it.
- [Create authorize](https://docs.hanzo.ai/docs/openapi/iam/post-iam-oauth-authorize.md): Starts a sign-in — the address you send a browser to, and the beginning of every OAuth and OpenID Connect flow.
- [Create device](https://docs.hanzo.ai/docs/openapi/iam/post-iam-oauth-device.md): Starts a sign-in on a device with no browser and no keyboard — a TV, a CLI, a headless box.
- [Create info](https://docs.hanzo.ai/docs/openapi/iam/post-iam-oauth-device-info.md): Answers "what am I approving?" for a pending device code.
- [Create mfa](https://docs.hanzo.ai/docs/openapi/iam/post-iam-oauth-federation-mfa.md): Completes a sign-in that came in through another identity provider and still owes a second factor.
- [Create introspect](https://docs.hanzo.ai/docs/openapi/iam/post-iam-oauth-introspect.md): Answers whether an access token is still good, and what it is good for — the check a resource server of yours makes before honouring a token it did not mint.
- [Logout oauth — POST /v1/iam/oauth/logout](https://docs.hanzo.ai/docs/openapi/iam/post-iam-oauth-logout.md): Ends a sign-in and sends the browser somewhere sensible.
- [Create refresh token](https://docs.hanzo.ai/docs/openapi/iam/post-iam-oauth-refresh-token.md): Exchanges what your application is holding for the tokens it needs — the one-time code from a finished sign-in, a refresh token, or your own client credentials when the caller is a program rather than a person.
- [Revoke oauth](https://docs.hanzo.ai/docs/openapi/iam/post-iam-oauth-revoke.md): Retires a token before it expires — what you call when someone signs out or a credential may have leaked.
- [Create token — POST /v1/iam/oauth/token](https://docs.hanzo.ai/docs/openapi/iam/post-iam-oauth-token.md): Exchanges what your application is holding for the tokens it needs — the one-time code from a finished sign-in, a refresh token, or your own client credentials when the caller is a program rather than a person.
- [Create userinfo](https://docs.hanzo.ai/docs/openapi/iam/post-iam-oauth-userinfo.md): Returns the profile claims for whoever the access token belongs to — the standard OpenID Connect way to find out who is calling you without your application storing anything itself.
- [Create onboard](https://docs.hanzo.ai/docs/openapi/iam/post-iam-onboard.md): Finishes setting up the account of whoever is calling — it creates their organization if they have none and puts them in it, so a person who has just signed up lands somewhere they can work.
- [Create permissions](https://docs.hanzo.ai/docs/openapi/iam/post-iam-permissions.md): Grants a permission — the call that gives a person or a role the ability to do something.
- [Create preferences](https://docs.hanzo.ai/docs/openapi/iam/post-iam-preferences.md): Saves the calling person's own settings and returns the full set afterwards.
- [Create projects](https://docs.hanzo.ai/docs/openapi/iam/post-iam-projects.md): Makes a project inside your organization — the scope people pick between when their work is separated by product or client rather than by team.
- [Create token — POST /v1/iam/registry/token](https://docs.hanzo.ai/docs/openapi/iam/post-iam-registry-token.md): Signs a container client in to your registry.
- [Create roles](https://docs.hanzo.ai/docs/openapi/iam/post-iam-roles.md): Makes a role — a named group of people that permissions are granted to.
- [Create Users — POST /v1/iam/scim/v2/Users](https://docs.hanzo.ai/docs/openapi/iam/post-iam-scim-v2-users.md): Provisions a person from your identity provider — how a new hire gets an account here automatically when they are added over there.
- [Create service accounts](https://docs.hanzo.ai/docs/openapi/iam/post-iam-service-accounts.md): Makes a service account — an identity for a program rather than a person, for a script, a bot or a deployment that has to authenticate on its own.
- [Create keys — POST /v1/iam/service-accounts/{name}/keys](https://docs.hanzo.ai/docs/openapi/iam/post-iam-service-accounts-by-name-keys.md): Serves POST /v1/iam/service-accounts/:name/keys: mint a fresh key, invalidating the prior one, and return the new raw secret exactly once.
- [Signin iam](https://docs.hanzo.ai/docs/openapi/iam/post-iam-signin.md): Completes a sign-in: it exchanges the one-time code your application was handed at the end of the login flow for a live session, and returns the signed-in account.
- [Signup iam](https://docs.hanzo.ai/docs/openapi/iam/post-iam-signup.md): Creates an account from the sign-up form and applies the application's own sign-up rules — whether self-service registration is open at all, and which fields it requires.
- [Create teams](https://docs.hanzo.ai/docs/openapi/iam/post-iam-teams.md): Makes a team — a named set of people that roles and permissions grant to.
- [Create issue](https://docs.hanzo.ai/docs/openapi/iam/post-iam-tokens-issue.md): Mints an access token for the `?id=<owner>/<name>` target user (optional `?aud=` resource, RFC 8707), issued by the authenticated + allow-listed confidential client.
- [Create unlink](https://docs.hanzo.ai/docs/openapi/iam/post-iam-unlink.md): Disconnects one sign-in identity from an account, so that provider can no longer be used to sign in as that person.
- [Create users — POST /v1/iam/users](https://docs.hanzo.ai/docs/openapi/iam/post-iam-users.md): Adds a person to your organization.
- [Create keys — POST /v1/iam/users/{owner}/{name}/keys](https://docs.hanzo.ai/docs/openapi/iam/post-iam-users-by-owner-by-name-keys.md): (re)generates the target user's key of the requested TYPE and returns it once, over the shared authorizeMinter + mintTarget seam.
- [Create verification codes](https://docs.hanzo.ai/docs/openapi/iam/post-iam-verification-codes.md): Validates the request and asks otp to get a code to the person.
- [Verify web3](https://docs.hanzo.ai/docs/openapi/iam/post-iam-web3-verify.md): Completes a wallet sign-in: it verifies the signed challenge and, if it holds, signs the wallet's owner in.
- [Create finish — POST /v1/iam/webauthn/signin/finish](https://docs.hanzo.ai/docs/openapi/iam/post-iam-webauthn-signin-finish.md): Verifies the signed challenge and signs the person in.
- [Create finish — POST /v1/iam/webauthn/signup/finish](https://docs.hanzo.ai/docs/openapi/iam/post-iam-webauthn-signup-finish.md): Verifies the newly created passkey and stores it, so the person can sign in with their device from then on.
- [Create workspaces](https://docs.hanzo.ai/docs/openapi/iam/post-iam-workspaces.md): Makes a workspace inside your organization — the scope a team works in, alongside projects rather than instead of them.
- [Replace account](https://docs.hanzo.ai/docs/openapi/iam/put-iam-account.md): Saves the calling person's own profile — the name they are shown by, their picture, a line about themselves and a link.
- [Replace applications](https://docs.hanzo.ai/docs/openapi/iam/put-iam-applications-by-owner-by-name.md): Changes an application's display, its sign-in methods and the redirect URIs it may return to — the call that makes login work from a new host.
- [Replace audit logs](https://docs.hanzo.ai/docs/openapi/iam/put-iam-audit-logs-by-owner-by-name.md): Corrects an audit entry.
- [Replace certs](https://docs.hanzo.ai/docs/openapi/iam/put-iam-certs-by-owner-by-name.md): Changes a signing certificate's settings.
- [Replace consent](https://docs.hanzo.ai/docs/openapi/iam/put-iam-consent.md): Records the calling person's privacy and communication choices.
- [Replace invitations](https://docs.hanzo.ai/docs/openapi/iam/put-iam-invitations-by-owner-by-name.md): Changes an invitation's terms — the role it grants, how many may redeem it, or when it expires.
- [Replace keys](https://docs.hanzo.ai/docs/openapi/iam/put-iam-keys-by-owner-by-name.md): Changes what a key is called, what it may reach, when it expires, or revokes it.
- [Replace password](https://docs.hanzo.ai/docs/openapi/iam/put-iam-password.md): Replaces the calling person's password.
- [Replace permissions](https://docs.hanzo.ai/docs/openapi/iam/put-iam-permissions-by-owner-by-name.md): Changes who a permission grants to, what it allows, or the resources it covers.
- [Replace projects](https://docs.hanzo.ai/docs/openapi/iam/put-iam-projects-by-owner-by-name.md): Changes a project's settings.
- [Replace roles](https://docs.hanzo.ai/docs/openapi/iam/put-iam-roles-by-owner-by-name.md): Changes who is in a role, or which roles it includes.
- [Replace Users — PUT /v1/iam/scim/v2/Users/{owner}/{name}](https://docs.hanzo.ai/docs/openapi/iam/put-iam-scim-v2-users-by-owner-by-name.md): Overwrites a person's SCIM attributes with what your identity provider sends — how a change made there lands here.
- [Replace teams](https://docs.hanzo.ai/docs/openapi/iam/put-iam-teams-by-name.md): Changes who is in a team.
- [Replace terms](https://docs.hanzo.ai/docs/openapi/iam/put-iam-terms.md): Records that the signed-in caller accepted the terms and the acceptable use policy, at the versions named.
- [Replace users — PUT /v1/iam/users/{owner}/{name}](https://docs.hanzo.ai/docs/openapi/iam/put-iam-users-by-owner-by-name.md): Changes a person's profile, their roles, or the credentials they sign in with.
- [Replace workspaces](https://docs.hanzo.ai/docs/openapi/iam/put-iam-workspaces-by-owner-by-name.md): Changes a workspace's settings.
- [Delete tombstones](https://docs.hanzo.ai/docs/openapi/iam/releaseorganizationname.md): Frees the name of a deleted organization so it can be founded again.
- [Create avatar](https://docs.hanzo.ai/docs/openapi/iam/setorganizationavatar.md): Changes how an organization appears across Hanzo: the square mark beside its name, as an uploaded image or as a single emoji.
- [Create profile](https://docs.hanzo.ai/docs/openapi/iam/setorganizationprofile.md): Changes how an organization reads: its display name, its website and its favicon.
- [Replace organizations](https://docs.hanzo.ai/docs/openapi/iam/updateorganization.md): Changes an organization's display, its defaults and the sign-in rules everyone in it inherits.
- [Replace providers](https://docs.hanzo.ai/docs/openapi/iam/updateprovider.md): Changes a provider's settings or rotates the credentials it holds.
- [Replace sessions](https://docs.hanzo.ai/docs/openapi/iam/updatesession.md): Names the browsers a session keeps — signing out the ones you leave off while the session itself stays live.
- [Replace tokens](https://docs.hanzo.ai/docs/openapi/iam/updatetoken.md): Changes an access token's scope or expiry.
- [Replace webauthn credentials](https://docs.hanzo.ai/docs/openapi/iam/updatewebauthncredential.md): Renames a registered passkey or security key, so a person can tell their devices apart.
- [Upsert applications](https://docs.hanzo.ai/docs/openapi/iam/upsertapplication.md): Creates an application or updates it in place, so a deployment can declare the applications it needs and run the same declaration on every environment and on every redeploy.
- [Upsert users](https://docs.hanzo.ai/docs/openapi/iam/upsertuser.md): Creates a person or updates them in place, so a deployment can declare the accounts it needs and re-run that declaration safely.
- [Index](https://docs.hanzo.ai/docs/openapi/index.md): Fast full-text search over your own data, typos forgiven.
- [Delete indexes](https://docs.hanzo.ai/docs/openapi/index/delete-index-indexes-by-uid.md): Deletes an index and everything in it.
- [Delete documents](https://docs.hanzo.ai/docs/openapi/index/delete-index-indexes-by-uid-documents-by-id.md): Deletes one document by its primary key.
- [List health](https://docs.hanzo.ai/docs/openapi/index/get-index-health.md): Reports whether the search plane can serve.
- [List indexes](https://docs.hanzo.ai/docs/openapi/index/get-index-indexes.md): Lists the indexes your org holds.
- [Get indexes](https://docs.hanzo.ai/docs/openapi/index/get-index-indexes-by-uid.md): Reads one index's definition.
- [List documents](https://docs.hanzo.ai/docs/openapi/index/get-index-indexes-by-uid-documents.md): Pages through the documents in an index.
- [Get documents](https://docs.hanzo.ai/docs/openapi/index/get-index-indexes-by-uid-documents-by-id.md): Reads one document by its primary key.
- [List settings](https://docs.hanzo.ai/docs/openapi/index/get-index-indexes-by-uid-settings.md): Reads an index's filterable attributes.
- [List stats](https://docs.hanzo.ai/docs/openapi/index/get-index-stats.md): Counts the documents in each of your indexes.
- [Get tasks](https://docs.hanzo.ai/docs/openapi/index/get-index-tasks-by-uid.md): Checks a write task, which has already finished.
- [List version](https://docs.hanzo.ai/docs/openapi/index/get-index-version.md): Identifies the search implementation answering.
- [Update settings](https://docs.hanzo.ai/docs/openapi/index/patch-index-indexes-by-uid-settings.md): Sets which attributes an index can be filtered on.
- [Create indexes](https://docs.hanzo.ai/docs/openapi/index/post-index-indexes.md): Creates an index.
- [Create documents](https://docs.hanzo.ai/docs/openapi/index/post-index-indexes-by-uid-documents.md): Writes documents into the caller's own index, keyed by the index's primary key: a document whose key is already present is REPLACED whole.
- [Create delete batch](https://docs.hanzo.ai/docs/openapi/index/post-index-indexes-by-uid-documents-delete-batch.md): Removes every named document from the caller's own index.
- [Search indexes](https://docs.hanzo.ai/docs/openapi/index/post-index-indexes-by-uid-search.md): Searches an index, forgiving typos.
- [Replace documents](https://docs.hanzo.ai/docs/openapi/index/put-index-indexes-by-uid-documents.md): The dialect's update spelling of the write above, and the same act: an upsert keyed by the index's primary key.
- [Ingress](https://docs.hanzo.ai/docs/openapi/ingress.md): Your edge: automatic TLS certificates and hostname routing to any backend, changed live.
- [Delete middlewares](https://docs.hanzo.ai/docs/openapi/ingress/delete-ingress-middlewares-by-id.md): Removes one of the caller org's edge transforms and hot-applies the change.
- [Delete routes](https://docs.hanzo.ai/docs/openapi/ingress/delete-ingress-routes-by-id.md): Removes one of the caller org's routing rules and hot-applies the shrunken table, freeing its host for another claim.
- [Delete services](https://docs.hanzo.ai/docs/openapi/ingress/delete-ingress-services-by-id.md): Removes one of the caller org's backend pools and hot-applies the change.
- [List middlewares](https://docs.hanzo.ai/docs/openapi/ingress/get-ingress-middlewares.md): Returns every edge transform the caller's org has configured, ordered by id.
- [Get middlewares](https://docs.hanzo.ai/docs/openapi/ingress/get-ingress-middlewares-by-id.md): Returns one of the caller org's edge transforms by id.
- [List routes](https://docs.hanzo.ai/docs/openapi/ingress/get-ingress-routes.md): Returns every routing rule the caller's org has configured, ordered by id.
- [Get routes](https://docs.hanzo.ai/docs/openapi/ingress/get-ingress-routes-by-id.md): Returns one of the caller org's routing rules by id.
- [List services](https://docs.hanzo.ai/docs/openapi/ingress/get-ingress-services.md): Returns every backend pool the caller's org has configured, ordered by id.
- [Get services](https://docs.hanzo.ai/docs/openapi/ingress/get-ingress-services-by-id.md): Returns one of the caller org's backend pools by id.
- [List status](https://docs.hanzo.ai/docs/openapi/ingress/get-ingress-status.md): Reports the ingress edge's live posture: the role this instance runs in (app or edge), whether its listeners are bound and on which addresses, the ACME posture (staging flag and certificate cache directory), how many hosts the compiled route table currently serves, and how many the ACME HostPolicy will issue a certificate for.
- [List tls](https://docs.hanzo.ai/docs/openapi/ingress/get-ingress-tls.md): Returns the caller org's ACME intent together with the edge-wide TLS facts it lands in: which role this instance runs in, whether its listeners are bound, every host the ACME HostPolicy will issue a certificate for (the union across ALL orgs of TLS-marked routes and configured extraHosts, because one process holds one certificate cache), and the ACME directory and account email the process was started with.
- [Create middlewares](https://docs.hanzo.ai/docs/openapi/ingress/post-ingress-middlewares.md): Creates or replaces one edge transform and hot-applies it.
- [Create routes](https://docs.hanzo.ai/docs/openapi/ingress/post-ingress-routes.md): Creates or replaces one routing rule and hot-applies the new table — there is no config file and no restart.
- [Create services](https://docs.hanzo.ai/docs/openapi/ingress/post-ingress-services.md): Creates or replaces one backend pool and hot-applies it.
- [Replace middlewares](https://docs.hanzo.ai/docs/openapi/ingress/put-ingress-middlewares-by-id.md): Creates or replaces one edge transform and hot-applies it.
- [Replace routes](https://docs.hanzo.ai/docs/openapi/ingress/put-ingress-routes-by-id.md): Creates or replaces one routing rule and hot-applies the new table — there is no config file and no restart.
- [Replace services](https://docs.hanzo.ai/docs/openapi/ingress/put-ingress-services-by-id.md): Creates or replaces one backend pool and hot-applies it.
- [Replace tls](https://docs.hanzo.ai/docs/openapi/ingress/put-ingress-tls.md): Replaces the caller org's ACME intent and hot-applies what can be hot-applied.
- [Kafka](https://docs.hanzo.ai/docs/openapi/kafka.md): Kafka — reached at :9092; not in the public REST contract.
- [KMS](https://docs.hanzo.ai/docs/openapi/kms.md): Secret custody: your org's secrets sealed at rest, plus threshold signing.
- [List config](https://docs.hanzo.ai/docs/openapi/kms/get-kms-config.md): Returns the runtime configuration for the KMS console.
- [List health](https://docs.hanzo.ai/docs/openapi/kms/get-kms-health.md): Reports whether this broker can actually serve secrets.
- [List secrets](https://docs.hanzo.ai/docs/openapi/kms/get-kms-secrets.md): Lists the secrets your org holds, without their values.
- [Login auth](https://docs.hanzo.ai/docs/openapi/kms/post-kms-auth-login.md): Exchanges a machine credential for an IAM bearer token.
- [Create secrets](https://docs.hanzo.ai/docs/openapi/kms/post-kms-secrets.md): Stores or replaces one secret in your org.
- [Knowledge](https://docs.hanzo.ai/docs/openapi/knowledge.md): Your team's wiki and your agents' memory, searchable by meaning.
- [Delete connectors](https://docs.hanzo.ai/docs/openapi/knowledge/delete-knowledge-connectors-by-provider.md): Revokes a connection: it tombstones the stored credential so a later sync cannot reuse it, removes this provider's passages from the org's store, and marks the connector disconnected.
- [Delete files](https://docs.hanzo.ai/docs/openapi/knowledge/delete-knowledge-files-by-id.md): Removes one of the caller's org files from the index — its table of contents, passages, full-text rows, mentions and links — and its record.
- [List connectors](https://docs.hanzo.ai/docs/openapi/knowledge/get-knowledge-connectors.md): Returns every supported knowledge connector with THIS org's connection state and the REAL number of documents each has ingested into the org's store.
- [List callback](https://docs.hanzo.ai/docs/openapi/knowledge/get-knowledge-connectors-by-provider-callback.md): Finishes an OAuth connection: it exchanges the provider's code for a token, seals that token in KMS, and records the connection.
- [Connect connectors](https://docs.hanzo.ai/docs/openapi/knowledge/get-knowledge-connectors-by-provider-connect.md): Returns the provider authorize URL the console opens to connect this org's account.
- [List catalog](https://docs.hanzo.ai/docs/openapi/knowledge/get-knowledge-connectors-catalog.md): Returns the ONE catalog of everything a caller can connect: every first-party connector and every long-tail one, in a single list sorted by provider.
- [List files](https://docs.hanzo.ai/docs/openapi/knowledge/get-knowledge-files.md): Answers the caller's org files, most recently changed first, each with its status and stage — optionally only those in one bucket, which is how Drive shows a folder's files with their index state.
- [Get files](https://docs.hanzo.ai/docs/openapi/knowledge/get-knowledge-files-by-id.md): Answers one of the caller's org files: what it is, where its bytes are, and how far its ingest has got.
- [List graph — GET /v1/knowledge/files/{id}/graph](https://docs.hanzo.ai/docs/openapi/knowledge/get-knowledge-files-by-id-graph.md): Answers one of the caller's org files' place in the org's graph: the files it links to and is linked from (a hyperlink, a citation by name), the files that name the same entities, and the entities it names.
- [Get sections](https://docs.hanzo.ai/docs/openapi/knowledge/get-knowledge-files-by-id-sections-by-section.md): Answers one section of one of the caller's org files: its own text, its subsections, the sections it links to or shares entities with — in this file or another — and the entities it names.
- [List toc](https://docs.hanzo.ai/docs/openapi/knowledge/get-knowledge-files-by-id-toc.md): Answers one of the caller's org files' table of contents: every section in document order with its depth, its parent and a one-line summary.
- [List graph — GET /v1/knowledge/graph](https://docs.hanzo.ai/docs/openapi/knowledge/get-knowledge-graph.md): Returns the caller org's knowledge as a node/edge graph shaped for a force-directed renderer: pages, memories and synced sources as nodes; the page parent tree, the wikilinks between pages, and each source's connector provenance as edges.
- [Sync connectors](https://docs.hanzo.ai/docs/openapi/knowledge/post-knowledge-connectors-by-provider-sync.md): Pulls the provider's documents for the caller's org and files them as knowledge sources, which the store's own hook then indexes — so a synced document is retrievable exactly like a hand-written page.
- [Create files](https://docs.hanzo.ai/docs/openapi/knowledge/post-knowledge-files.md): Makes an object in one of the caller's org buckets a workspace file.
- [Create retrieve](https://docs.hanzo.ai/docs/openapi/knowledge/post-knowledge-files-retrieve.md): Grounds an answer in the caller's org files, table of contents first: candidate documents are found by searching their passages; a model reads their tables of contents — titles and one-line summaries — and picks the sections the answer is in; hybrid search drills into the passages of those sections; and the graph expands to the sections they link to or name the same entities as, in any file of the workspace.
- [Search files](https://docs.hanzo.ai/docs/openapi/knowledge/post-knowledge-files-search.md): Answers the passages of the caller's org files that match a query, each citing its file › section › paragraph: the search behind Drive's box, and the first step an agent takes across a workspace.
- [Import knowledge](https://docs.hanzo.ai/docs/openapi/knowledge/post-knowledge-import.md): Ingests an uploaded export as a tree of kb.page documents with its link structure intact.
- [Create reindex](https://docs.hanzo.ai/docs/openapi/knowledge/post-knowledge-reindex.md): Rebuilds the caller org's retrieval from its documents: every passage is removed, and every page, memory and source is cut into passages and embedded again with the configured model; the lexical index is reconciled to the same documents.
- [Search knowledge](https://docs.hanzo.ai/docs/openapi/knowledge/post-knowledge-search.md): Runs a hybrid search over the caller org's own knowledge — its wiki pages, its agent memories and everything its connectors have synced.
- [KV](https://docs.hanzo.ai/docs/openapi/kv.md): Your key-value store: buckets of versioned values your apps read and write by key.
- [Delete kv — DELETE /v1/kv/{bucket}](https://docs.hanzo.ai/docs/openapi/kv/delete-kv-by-bucket.md): Removes one bucket of the caller's org — every key and every revision with it — and answers 204 with no body.
- [Delete kv — DELETE /v1/kv/{bucket}/{key}](https://docs.hanzo.ai/docs/openapi/kv/delete-kv-by-bucket-by-key.md): Removes one key — a delete marker in the key's history, so watchers see it and Get answers 404 — and answers 204 with no body.
- [Get kv](https://docs.hanzo.ai/docs/openapi/kv/get-kv-by-bucket-by-key.md): Returns one key's current value and revision.
- [List history](https://docs.hanzo.ai/docs/openapi/kv/get-kv-by-bucket-by-key-history.md): Returns one key's retained revisions, oldest first — every put and every delete marker up to the bucket's History depth.
- [Create kv](https://docs.hanzo.ai/docs/openapi/kv/post-kv-by-bucket.md): Creates a KV bucket and returns it.
- [Replace kv](https://docs.hanzo.ai/docs/openapi/kv/put-kv-by-bucket-by-key.md): Sets one key to one value and returns the revision the write created.
- [Label](https://docs.hanzo.ai/docs/openapi/label.md): The ground-truth plane: what actually turned out to be fraud, who said so, and when they could first have said it.
- [Create dispose](https://docs.hanzo.ai/docs/openapi/label/riskdisposelabels.md): Applies this tenant's retention, and only this tenant's.
- [Create hold](https://docs.hanzo.ai/docs/openapi/label/riskholdlabels.md): Places or releases a litigation hold on named records.
- [Create label](https://docs.hanzo.ai/docs/openapi/label/risklabel.md): Records a batch of ground truth against the entities it judges.
- [List coverage](https://docs.hanzo.ai/docs/openapi/label/risklabelcoverage.md): Reports how much of a window has matured and how much of that is judged, per source.
- [List label](https://docs.hanzo.ai/docs/openapi/label/risklabels.md): Reads the assertions this tenant has recorded, newest event first.
- [List vocabulary](https://docs.hanzo.ai/docs/openapi/label/risklabelvocabulary.md): Publishes the closed vocabularies and the precedence rule that resolves a conflict between two sources.
- [Resolve label](https://docs.hanzo.ai/docs/openapi/label/riskresolvelabels.md): Answers, for each named event, which assertion was in force AS OF that event's own horizon — and what disagreed with it.
- [Leaderboard](https://docs.hanzo.ai/docs/openapi/leaderboard.md): The ranking of who uses AI most, in your org and globally.
- [List leaderboard](https://docs.hanzo.ai/docs/openapi/leaderboard/get-leaderboard.md): Ranks AI usage over a window, either the users of the caller's own org or organizations against each other, and always reports the caller's own standing even when it falls outside the returned page.
- [List activity](https://docs.hanzo.ai/docs/openapi/leaderboard/get-leaderboard-activity.md): Returns the per-day usage series for ONE authorized subject — the points a contribution heatmap and a timeline are drawn from, gap-filled so every day in the range is present.
- [List optin](https://docs.hanzo.ai/docs/openapi/leaderboard/get-leaderboard-optin.md): Returns the caller's own public-listing preference and their org's, each with whether the caller may change it.
- [Replace optin](https://docs.hanzo.ai/docs/openapi/leaderboard/put-leaderboard-optin.md): Sets the CALLER's own public-listing preference on the leaderboard.
- [Replace org](https://docs.hanzo.ai/docs/openapi/leaderboard/put-leaderboard-optin-org.md): Sets the ORG's listing on the cross-org global board.
- [Legal](https://docs.hanzo.ai/docs/openapi/legal.md): The paperwork your company needs, drafted, signed and filed.
- [List documents](https://docs.hanzo.ai/docs/openapi/legal/get-legal-documents.md): Returns the org's generated documents, newest first, WITHOUT their rendered content — fetch one document to read its body.
- [Get documents](https://docs.hanzo.ai/docs/openapi/legal/get-legal-documents-by-id.md): Returns one of the org's documents WITH its rendered body.
- [List filings](https://docs.hanzo.ai/docs/openapi/legal/get-legal-filings.md): Returns the org's filing records, newest first — which documents were filed where, through which provider, and what the filing's honest status is.
- [List health](https://docs.hanzo.ai/docs/openapi/legal/get-legal-health.md): Reports that the legal subsystem is serving and how many built-in templates its catalog carries.
- [List templates](https://docs.hanzo.ai/docs/openapi/legal/get-legal-templates.md): Returns the org's effective template catalog: every built-in template, with any the org has overridden replaced by its own latest version.
- [Get templates](https://docs.hanzo.ai/docs/openapi/legal/get-legal-templates-by-id.md): Returns one template resolved for the caller's org — the org's own override if it has saved one, else the built-in — with its full text/template body and its declared merge fields.
- [Create documents](https://docs.hanzo.ai/docs/openapi/legal/post-legal-documents.md): Renders a document from a template and the caller's own merge data, seals it in the org's store, and returns it with its rendered body.
- [Create sign](https://docs.hanzo.ai/docs/openapi/legal/post-legal-documents-by-id-sign.md): Opens an e-signature request over one document and moves it to out_for_signature, returning the provider's reference for the request.
- [Complete sign](https://docs.hanzo.ai/docs/openapi/legal/post-legal-documents-by-id-sign-complete.md): Records completion of the signature request opened over a generated document and answers the document with a `signed` flag.
- [Create filings](https://docs.hanzo.ai/docs/openapi/legal/post-legal-filings.md): Records a filing of one or more of the org's documents with a state or agency, and returns the tracking record.
- [Replace templates](https://docs.hanzo.ai/docs/openapi/legal/put-legal-templates-by-id.md): Saves the org's own version of a template — a custom NDA, a house MSA — and returns it with its new version number.
- [Licensing](https://docs.hanzo.ai/docs/openapi/licensing.md): What an org has bought and may run: signed licenses to issue, verify and revoke, and the releases they unlock.
- [Get download](https://docs.hanzo.ai/docs/openapi/licensing/get-licensing-download-by-release.md): Resolves a release to its artifact, gated on a valid license.
- [List healthz](https://docs.hanzo.ai/docs/openapi/licensing/get-licensing-healthz.md): Reports which signer this deployment mints with, and in which env.
- [List jwks](https://docs.hanzo.ai/docs/openapi/licensing/get-licensing-jwks.md): Publishes the Ed25519 PUBLIC verification key, at both /pubkey and /jwks.
- [List pubkey](https://docs.hanzo.ai/docs/openapi/licensing/get-licensing-pubkey.md): Publishes the Ed25519 PUBLIC verification key, at both /pubkey and /jwks.
- [List releases](https://docs.hanzo.ai/docs/openapi/licensing/get-licensing-releases.md): Lists the signed binary releases this deployment can serve.
- [Get releases](https://docs.hanzo.ai/docs/openapi/licensing/get-licensing-releases-by-release.md): Reads one release's metadata: its product, version, platform and the cosign material a client verifies the binary against.
- [Create fingerprint](https://docs.hanzo.ai/docs/openapi/licensing/post-licensing-fingerprint.md): Turns raw device signals into the opaque value that binds a license to one machine.
- [Create issue](https://docs.hanzo.ai/docs/openapi/licensing/post-licensing-issue.md): Mints a signed license token for a product the caller's org already pays for.
- [Verify licensing](https://docs.hanzo.ai/docs/openapi/licensing/post-licensing-verify.md): Checks a license token online: signature, schema, expiry, app_id and the revocation list.
- [Link](https://docs.hanzo.ai/docs/openapi/link.md): The unified AI login manager's registry: the org+user-scoped record of WHICH provider accounts (Claude Max, ChatGPT Plus, a Hanzo API key, a raw provider key) a developer has signed into, ON WHICH MACHINES, with each account's latest usage snapshot.
- [Delete link](https://docs.hanzo.ai/docs/openapi/link/delete-link-by-id.md): Logs out one account and stops the sessions it was running.
- [List link](https://docs.hanzo.ai/docs/openapi/link/get-link.md): Lists your linked accounts and the devices they sit on.
- [Get link](https://docs.hanzo.ai/docs/openapi/link/get-link-by-id.md): Reads one linked account.
- [Get devices](https://docs.hanzo.ai/docs/openapi/link/get-link-devices-by-machine.md): Shows one machine: its accounts, usage and live sessions.
- [List route](https://docs.hanzo.ai/docs/openapi/link/get-link-route.md): Gets the failover order across your linked accounts.
- [List usage](https://docs.hanzo.ai/docs/openapi/link/get-link-usage.md): Shows one provider account's own usage dashboard.
- [List accounts](https://docs.hanzo.ai/docs/openapi/link/get-link-usage-accounts.md): Breaks down what the gateway routed through each of your accounts.
- [List summary](https://docs.hanzo.ai/docs/openapi/link/get-link-usage-summary.md): Shows plan consumption and Hanzo spend side by side.
- [Create link](https://docs.hanzo.ai/docs/openapi/link/post-link.md): Registers a signed-in AI provider account on a machine.
- [Revoke devices](https://docs.hanzo.ai/docs/openapi/link/post-link-devices-by-machine-revoke.md): Logs out every account on one machine and stops its sessions.
- [Create usage](https://docs.hanzo.ai/docs/openapi/link/post-link-usage.md): Reports usage samples from the device collector.
- [LSP](https://docs.hanzo.ai/docs/openapi/lsp.md): Live semantic code intelligence — definitions, references, types, hover, outline and diagnostics — over a repository AND its resolved dependencies, with no toolchain on the caller's machine.
- [Complete lsp](https://docs.hanzo.ai/docs/openapi/lsp/post-lsp-complete.md): Offers the candidates a language server has at a position, typed and resolved through the repository's dependencies rather than guessed from text.
- [Create diagnostics](https://docs.hanzo.ai/docs/openapi/lsp/post-lsp-diagnostics.md): Reports every problem the language server finds in one file — compile errors, type errors and lints, each with its span and its severity (1 error, 2 warning, 3 information, 4 hint).
- [Create hover](https://docs.hanzo.ai/docs/openapi/lsp/post-lsp-hover.md): Renders the type and documentation of the symbol at a position, as the language server itself renders it.
- [Create locate](https://docs.hanzo.ai/docs/openapi/lsp/post-lsp-locate.md): Finds where a symbol lives: its definition, its references, its type or its implementations, chosen by relation (definition, reference, type, implementation — empty means definition).
- [Create symbols](https://docs.hanzo.ai/docs/openapi/lsp/post-lsp-symbols.md): Outlines one file: every declaration in it, with its kind and its span.
- [Market](https://docs.hanzo.ai/docs/openapi/market.md): What trades on each chain, and how far the read of it got.
- [List chains](https://docs.hanzo.ai/docs/openapi/market/get-market-chains.md): Answers every chain this deployment can read, what is deployed on each, and what its automated market maker amounts to.
- [List pools](https://docs.hanzo.ai/docs/openapi/market/get-market-pools.md): Answers the automated market makers on one chain: their two tokens, their fee tier, and what has moved through each.
- [List survey](https://docs.hanzo.ai/docs/openapi/market/get-market-survey.md): Answers which of the four settlement precompiles carry code on one chain.
- [List token](https://docs.hanzo.ai/docs/openapi/market/get-market-token.md): Answers one token's daily history — open, high, low, close, price and volume per UTC day, oldest first.
- [List tokens](https://docs.hanzo.ai/docs/openapi/market/get-market-tokens.md): Answers the tokens one chain's indexer has seen, with the decimals a caller needs to read any amount of one correctly.
- [Marketing](https://docs.hanzo.ai/docs/openapi/marketing.md): Lifecycle email: drip sequences that reach the right people.
- [Delete audiences](https://docs.hanzo.ai/docs/openapi/marketing/delete-marketing-audiences-by-id.md): Removes one of the caller org's audiences and answers 204.
- [Delete calendar](https://docs.hanzo.ai/docs/openapi/marketing/delete-marketing-calendar-by-id.md): Removes one of the caller org's posts and answers 204.
- [Delete campaigns](https://docs.hanzo.ai/docs/openapi/marketing/delete-marketing-campaigns-by-id.md): Removes one of the caller org's campaigns and answers 204.
- [Delete suppressions](https://docs.hanzo.ai/docs/openapi/marketing/delete-marketing-suppressions.md): Re-subscribes an address on one channel and answers 204.
- [List audiences](https://docs.hanzo.ai/docs/openapi/marketing/get-marketing-audiences.md): Returns the org's saved audiences, most recently updated first.
- [Get audiences](https://docs.hanzo.ai/docs/openapi/marketing/get-marketing-audiences-by-id.md): Returns one of the caller org's saved audiences.
- [Preview audiences](https://docs.hanzo.ai/docs/openapi/marketing/get-marketing-audiences-by-id-preview.md): Evaluates the cohort LIVE — the same resolution an enrollment would run — and reports how big it is and how many real mailboxes it reaches.
- [List calendar](https://docs.hanzo.ai/docs/openapi/marketing/get-marketing-calendar.md): Returns the org's calendar, latest scheduled first, optionally narrowed to one status.
- [Get calendar](https://docs.hanzo.ai/docs/openapi/marketing/get-marketing-calendar-by-id.md): Returns one of the caller org's posts, including the exact error behind a failed publish.
- [List campaigns](https://docs.hanzo.ai/docs/openapi/marketing/get-marketing-campaigns.md): Returns the org's campaigns, most recently updated first, optionally narrowed to one lifecycle status.
- [Get campaigns](https://docs.hanzo.ai/docs/openapi/marketing/get-marketing-campaigns-by-id.md): Returns one of the caller org's campaigns.
- [List promos](https://docs.hanzo.ai/docs/openapi/marketing/get-marketing-promos.md): Returns every promo the deployment offers with its live counters: how many orgs have redeemed it and how many redemptions remain under the cap.
- [List eligibility](https://docs.hanzo.ai/docs/openapi/marketing/get-marketing-promos-by-code-eligibility.md): Prices a promo against a plan and seat count.
- [List redemption](https://docs.hanzo.ai/docs/openapi/marketing/get-marketing-promos-by-code-redemption.md): Returns the caller org's OWN redemption of a promo — an org-scoped read, so it can never surface another tenant's.
- [List sequences](https://docs.hanzo.ai/docs/openapi/marketing/get-marketing-sequences.md): Returns the org's drip sequences, most recently updated first.
- [Get sequences](https://docs.hanzo.ai/docs/openapi/marketing/get-marketing-sequences-by-id.md): Returns one of the caller org's sequences together with its steps in send order.
- [List enrollments](https://docs.hanzo.ai/docs/openapi/marketing/get-marketing-sequences-by-id-enrollments.md): Returns who is walking one sequence, most recently enrolled first, with each walk's current step and next due time.
- [List steps](https://docs.hanzo.ai/docs/openapi/marketing/get-marketing-sequences-by-id-steps.md): Returns one sequence's steps in send order.
- [List summary](https://docs.hanzo.ai/docs/openapi/marketing/get-marketing-summary.md): Rolls up the caller org's campaigns: how many there are, how many are active, and the summed budget and spend in cents.
- [List suppressions](https://docs.hanzo.ai/docs/openapi/marketing/get-marketing-suppressions.md): Returns the org's opt-out list, newest first — everyone the send gate will refuse to deliver to.
- [List unsubscribe](https://docs.hanzo.ai/docs/openapi/marketing/get-marketing-unsubscribe.md): The PUBLIC one-click endpoint (no principal): a recipient clicks the signed link in an email footer.
- [Create audiences](https://docs.hanzo.ai/docs/openapi/marketing/post-marketing-audiences.md): Saves a cohort filter for the caller's org.
- [Create calendar](https://docs.hanzo.ai/docs/openapi/marketing/post-marketing-calendar.md): Adds a post to the content calendar.
- [Create campaigns](https://docs.hanzo.ai/docs/openapi/marketing/post-marketing-campaigns.md): Registers a campaign in the caller's org.
- [Create schedule](https://docs.hanzo.ai/docs/openapi/marketing/post-marketing-campaigns-by-id-schedule.md): Sets a campaign's send time and moves it to "scheduled".
- [Create leads](https://docs.hanzo.ai/docs/openapi/marketing/post-marketing-leads.md): Files a sales inquiry as a new lead in the deployment's own CRM and states it on the event plane.
- [Redeem promos](https://docs.hanzo.ai/docs/openapi/marketing/post-marketing-promos-by-code-redeem.md): Records the caller org's claim on a promo.
- [Create sequences](https://docs.hanzo.ai/docs/openapi/marketing/post-marketing-sequences.md): Registers a drip sequence in the caller's org.
- [Create enroll](https://docs.hanzo.ai/docs/openapi/marketing/post-marketing-sequences-by-id-enroll.md): Adds one contact or a whole audience to a sequence and schedules the first step for each.
- [Cancel enrollments](https://docs.hanzo.ai/docs/openapi/marketing/post-marketing-sequences-by-id-enrollments-by-eid-cancel.md): Stops one walk mid-sequence and answers 204: no further step is sent, and steps already delivered are not recalled.
- [Create status](https://docs.hanzo.ai/docs/openapi/marketing/post-marketing-sequences-by-id-status.md): Flips draft/active/archived — the activation gate for sending, since only an active sequence accepts enrollments.
- [Create steps](https://docs.hanzo.ai/docs/openapi/marketing/post-marketing-sequences-by-id-steps.md): Appends a message to the END of a sequence: the new step's idx is one past the last, so steps arrive in the order they are added.
- [Create suppressions](https://docs.hanzo.ai/docs/openapi/marketing/post-marketing-suppressions.md): Records an opt-out for the org (admin / self-service management).
- [Replace calendar](https://docs.hanzo.ai/docs/openapi/marketing/put-marketing-calendar-by-id.md): Replaces a post's editable fields.
- [Replace campaigns](https://docs.hanzo.ai/docs/openapi/marketing/put-marketing-campaigns-by-id.md): Replaces a campaign's editable fields.
- [Marketplace](https://docs.hanzo.ai/docs/openapi/marketplace.md): The one market between orgs: agents and personas to hire, apps, skills, MCP servers and tools to buy, each sold by the org that owns it, and the two-sided work one org buys from another.
- [Delete listings](https://docs.hanzo.ai/docs/openapi/marketplace/delete-marketplace-listings-by-id.md): Withdraws one of the caller org's listings from the marketplace and answers 204.
- [List marketplace](https://docs.hanzo.ai/docs/openapi/marketplace/get-marketplace.md): Lists every tool and agent the caller can reach in their own org and project, enriched with any public listing's title, category and price, and with installed=true on the ones already activated for that scope.
- [List jobs](https://docs.hanzo.ai/docs/openapi/marketplace/get-marketplace-jobs.md): Lists the jobs the caller's org is a party to, newest first: as buyer, the work it hired — with the quotes it has not paid and the jobs being funded, each with the attempt that made it, so a hire whose answer was lost is found here — and as seller, the work it was hired for, which never includes another org's quote.
- [Get jobs](https://docs.hanzo.ai/docs/openapi/marketplace/get-marketplace-jobs-by-id.md): Reads one job the caller's org is a party to.
- [List listings](https://docs.hanzo.ai/docs/openapi/marketplace/get-marketplace-listings.md): Returns the listings the caller's own org has published — what this org is offering, not what it can buy.
- [List seller](https://docs.hanzo.ai/docs/openapi/marketplace/get-marketplace-seller.md): Answers where the caller's org stands as a seller, in one read: its founders' identity verification (KYC) and legal entity (KYB), its tax form and whether it is certified and valid, its own sanctions screening — only what an org may see about itself — the payout wallet it proved, the TaxPrincipalCredentials signed for its agents, what it earned in the year from the economic events the rails stated, and the 1099s payers furnished it.
- [List shop](https://docs.hanzo.ai/docs/openapi/marketplace/get-marketplace-shop.md): Searches every public listing of every kind — agents and personas to hire, apps, skills, MCP servers and tools — newest first, with facets by kind, category, price and rating, paged.
- [Get shop](https://docs.hanzo.ai/docs/openapi/marketplace/get-marketplace-shop-by-id.md): Reads one public listing as the shop shows it — its seller's public face, its reputation and the ways to buy it.
- [Update listings](https://docs.hanzo.ai/docs/openapi/marketplace/patch-marketplace-listings-by-id.md): Edits one of the caller org's listings — its copy, price, payout wallet, visibility and documentation — under the same rules publish applies, and answers the listing as it now stands.
- [Create install](https://docs.hanzo.ai/docs/openapi/marketplace/post-marketplace-install.md): Activates one tool for the caller's own org and project.
- [Create jobs](https://docs.hanzo.ai/docs/openapi/marketplace/post-marketplace-jobs.md): Hires another org for a piece of work, through a public listing or by a direct offer, and answers 201 with the job — open, waiting for the seller.
- [Create accept](https://docs.hanzo.ai/docs/openapi/marketplace/post-marketplace-jobs-by-id-accept.md): Accepts a job the caller's org was hired for: the seller takes the work on and the clock toward its deadline is the seller's.
- [Cancel jobs](https://docs.hanzo.ai/docs/openapi/marketplace/post-marketplace-jobs-by-id-cancel.md): Takes back a job the caller's org opened, before the seller accepts it.
- [Create decline](https://docs.hanzo.ai/docs/openapi/marketplace/post-marketplace-jobs-by-id-decline.md): Declines a job the caller's org was hired for, before any work.
- [Create deliver](https://docs.hanzo.ai/docs/openapi/marketplace/post-marketplace-jobs-by-id-deliver.md): Records delivery of a job the caller's org accepted, before its deadline, and starts the review window: the buyer releases or disputes within it, or it releases itself when it closes.
- [Create dispute](https://docs.hanzo.ai/docs/openapi/marketplace/post-marketplace-jobs-by-id-dispute.md): Stops a job for a ruling, as either party: before delivery (and before the deadline), or within the review window after it.
- [Create feedback](https://docs.hanzo.ai/docs/openapi/marketplace/post-marketplace-jobs-by-id-feedback.md): Rates the other party of a settled job — the seller when the caller's org bought, the buyer when it sold — once per party per job, and never edited.
- [Create refund](https://docs.hanzo.ai/docs/openapi/marketplace/post-marketplace-jobs-by-id-refund.md): Refunds a job the caller's org accepted, as the seller, at any point before it is paid: nothing was moved, so the buyer's authorization is given up, never settled, and the amount it set aside returns to the buyer's wallet.
- [Create release](https://docs.hanzo.ai/docs/openapi/marketplace/post-marketplace-jobs-by-id-release.md): Releases a job the caller's org is paying for, paying the seller the whole amount: the buyer's authorization is settled on the rail, once, and the rail states the payment.
- [Create listings](https://docs.hanzo.ai/docs/openapi/marketplace/post-marketplace-listings.md): Offers one thing the caller's org owns on the marketplace — an agent, persona, app, skill or MCP server, or, for the platform, a tool sold per call — optionally monetized.
- [Create payout](https://docs.hanzo.ai/docs/openapi/marketplace/post-marketplace-seller-payout.md): Starts binding one of the caller org's wallets as the wallet it is paid into: answers a challenge naming the org, the wallet and its address, to be signed with that wallet within fifteen minutes and sent to POST /v1/marketplace/seller/payout/verify.
- [Verify payout](https://docs.hanzo.ai/docs/openapi/marketplace/post-marketplace-seller-payout-verify.md): Binds the caller org's payout wallet: the signature over its outstanding challenge is recovered, and must recover to the wallet's address, before the challenge expires.
- [Create uninstall](https://docs.hanzo.ai/docs/openapi/marketplace/post-marketplace-uninstall.md): Deactivates one tool for the caller's own org and project, so it stops being dispatchable there.
- [Meet](https://docs.hanzo.ai/docs/openapi/meet.md): The virtual office: it decides who may join a room and mints the short-lived token that lets them in.
- [List health](https://docs.hanzo.ai/docs/openapi/meet/get-meet-health.md): Reports whether the office can mint join tokens.
- [List session](https://docs.hanzo.ai/docs/openapi/meet/get-meet-session.md): Answers the three facts the native lobby cannot know on its own: the identity a seat would be taken under, the LiveKit address the browser dials, and the spaces this caller may open a room in.
- [List call](https://docs.hanzo.ai/docs/openapi/meet/meetcall.md): Answers where a room's call happens, for a caller who may join it.
- [List record](https://docs.hanzo.ai/docs/openapi/meet/meetrecordread.md): Answers what is being recorded in a room, and where the file went.
- [Create record](https://docs.hanzo.ai/docs/openapi/meet/meetrecordstart.md): Begins recording a room, or hands back the recording already running.
- [Delete record](https://docs.hanzo.ai/docs/openapi/meet/meetrecordstop.md): Ends a room's recording — EVERY one of them.
- [Create getToken](https://docs.hanzo.ai/docs/openapi/meet/post-meet-gettoken.md): Answers with a LiveKit join token for exactly the room named in the body.
- [Metrics](https://docs.hanzo.ai/docs/openapi/metrics.md): Metrics — 11 operations on https://api.hanzo.ai.
- [List health — GET /v1/metrics/health](https://docs.hanzo.ai/docs/openapi/metrics/get-metrics-health.md): Reports the native metrics store's live state for the calling tenant: the subsystem version, the resolved `org`, and `series` — the number of distinct series actually held right now, read out of the store rather than a constant.
- [List health — GET /v1/metrics/logs/health](https://docs.hanzo.ai/docs/openapi/metrics/get-metrics-logs-health.md): Reports the native log store's live state for the calling tenant: the subsystem version and `records`, the count actually held right now rather than a constant.
- [Query logs](https://docs.hanzo.ai/docs/openapi/metrics/get-metrics-logs-query.md): Answers `{count, records}`, newest first.
- [Query metrics](https://docs.hanzo.ai/docs/openapi/metrics/get-metrics-query.md): Answers `{count, series}`, where `count` is the number of matching SERIES and each series carries the samples that fall inside the window.
- [List health — GET /v1/metrics/traces/health](https://docs.hanzo.ai/docs/openapi/metrics/get-metrics-traces-health.md): Reports the native trace store's live state for the calling tenant: the subsystem version and `spans`, the count actually held right now.
- [Query traces](https://docs.hanzo.ai/docs/openapi/metrics/get-metrics-traces-query.md): Answers `{count, spans}`, newest first, filtered on each span's START time.
- [List trace](https://docs.hanzo.ai/docs/openapi/metrics/get-metrics-traces-trace.md): Answers `{spans}`: every span the org holds for the trace id in `id`, in the order they were appended, which is what a waterfall view renders.
- [Create batch](https://docs.hanzo.ai/docs/openapi/metrics/post-metrics-batch.md): Writes every sample in a luxfi/metric `MetricBatch` into the calling org's store and answers `{written}`: the number of SAMPLES stored, not families and not metrics.
- [Create write — POST /v1/metrics/logs/write](https://docs.hanzo.ai/docs/openapi/metrics/post-metrics-logs-write.md): Takes `{records:[{t, level, body, labels}]}`, appends each one, and answers `{written}`.
- [Create write — POST /v1/metrics/traces/write](https://docs.hanzo.ai/docs/openapi/metrics/post-metrics-traces-write.md): Takes `{spans:[{traceId, spanId, parentId, name, startNs, endNs, attrs}]}`, appends each, and answers `{written}` — the number of spans sent.
- [Create write — POST /v1/metrics/write](https://docs.hanzo.ai/docs/openapi/metrics/post-metrics-write.md): Takes `{series:[{name, labels, samples:[{t, v}]}]}`, appends every sample, creating each series on first write, and answers `{written}` — again counting SAMPLES, so three series of ten samples is 30.
- [ML](https://docs.hanzo.ai/docs/openapi/ml.md): Model serving: deploy a model behind an endpoint and call it.
- [Delete models](https://docs.hanzo.ai/docs/openapi/ml/delete-ml-models-by-name.md): Deletes a deployed inference model.
- [List health](https://docs.hanzo.ai/docs/openapi/ml/get-ml-health.md): Reports whether the model-serving plane is genuinely usable: that the Kubernetes API answers, that the InferenceService CRD is actually served by this cluster, and that the cluster holds at least one serving runtime to run a model ON.
- [List models](https://docs.hanzo.ai/docs/openapi/ml/get-ml-models.md): Lists the inference models deployed in the caller's org.
- [Get models](https://docs.hanzo.ai/docs/openapi/ml/get-ml-models-by-name.md): Returns one deployed inference model.
- [Update models](https://docs.hanzo.ai/docs/openapi/ml/patch-ml-models-by-name.md): Applies a JSON merge patch to one of the caller org's deployed models and answers the updated resource — the way to change a model's image, replica count or resource requests without tearing the deployment down.
- [Create models](https://docs.hanzo.ai/docs/openapi/ml/post-ml-models.md): Deploys one inference model for the caller's org, and answers 201 with the model as Kubernetes admitted it.
- [Create predict](https://docs.hanzo.ai/docs/openapi/ml/post-ml-models-by-name-predict.md): Sends the request body to the named model's predictor and answers the predictor's reply — its status code, its body bytes and its Content-Type, all unchanged.
- [MQ](https://docs.hanzo.ai/docs/openapi/mq.md): Queue and stream admin for your org: create them, watch them drain, ack what you pulled.
- [Delete stream](https://docs.hanzo.ai/docs/openapi/mq/delete-mq-stream-by-name.md): Removes a stream with all its messages and consumers.
- [Delete message](https://docs.hanzo.ai/docs/openapi/mq/delete-mq-stream-by-name-message-by-seq.md): Erases one message by sequence; the sequence gap remains.
- [Delete consumer](https://docs.hanzo.ai/docs/openapi/mq/delete-mq-stream-by-stream-consumer-by-name.md): Removes a consumer and its delivery state; unacknowledged messages stay in the stream.
- [List health](https://docs.hanzo.ai/docs/openapi/mq/get-mq-health.md): Reports whether the message plane behind this surface answers.
- [List info](https://docs.hanzo.ai/docs/openapi/mq/get-mq-info.md): Returns the broker's identity and the org's stream count.
- [List stream](https://docs.hanzo.ai/docs/openapi/mq/get-mq-stream.md): Returns the org's streams, name-ordered, with their live state.
- [Get stream](https://docs.hanzo.ai/docs/openapi/mq/get-mq-stream-by-name.md): Returns one stream's configuration and live state.
- [List message](https://docs.hanzo.ai/docs/openapi/mq/get-mq-stream-by-name-message.md): Reads stored messages without a consumer: by sequence, by newest on a subject, or walking a subject forward from a sequence.
- [List consumer](https://docs.hanzo.ai/docs/openapi/mq/get-mq-stream-by-stream-consumer.md): Returns a stream's consumers, name-ordered, with delivery state.
- [Get consumer](https://docs.hanzo.ai/docs/openapi/mq/get-mq-stream-by-stream-consumer-by-name.md): Returns one consumer's configuration and delivery state.
- [Create stream](https://docs.hanzo.ai/docs/openapi/mq/post-mq-stream.md): Creates a durable stream in the org's namespace and returns it.
- [Create purge](https://docs.hanzo.ai/docs/openapi/mq/post-mq-stream-by-name-purge.md): Removes messages from a stream, leaving its consumers in place.
- [Create consumer](https://docs.hanzo.ai/docs/openapi/mq/post-mq-stream-by-stream-consumer.md): Creates a durable pull consumer on a stream and returns it.
- [Create next](https://docs.hanzo.ai/docs/openapi/mq/post-mq-stream-by-stream-consumer-by-name-next.md): Pulls the consumer's next batch.
- [Replace stream](https://docs.hanzo.ai/docs/openapi/mq/put-mq-stream-by-name.md): Reconfigures an existing stream; the path names the stream, and the immutable fields (storage, retention) must restate what they are.
- [Network](https://docs.hanzo.ai/docs/openapi/network.md): Mounts the Hanzo Cloud NETWORKING surface: the tenant's Hanzo Zero Trust footprint — the overlay network, its routers and its services — served as clean, org-scoped REST off the unified cloud binary and fronting the Hanzo Zero Trust controller (hanzoai/zt, an ZT-based fabric).
- [Delete identities](https://docs.hanzo.ai/docs/openapi/network/delete-network-identities-by-id.md): Takes one of the org's fabric identities out of the org.
- [Delete services](https://docs.hanzo.ai/docs/openapi/network/delete-network-services-by-id.md): Takes a name off the org's overlay: the two policies, the service and its two configs that publishing made, in that order, and the "<name>-host" role from each of the org's identities — that role exists only for the bind policy to select, and a role naming no service is one the identities endpoint refuses to write.
- [List network](https://docs.hanzo.ai/docs/openapi/network/get-network.md): Returns the caller's org overlay network on the Zero Trust fabric.
- [Get network](https://docs.hanzo.ai/docs/openapi/network/get-network-by-id.md): Returns one overlay network by id, scoped to the caller's org.
- [List identities](https://docs.hanzo.ai/docs/openapi/network/get-network-identities.md): Returns the fabric identities the caller's org owns.
- [List routers](https://docs.hanzo.ai/docs/openapi/network/get-network-routers.md): Returns the Zero Trust routers the caller's org owns.
- [List services](https://docs.hanzo.ai/docs/openapi/network/get-network-services.md): Returns the Zero Trust edge services the caller's org owns.
- [Create identities](https://docs.hanzo.ai/docs/openapi/network/post-network-identities.md): Puts the caller on the org's overlay as its own IAM subject.
- [Create services](https://docs.hanzo.ai/docs/openapi/network/post-network-services.md): Puts a name on the org's overlay: a fabric service forwarding to host:port on whichever of the org's devices carries the "<name>-host" role, dialable at "<name>.<org>.zt" by any of the org's identities — and by the cloud's own, which is what lets a BYO cluster's apiserver be attached to the fleet with a ".zt" kubeconfig.
- [Node](https://docs.hanzo.ai/docs/openapi/node.md): Your machines: the ones you own, connected and ready to take a command.
- [List node](https://docs.hanzo.ai/docs/openapi/node/get-node.md): Returns the caller org's currently connected bot nodes: what each one calls itself, the platform it runs on, its agent version, when its socket was established, and the capabilities and commands it reported.
- [Connect node](https://docs.hanzo.ai/docs/openapi/node/get-node-connect.md): Upgrades to a WebSocket and keeps it for the life of the node.
- [Invoke node](https://docs.hanzo.ai/docs/openapi/node/post-node-by-id-invoke.md): Sends {command, params, timeoutMs, idempotencyKey} to the named node and answers with what the node returned: {ok, payload, code, message}, where payload is the node's own JSON passed through — cloud routes the call, it does not interpret the result.
- [Invoke peer](https://docs.hanzo.ai/docs/openapi/node/post-node-peer-invoke.md): A machine hop, not a caller-facing route.
- [Notify](https://docs.hanzo.ai/docs/openapi/notify.md): Transactional email and SMS, sent through your org's own provider credential.
- [Delete credentials](https://docs.hanzo.ai/docs/openapi/notify/delete-notify-credentials-by-provider-by-key.md): Removes one of your org's notify provider credentials.
- [List health](https://docs.hanzo.ai/docs/openapi/notify/get-notify-health.md): Reports that the notify send surface is mounted.
- [Send notify](https://docs.hanzo.ai/docs/openapi/notify/post-notify-send.md): Delivers one transactional message by email or SMS through the caller org's own provider credential.
- [Create email](https://docs.hanzo.ai/docs/openapi/notify/post-notify-send-email.md): Delivers one transactional email through the caller org's own provider credential.
- [Create sms](https://docs.hanzo.ai/docs/openapi/notify/post-notify-send-sms.md): Delivers one transactional SMS through the caller org's own provider credential.
- [Replace credentials](https://docs.hanzo.ai/docs/openapi/notify/put-notify-credentials-by-provider-by-key.md): Sets one of your org's notify provider credentials.
- [O11y](https://docs.hanzo.ai/docs/openapi/o11y.md): Your logs, metrics and traces: ship them in, query them, chart them.
- [Create check in](https://docs.hanzo.ai/docs/openapi/o11y/agentcheckin.md): The deployed agent's check-in — the path consistent with the account surface, reporting the agent's account and telemetry state so the connection can be tracked.
- [Create agent check in](https://docs.hanzo.ai/docs/openapi/o11y/agentcheckindeprecated.md): The deployed agent's check-in on its original hyphenated path, kept for backward compatibility with agents already running.
- [Create check](https://docs.hanzo.ai/docs/openapi/o11y/authzcheck.md): Evaluates a batch of transactions — relation plus object — for the authenticated caller and answers each with its authorization verdict, in the order they were asked.
- [Create clone](https://docs.hanzo.ai/docs/openapi/o11y/clonedashboardv2.md): Clones an existing v2-shape dashboard.
- [Create accounts](https://docs.hanzo.ai/docs/openapi/o11y/createaccount.md): Connects a new cloud-integration account for the given provider from its posted config and credentials, answering with the account and the artifact the agent deploys to complete the connection.
- [Create channels](https://docs.hanzo.ai/docs/openapi/o11y/createchannel.md): Creates a notification channel, answering with the stored channel.
- [Create dashboards](https://docs.hanzo.ai/docs/openapi/o11y/createdashboardv2.md): Creates a dashboard in the v2 format that follows the Perses spec and answers with the stored dashboard.
- [Create dashboard views](https://docs.hanzo.ai/docs/openapi/o11y/createdashboardview.md): Persists the calling user's dashboard-listing state (query, sort, order) as a named, reusable view shared across the org.
- [Create downtime schedules](https://docs.hanzo.ai/docs/openapi/o11y/createdowntimeschedule.md): Creates a planned maintenance window, answering with the stored schedule.
- [Create ingestion keys](https://docs.hanzo.ai/docs/openapi/o11y/createingestionkey.md): Mints an ingestion key for the workspace, answering with the created key.
- [Create limits](https://docs.hanzo.ai/docs/openapi/o11y/createingestionkeylimit.md): Sets a signal limit on an ingestion key, by key id, answering with the created limit.
- [Create annotation](https://docs.hanzo.ai/docs/openapi/o11y/createllmannotation.md): Adds a human annotation to a trace or observation, optionally in a review queue.
- [Create scores](https://docs.hanzo.ai/docs/openapi/o11y/createllmscore.md): Attaches an eval score or human-feedback signal to a trace or a single observation.
- [Create metric reduction rules](https://docs.hanzo.ai/docs/openapi/o11y/createmetricreductionrule.md): Creates a volume-control rule for a metric and returns it with its id; a metric that already has a rule is refused.
- [Replace llm pricing rules](https://docs.hanzo.ai/docs/openapi/o11y/createorupdatellmpricingrules.md): Writes the pricing-rule batch — the single write endpoint used by both the user and the Zeus sync job.
- [Create public](https://docs.hanzo.ai/docs/openapi/o11y/createpublicdashboard.md): Creates the public-sharing config for a dashboard and enables public sharing, answering with the new share's id.
- [Create roles — POST /v1/o11y/roles](https://docs.hanzo.ai/docs/openapi/o11y/createrole.md): Creates a custom role in the caller's org from a name, an optional description and the transaction groups it grants, answering the new role's id.
- [Create route policies](https://docs.hanzo.ai/docs/openapi/o11y/createroutepolicy.md): Creates a route policy, answering with the stored policy.
- [Create rules](https://docs.hanzo.ai/docs/openapi/o11y/createrule.md): Creates a new alert rule and answers with the stored rule.
- [Create service accounts](https://docs.hanzo.ai/docs/openapi/o11y/createserviceaccount.md): Creates a service account in the caller's org, answering its id.
- [Create keys](https://docs.hanzo.ai/docs/openapi/o11y/createserviceaccountkey.md): Mints an API key for a service account and answers the key's id and its secret — the one time the secret is ever shown.
- [Create roles — POST /v1/o11y/service_accounts/{id}/roles](https://docs.hanzo.ai/docs/openapi/o11y/createserviceaccountrole.md): Assigns a role, named by its id, to a service account.
- [Create span mappers](https://docs.hanzo.ai/docs/openapi/o11y/createspanmapper.md): Adds a mapper to a group: which field context it reads, the move or copy it performs, and whether it is on.
- [Create span mapper groups](https://docs.hanzo.ai/docs/openapi/o11y/createspanmappergroup.md): Creates a mapping group: the name it is known by, the span and resource attributes whose presence selects a span into it, and whether it is on.
- [Create new](https://docs.hanzo.ai/docs/openapi/o11y/createtracefunnel.md): Creates an empty funnel with a name, answering the funnel it created.
- [Delete views](https://docs.hanzo.ai/docs/openapi/o11y/delete-o11y-explorer-views-by-viewid.md): Deletes one saved explorer view by id.
- [Delete reviews](https://docs.hanzo.ai/docs/openapi/o11y/delete-o11y-reviews-by-id.md): Removes one review queue and every item in it.
- [Delete projects](https://docs.hanzo.ai/docs/openapi/o11y/delete-o11y-sentinel-projects-by-id.md): Deletes one Sentry project of the caller's org; retained events are not touched.
- [Delete channels](https://docs.hanzo.ai/docs/openapi/o11y/deletechannelbyid.md): Removes a notification channel, by id.
- [Delete dashboards](https://docs.hanzo.ai/docs/openapi/o11y/deletedashboardv2.md): Deletes a v2-shape dashboard along with its tag relations.
- [Delete dashboard views](https://docs.hanzo.ai/docs/openapi/o11y/deletedashboardview.md): Removes a saved view.
- [Delete downtime schedules](https://docs.hanzo.ai/docs/openapi/o11y/deletedowntimeschedulebyid.md): Removes a planned maintenance window, by id.
- [Delete ingestion keys](https://docs.hanzo.ai/docs/openapi/o11y/deleteingestionkey.md): Removes an ingestion key, by id.
- [Delete limits](https://docs.hanzo.ai/docs/openapi/o11y/deleteingestionkeylimit.md): Removes an ingestion key limit, by limit id.
- [Delete llm pricing rules](https://docs.hanzo.ai/docs/openapi/o11y/deletellmpricingrule.md): Hard-deletes a pricing rule by id.
- [Delete score](https://docs.hanzo.ai/docs/openapi/o11y/deletellmscore.md): Hard-deletes a score by id.
- [Delete metric reduction rules](https://docs.hanzo.ai/docs/openapi/o11y/deletemetricreductionrulebyid.md): Deletes a volume-control rule by its id.
- [Delete public](https://docs.hanzo.ai/docs/openapi/o11y/deletepublicdashboard.md): Deletes the public-sharing config and disables public sharing of a dashboard.
- [Delete roles — DELETE /v1/o11y/roles/{id}](https://docs.hanzo.ai/docs/openapi/o11y/deleterole.md): Deletes a custom role.
- [Delete route policies](https://docs.hanzo.ai/docs/openapi/o11y/deleteroutepolicybyid.md): Removes a route policy, by id.
- [Delete rules](https://docs.hanzo.ai/docs/openapi/o11y/deleterulebyid.md): Removes an alert rule, by id.
- [Delete service accounts](https://docs.hanzo.ai/docs/openapi/o11y/deleteserviceaccount.md): Deletes a service account and revokes every key it holds.
- [Delete roles — DELETE /v1/o11y/service_accounts/{id}/roles/{rid}](https://docs.hanzo.ai/docs/openapi/o11y/deleteserviceaccountrole.md): Removes a role from a service account.
- [Delete span mappers](https://docs.hanzo.ai/docs/openapi/o11y/deletespanmapper.md): Deletes one mapper from a group.
- [Delete span mapper groups](https://docs.hanzo.ai/docs/openapi/o11y/deletespanmappergroup.md): Deletes a mapping group and every mapper under it.
- [Delete trace funnels](https://docs.hanzo.ai/docs/openapi/o11y/deletetracefunnel.md): Deletes a funnel.
- [Delete accounts](https://docs.hanzo.ai/docs/openapi/o11y/disconnectaccount.md): Tears down a connected account for the given provider, by id.
- [List heartbeat](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-alerts-heartbeat.md): Reports whether the alert path's heartbeat is still arriving: the dead-man's switch for paging.
- [List last](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-alerts-last.md): Answers the most recent Alertmanager deliveries THIS process received, as plain text — one greppable `ALERT-RECEIVED` line per alert, followed by the `ALERT-DELIVERED` / `ALERT-UNDELIVERED` outcome of carrying it out of the process, newest last, so piping to `tail` reads in arrival order.
- [List aggregate attributes](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-autocomplete-aggregate-attributes.md): Lists the attributes usable as an aggregate target for the given telemetry and operator — what a filter builder offers after the aggregation is chosen.
- [List attribute keys — GET /v1/o11y/autocomplete/attribute_keys](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-autocomplete-attribute-keys.md): Lists the attribute keys available for filtering the given telemetry, each with its data type and whether it is a materialized column.
- [List attribute values — GET /v1/o11y/autocomplete/attribute_values](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-autocomplete-attribute-values.md): Lists the values one attribute key has taken — string, number and bool values in their own lists — for completing a filter.
- [List attribute keys — GET /v1/o11y/clusters/attribute_keys](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-clusters-attribute-keys.md): Lists the metric attribute keys Kubernetes clusters report, for building cluster filters.
- [List attribute values — GET /v1/o11y/clusters/attribute_values](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-clusters-attribute-values.md): Lists the values one cluster attribute key has taken, for building cluster filters.
- [List attribute keys — GET /v1/o11y/daemonsets/attribute_keys](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-daemonsets-attribute-keys.md): Lists the metric attribute keys Kubernetes daemonsets report, for building daemonset filters.
- [List attribute values — GET /v1/o11y/daemonsets/attribute_values](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-daemonsets-attribute-values.md): Lists the values one daemonset attribute key has taken, for building daemonset filters.
- [List attribute keys — GET /v1/o11y/deployments/attribute_keys](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-deployments-attribute-keys.md): Lists the metric attribute keys Kubernetes deployments report, for building deployment filters.
- [List attribute values — GET /v1/o11y/deployments/attribute_values](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-deployments-attribute-values.md): Lists the values one deployment attribute key has taken, for building deployment filters.
- [List disks](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-disks.md): Lists the storage disks the datastore reports, with their names and types.
- [List errorFromErrorID](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-errorfromerrorid.md): Returns one exception instance and the span it happened on, by its error id within a group at a timestamp.
- [List errorFromGroupID](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-errorfromgroupid.md): Returns the representative exception instance of a group at a timestamp, and the span it happened on.
- [List issues — GET /v1/o11y/errortracking/issues](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-errortracking-issues.md): Lists the caller's org's grouped error issues (by fingerprint) with status, level, counts and first/last-seen.
- [Get issues — GET /v1/o11y/errortracking/issues/{id}](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-errortracking-issues-by-id.md): Returns one grouped issue with its latest occurrence sample.
- [List views](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-explorer-views.md): Lists the caller's org's saved explorer views, optionally narrowed to one source page, name or category.
- [Get views](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-explorer-views-by-viewid.md): Returns one saved explorer view by id.
- [List features](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-features.md): Returns the supported feature flags and their resolved values for the caller's org.
- [List keys — GET /v1/o11y/fields/keys](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-fields-keys.md): Returns the telemetry field keys matching the selector — the signal's fields grouped by name, and whether the catalog is complete.
- [List values](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-fields-values.md): Returns the values one telemetry field has taken — string, bool, number and related values — and whether the value list is complete.
- [List filter suggestions](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-filter-suggestions.md): Suggests attribute keys and example filter queries for the query builder, seeded by what the org's own telemetry carries.
- [List config](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-global-config.md): Returns the deployment's global configuration: its public endpoints and which identity providers are enabled.
- [List health](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-health.md): Reports service health.
- [List healthz](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-healthz.md): Reports whether every service in the runtime's registry is healthy, and names them grouped by state — so a failure says WHICH component is down, not merely that something is.
- [List attribute keys — GET /v1/o11y/hosts/attribute_keys](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-hosts-attribute-keys.md): Lists the metric attribute keys hosts report, for building host filters — each with its data type and whether it is a materialized column.
- [List attribute values — GET /v1/o11y/hosts/attribute_values](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-hosts-attribute-values.md): Lists the values one host attribute key has taken, for building host filters — string, number and bool values in their own lists.
- [List checks](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-infra-monitoring-checks.md): Reports whether the metrics and attributes an infra-monitoring section needs are being received — for each collector receiver or processor involved, what is present and what is missing, with a user-facing message and a docs link per missing piece.
- [List status — GET /v1/o11y/infra_onboarding/k8s/status](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-infra-onboarding-k8s-status.md): Reports how far Kubernetes infra onboarding has progressed: which metric families have arrived and, per pod, which required metadata labels are present.
- [List attribute keys — GET /v1/o11y/jobs/attribute_keys](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-jobs-attribute-keys.md): Lists the metric attribute keys Kubernetes jobs report, for building job filters.
- [List attribute values — GET /v1/o11y/jobs/attribute_values](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-jobs-attribute-values.md): Lists the values one job attribute key has taken, for building job filters.
- [List licenses](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-licenses.md): Lists the org's licenses.
- [List active](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-licenses-active.md): Activates the enterprise license.
- [List livez](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-livez.md): Answers 200 unconditionally while the process is running, and asserts NOTHING about the telemetry stores behind it.
- [Login o11y](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-login.md): Where a failed sign-in callback lands.
- [List logs — GET /v1/o11y/logs](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-logs.md): Returns the most recent log records in the query window, newest first — each record an open object carrying its nanosecond timestamp and whatever fields the record was ingested with.
- [List aggregate](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-logs-aggregate.md): Returns the logs aggregate buckets for the query window.
- [List fields — GET /v1/o11y/logs/fields](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-logs-fields.md): Returns the log field catalog: the fields already selected as indexed columns, and the interesting ones seen in the data that could be.
- [List livetail](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-logs-livetail.md): Streams matching log records continuously instead of answering once, so a console tail shows lines as they land rather than at the end of a window.
- [Get pipelines](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-logs-pipelines-by-version.md): Returns the caller's org's log parsing pipelines at one config version — "latest" for the newest — along with that version's deployment record and the recent version history.
- [List promote paths](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-logs-promote-paths.md): Lists the log body paths already promoted or indexed, with the indexes each carries.
- [List metric metadata](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-metric-metric-metadata.md): Serves the OLDER /metric/metric_metadata route.
- [List attribute keys — GET /v1/o11y/namespaces/attribute_keys](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-namespaces-attribute-keys.md): Lists the metric attribute keys Kubernetes namespaces report, for building namespace filters.
- [List attribute values — GET /v1/o11y/namespaces/attribute_values](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-namespaces-attribute-values.md): Lists the values one namespace attribute key has taken, for building namespace filters.
- [List nextPrevErrorIDs](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-nextpreverrorids.md): Returns the ids of the exception instances immediately after and before a given one within its group — the paging cursor the error detail view walks.
- [List attribute keys — GET /v1/o11y/nodes/attribute_keys](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-nodes-attribute-keys.md): Lists the metric attribute keys Kubernetes nodes report, for building node filters.
- [List attribute values — GET /v1/o11y/nodes/attribute_values](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-nodes-attribute-values.md): Lists the values one node attribute key has taken, for building node filters.
- [List attribute keys — GET /v1/o11y/pods/attribute_keys](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-pods-attribute-keys.md): Lists the metric attribute keys Kubernetes pods report, for building pod filters.
- [List attribute values — GET /v1/o11y/pods/attribute_values](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-pods-attribute-values.md): Lists the values one pod attribute key has taken, for building pod filters.
- [List attribute keys — GET /v1/o11y/processes/attribute_keys](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-processes-attribute-keys.md): Lists the metric attribute keys processes report, for building process filters.
- [List attribute values — GET /v1/o11y/processes/attribute_values](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-processes-attribute-values.md): Lists the values one process attribute key has taken, for building process filters.
- [List metrics — GET /v1/o11y/product/metrics](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-product-metrics.md): Returns one product's RED series — request rate, errors, p50 and p95 latency — for the caller's org, plus that org's LLM usage rollup over the same window.
- [List attribute keys — GET /v1/o11y/pvcs/attribute_keys](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-pvcs-attribute-keys.md): Lists the metric attribute keys persistent volume claims report, for building volume filters.
- [List attribute values — GET /v1/o11y/pvcs/attribute_values](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-pvcs-attribute-values.md): Lists the values one persistent-volume-claim attribute key has taken, for building volume filters.
- [Query o11y](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-query.md): Evaluates one instant PromQL query against the org's metrics and returns the result at a single point in time.
- [List query progress](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-query-progress.md): Reports how far a submitted query has got — rows scanned, bytes read, elapsed — and HOLDS the connection until the next update rather than answering immediately.
- [List query range — GET /v1/o11y/query_range](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-query-range.md): Runs a Prometheus-style range query over metrics — the legacy read that predates the v5 querier — and returns the matrix, vector or scalar the query resolved to.
- [List readyz](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-readyz.md): Reports whether the runtime's registered services are healthy enough to take traffic, and answers 503 when they are not — which is what takes a booting or degraded replica out of the load balancer instead of letting it serve errors.
- [List reviews](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-reviews.md): Returns a page of the caller org's human-review queues, newest first, narrowed to the caller's project.
- [Get reviews](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-reviews-by-id.md): Returns one review queue with its pending and completed counts and its first page of items.
- [List items](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-reviews-by-id-items.md): Returns a page of one review queue's items, newest first, optionally filtered to PENDING or COMPLETED.
- [Get events](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-sentinel-events-by-id.md): Returns one captured error event of a project, by its id.
- [List issues — GET /v1/o11y/sentinel/issues](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-sentinel-issues.md): Lists the caller's org's grouped error issues, optionally narrowed to one project and one time window, and filtered by status, level, environment, service, a free-text query and a sort.
- [Get issues — GET /v1/o11y/sentinel/issues/{id}](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-sentinel-issues-by-id.md): Returns one grouped issue of the caller's org with its latest occurrence sample.
- [List events](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-sentinel-issues-by-id-events.md): Lists one issue's captured occurrences, scoped to a project — a project is an isolation unit, so the caller declares which project's occurrences to read.
- [List logs — GET /v1/o11y/sentinel/logs](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-sentinel-logs.md): Lists a project's captured error events, newest first, optionally narrowed to those whose message or exception text contains a search string.
- [List projects](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-sentinel-projects.md): Lists the caller's org's Sentry projects — one per product that has reported an error, plus any created by hand.
- [Get projects](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-sentinel-projects-by-id.md): Returns one Sentry project of the caller's org.
- [List stats — GET /v1/o11y/sentinel/stats](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-sentinel-stats.md): Returns a project's event-rate timeseries: one bucket per interval over the requested period, counting the events in it.
- [List traces — GET /v1/o11y/sentinel/traces](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-sentinel-traces.md): Lists the traces a project's captured errors reference, each with how many errors landed on it, when they started and stopped, and the latest message seen — the entry point for "which requests are failing".
- [Get traces — GET /v1/o11y/sentinel/traces/{id}](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-sentinel-traces-by-id.md): Returns one trace's captured errors for a project — every error event that carried the trace id, in the order the events plane holds them.
- [List services — GET /v1/o11y/services/list](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-services-list.md): Lists the name of every service the trace store holds, with no window applied — the complete catalog, for pickers and autocomplete.
- [List sessions — GET /v1/o11y/sessions](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-sessions.md): Answers the caller org's LLM-observability sessions — traces grouped by session id on the gen_ai span plane — paged by limit and offset, in the runtime's own envelope, passed through unchanged.
- [List apdex](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-settings-apdex.md): Returns apdex settings for the named services.
- [List ttl](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-settings-ttl.md): Returns the org's current retention policy: default TTL, custom per-label rules, and cold-storage settings where configured.
- [List attribute keys — GET /v1/o11y/statefulsets/attribute_keys](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-statefulsets-attribute-keys.md): Lists the metric attribute keys Kubernetes statefulsets report, for building statefulset filters.
- [List attribute values — GET /v1/o11y/statefulsets/attribute_values](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-statefulsets-attribute-values.md): Lists the values one statefulset attribute key has taken, for building statefulset filters.
- [List stats — GET /v1/o11y/stats](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-stats.md): Returns the collected usage statistics for the caller's org, as the stats reporter aggregates them — a map whose keys are the reporter's own counter names.
- [List status — GET /v1/o11y/status](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-status.md): Reports whether a product's service is live: an in-cluster health probe with its measured latency, fused with the per-replica up inventory.
- [List summary](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-summary.md): Reports whether the platform is up.
- [List traces — GET /v1/o11y/traces](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-traces.md): Lists the caller org's recent traces — one row per trace with its span count and wall-clock duration, most recently active first.
- [List usage](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-usage.md): Returns ingestion usage counts bucketed over the requested window, optionally narrowed to one service.
- [List version](https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-version.md): Reports the running build: its version, whether an enterprise edition is present ("N" in this build), and whether first-user setup has completed.
- [Get accounts](https://docs.hanzo.ai/docs/openapi/o11y/getaccount.md): Returns one connected account for the given provider, by id.
- [Get services — GET /v1/o11y/cloud_integrations/{cloud_provider}/accounts/{id}/services/{service_id}](https://docs.hanzo.ai/docs/openapi/o11y/getaccountservice.md): Returns one service and its configuration for a connected account of the given provider, by account id and service id.
- [List alerts — GET /v1/o11y/alerts](https://docs.hanzo.ai/docs/openapi/o11y/getalerts.md): Returns the org's current alerts.
- [List route policies](https://docs.hanzo.ai/docs/openapi/o11y/getallroutepolicies.md): Lists the org's route policies.
- [Get channels](https://docs.hanzo.ai/docs/openapi/o11y/getchannelbyid.md): Returns one notification channel, by id.
- [List credentials](https://docs.hanzo.ai/docs/openapi/o11y/getconnectioncredentials.md): Returns the credentials the connecting agent needs to establish the cloud integration, for the given cloud provider.
- [Get dashboards — GET /v1/o11y/dashboards/{id}](https://docs.hanzo.ai/docs/openapi/o11y/getdashboardv2.md): Returns a v2-shape dashboard.
- [Get downtime schedules](https://docs.hanzo.ai/docs/openapi/o11y/getdowntimeschedulebyid.md): Returns one planned maintenance window, by id.
- [Create error traces — POST /v1/o11y/trace-funnels/analytics/error-traces](https://docs.hanzo.ai/docs/openapi/o11y/getdraftfunnelerrortraces.md): Returns the errored traces through a step transition of a funnel described inline.
- [Create overview — POST /v1/o11y/trace-funnels/analytics/overview](https://docs.hanzo.ai/docs/openapi/o11y/getdraftfunneloverview.md): Returns the conversion overview of a funnel described inline.
- [Create slow traces — POST /v1/o11y/trace-funnels/analytics/slow-traces](https://docs.hanzo.ai/docs/openapi/o11y/getdraftfunnelslowtraces.md): Returns the slowest traces through a step transition of a funnel described inline.
- [Create steps — POST /v1/o11y/trace-funnels/analytics/steps](https://docs.hanzo.ai/docs/openapi/o11y/getdraftfunnelstepmetrics.md): Returns the per-step metrics of a funnel described inline.
- [Create overview — POST /v1/o11y/trace-funnels/analytics/steps/overview](https://docs.hanzo.ai/docs/openapi/o11y/getdraftfunnelstepoverview.md): Returns the conversion between two steps of a funnel described inline.
- [Create flamegraph](https://docs.hanzo.ai/docs/openapi/o11y/getflamegraph.md): Returns a trace's flamegraph: spans bucketed by depth level, each level ordered as it is drawn, around the selected span.
- [List hosts — GET /v1/o11y/zeus/hosts](https://docs.hanzo.ai/docs/openapi/o11y/gethosts.md): Returns the deployment's host info from Zeus.
- [List ingestion keys](https://docs.hanzo.ai/docs/openapi/o11y/getingestionkeys.md): Lists the workspace's ingestion keys, paginated.
- [Get integrations](https://docs.hanzo.ai/docs/openapi/o11y/getintegration.md): Returns one integration's full detail — its overview, configuration steps, collected data and assets — together with its installation record when the org has installed it.
- [List connection status](https://docs.hanzo.ai/docs/openapi/o11y/getintegrationconnectionstatus.md): Reports whether the integration's logs and metrics have been received over the lookback window, so the console can show a live connection state.
- [Get llm pricing rules](https://docs.hanzo.ai/docs/openapi/o11y/getllmpricingrule.md): Returns a single LLM pricing rule by id.
- [Get score](https://docs.hanzo.ai/docs/openapi/o11y/getllmscore.md): Returns a single score by id.
- [List alerts — GET /v1/o11y/metrics/alerts](https://docs.hanzo.ai/docs/openapi/o11y/getmetricalerts.md): Lists the alert rules that reference a metric.
- [List attributes](https://docs.hanzo.ai/docs/openapi/o11y/getmetricattributes.md): Returns one metric's attribute keys, each with its unique values and their count.
- [List dashboards — GET /v1/o11y/metrics/dashboards](https://docs.hanzo.ai/docs/openapi/o11y/getmetricdashboardsv2.md): Lists the dashboard panels that reference a metric.
- [List highlights](https://docs.hanzo.ai/docs/openapi/o11y/getmetrichighlights.md): Returns one metric's headline numbers: data points, total and active time series, and when it was last received.
- [List metadata](https://docs.hanzo.ai/docs/openapi/o11y/getmetricmetadata.md): Returns one metric's metadata: description, type, unit, temporality and monotonicity.
- [Get metric reduction rules](https://docs.hanzo.ai/docs/openapi/o11y/getmetricreductionrulebyid.md): Returns one volume-control rule by its id.
- [List stats — GET /v1/o11y/metric_reduction_rules/stats](https://docs.hanzo.ai/docs/openapi/o11y/getmetricreductionrulestats.md): Returns total ingested vs retained series and samples and the estimated monthly savings across all volume-control rules.
- [List timeseries](https://docs.hanzo.ai/docs/openapi/o11y/getmetricreductionruletimeseries.md): Returns ingested vs retained series over time across all volume-control rules, in hourly buckets, in the query-range time-series response shape.
- [List onboarding](https://docs.hanzo.ai/docs/openapi/o11y/getmetricsonboardingstatus.md): Reports whether any non-O11y metrics have been ingested — the lightweight check onboarding polls.
- [Create stats — POST /v1/o11y/metrics/stats](https://docs.hanzo.ai/docs/openapi/o11y/getmetricsstats.md): Lists metrics with their sample and time-series counts for a time range — the volume view of the metrics explorer, pageable and sortable.
- [Create treemap](https://docs.hanzo.ai/docs/openapi/o11y/getmetricstreemap.md): Returns the proportional distribution of metrics by sample count or time-series count, as the entries of a treemap.
- [List me — GET /v1/o11y/orgs/me](https://docs.hanzo.ai/docs/openapi/o11y/getmyorganization.md): Returns the caller's own organization.
- [List me — GET /v1/o11y/service_accounts/me](https://docs.hanzo.ai/docs/openapi/o11y/getmyserviceaccount.md): Returns the calling service account itself, with the roles it holds — the self-inspection read for a key-authenticated caller.
- [List me — GET /v1/o11y/users/me](https://docs.hanzo.ai/docs/openapi/o11y/getmyuser.md): Returns the calling user together with every role they hold.
- [Get preferences — GET /v1/o11y/org/preferences/{name}](https://docs.hanzo.ai/docs/openapi/o11y/getorgpreference.md): Returns one org-scoped preference, by name.
- [Create overall status](https://docs.hanzo.ai/docs/openapi/o11y/getoverallstatetransitions.md): Returns the overall firing/inactive windows for a rule, for the posted query range.
- [List public](https://docs.hanzo.ai/docs/openapi/o11y/getpublicdashboard.md): Returns the public-sharing config for a dashboard.
- [Get dashboards — GET /v1/o11y/public/dashboards/{id}](https://docs.hanzo.ai/docs/openapi/o11y/getpublicdashboarddata.md): Returns the sanitized dashboard data for public access — the read a shared dashboard's public page makes.
- [List query range — GET /v1/o11y/public/dashboards/{id}/widgets/{idx}/query_range](https://docs.hanzo.ai/docs/openapi/o11y/getpublicdashboardwidgetqueryrange.md): Returns the query-range result for one widget of a public dashboard.
- [List filters](https://docs.hanzo.ai/docs/openapi/o11y/getquickfilters.md): Returns the org's quick filters for every signal — the attribute shortlists its explorers offer as one-click filters.
- [Get roles](https://docs.hanzo.ai/docs/openapi/o11y/getrole.md): Returns one role with the transaction groups it grants.
- [Get route policies](https://docs.hanzo.ai/docs/openapi/o11y/getroutepolicybyid.md): Returns one route policy, by id.
- [Get rules](https://docs.hanzo.ai/docs/openapi/o11y/getrulebyid.md): Returns one alert rule with its evaluation state, by id.
- [List filter keys](https://docs.hanzo.ai/docs/openapi/o11y/getrulehistoryfilterkeys.md): Returns the distinct label keys present in a rule's history entries over the selected range, for building history filters.
- [List filter values](https://docs.hanzo.ai/docs/openapi/o11y/getrulehistoryfiltervalues.md): Returns the distinct values a given label key has taken across a rule's history entries.
- [List overall status](https://docs.hanzo.ai/docs/openapi/o11y/getrulehistoryoverallstatus.md): Returns the overall firing/inactive intervals for a rule over the selected range.
- [List stats — GET /v1/o11y/rules/{id}/history/stats](https://docs.hanzo.ai/docs/openapi/o11y/getrulehistorystats.md): Returns trigger and resolution statistics for a rule over the selected time range, current window against the prior one.
- [List timeline](https://docs.hanzo.ai/docs/openapi/o11y/getrulehistorytimeline.md): Returns paginated timeline entries for a rule's state transitions, filterable by state and a label expression, cursor-paginated.
- [List top contributors](https://docs.hanzo.ai/docs/openapi/o11y/getrulehistorytopcontributors.md): Returns the label combinations that contributed most to a rule firing over the selected range.
- [Create timeline](https://docs.hanzo.ai/docs/openapi/o11y/getrulestatehistory.md): Returns a rule's state-transition timeline for the posted query range, each entry carrying its related-logs or related-traces link.
- [Create top contributors](https://docs.hanzo.ai/docs/openapi/o11y/getrulestatehistorytopcontributors.md): Returns the label combinations that contributed most to a rule firing, for the posted query range.
- [Create stats — POST /v1/o11y/rules/{id}/history/stats](https://docs.hanzo.ai/docs/openapi/o11y/getrulestats.md): Returns trigger and resolution statistics for a rule, current window against the prior one, for the posted query range.
- [Get services — GET /v1/o11y/cloud_integrations/{cloud_provider}/services/{service_id}](https://docs.hanzo.ai/docs/openapi/o11y/getservice.md): Returns one service the given provider can collect from, by service id, optionally scoped to one cloud integration.
- [Get service accounts](https://docs.hanzo.ai/docs/openapi/o11y/getserviceaccount.md): Returns one service account with the roles it holds.
- [List roles — GET /v1/o11y/service_accounts/{id}/roles](https://docs.hanzo.ai/docs/openapi/o11y/getserviceaccountroles.md): Lists the roles a service account holds.
- [Get filters](https://docs.hanzo.ai/docs/openapi/o11y/getsignalfilters.md): Returns the org's quick filters for one signal — traces, logs, metrics, exceptions or api_monitoring.
- [Create aggregations](https://docs.hanzo.ai/docs/openapi/o11y/gettraceaggregations.md): Computes span aggregations over one trace — span count, duration or share of execution time — grouped by the resource field each aggregation names.
- [List fields — GET /v1/o11y/traces/fields](https://docs.hanzo.ai/docs/openapi/o11y/gettracefields.md): Returns the trace field catalog: the span fields already selected as indexed columns, and the interesting ones seen in the data that could be.
- [Get trace funnels](https://docs.hanzo.ai/docs/openapi/o11y/gettracefunnel.md): Returns one funnel with its steps.
- [Create error traces — POST /v1/o11y/trace-funnels/{funnel_id}/analytics/error-traces](https://docs.hanzo.ai/docs/openapi/o11y/gettracefunnelerrortraces.md): Returns the errored traces through a step transition of a saved funnel — the entry point for "why is this step failing".
- [Create overview — POST /v1/o11y/trace-funnels/{funnel_id}/analytics/overview](https://docs.hanzo.ai/docs/openapi/o11y/gettracefunneloverview.md): Returns a saved funnel's conversion overview over a window: how many entered, how many converted, the rate and the latency.
- [Create slow traces — POST /v1/o11y/trace-funnels/{funnel_id}/analytics/slow-traces](https://docs.hanzo.ai/docs/openapi/o11y/gettracefunnelslowtraces.md): Returns the slowest traces through a step transition of a saved funnel — the entry point for "why is this step slow".
- [Create steps — POST /v1/o11y/trace-funnels/{funnel_id}/analytics/steps](https://docs.hanzo.ai/docs/openapi/o11y/gettracefunnelstepmetrics.md): Returns a saved funnel's per-step metrics over a window — the counts and latencies at each step, in step order.
- [Create overview — POST /v1/o11y/trace-funnels/{funnel_id}/analytics/steps/overview](https://docs.hanzo.ai/docs/openapi/o11y/gettracefunnelstepoverview.md): Returns the conversion between two named steps of a saved funnel — the step-to-step drill-down behind the overview.
- [Get preferences — GET /v1/o11y/user/preferences/{name}](https://docs.hanzo.ai/docs/openapi/o11y/getuserpreference.md): Returns one preference of the calling user, by name.
- [Create waterfall](https://docs.hanzo.ai/docs/openapi/o11y/getwaterfallv4.md): Returns a trace's waterfall: every span when the trace is small enough, a capped window around the selected span when it is not, with the uncollapsed subtrees the caller asked to keep open.
- [Create inspect](https://docs.hanzo.ai/docs/openapi/o11y/inspectmetrics.md): Returns one metric's raw time series over a window of at most thirty minutes — each series with its labels and timestamp/value pairs.
- [Create install](https://docs.hanzo.ai/docs/openapi/o11y/installintegration.md): Installs an integration into the caller's org from its id and configuration, answering with the installed catalog item.
- [List accounts](https://docs.hanzo.ai/docs/openapi/o11y/listaccounts.md): Lists the cloud-integration accounts connected for the given provider.
- [List services — GET /v1/o11y/cloud_integrations/{cloud_provider}/accounts/{id}/services](https://docs.hanzo.ai/docs/openapi/o11y/listaccountservicesmetadata.md): Lists the services metadata for one connected account of the given provider, by account id.
- [List channels](https://docs.hanzo.ai/docs/openapi/o11y/listchannels.md): Lists the org's notification channels.
- [List dashboards — GET /v1/o11y/users/me/dashboards](https://docs.hanzo.ai/docs/openapi/o11y/listdashboardsforuserv2.md): Dashboard list V2 personalized for the calling user: each dashboard carries the caller's pinned state, and pinned dashboards float to the top of the requested ordering.
- [List dashboards — GET /v1/o11y/dashboards](https://docs.hanzo.ai/docs/openapi/o11y/listdashboardsv2.md): Returns a page of v2-shape dashboards for the org.
- [List dashboard views](https://docs.hanzo.ai/docs/openapi/o11y/listdashboardviews.md): Returns every saved view in the calling user's org.
- [List downtime schedules](https://docs.hanzo.ai/docs/openapi/o11y/listdowntimeschedules.md): Lists all planned maintenance windows, optionally narrowed to the active ones or the recurring ones.
- [List integrations](https://docs.hanzo.ai/docs/openapi/o11y/listintegrations.md): Lists the available integrations and whether each is installed in the caller's org, optionally narrowed to installed or not-installed.
- [List annotation](https://docs.hanzo.ai/docs/openapi/o11y/listllmannotations.md): Lists human annotations on traces and observations, optionally scoped to one review queue.
- [List observations](https://docs.hanzo.ai/docs/openapi/o11y/listllmobservations.md): Lists gen_ai spans as LLM observations — each an LLM call with its model, token counts, cost and latency projected from gen_ai.* attributes, newest first, over the query window.
- [List llm pricing rules](https://docs.hanzo.ai/docs/openapi/o11y/listllmpricingrules.md): Returns the LLM pricing rules for the caller's org, with pagination and an optional search and override filter.
- [List scores](https://docs.hanzo.ai/docs/openapi/o11y/listllmscores.md): Lists eval scores and human-feedback signals attached to traces and observations, newest first.
- [List sessions — GET /v1/o11y/llm/sessions](https://docs.hanzo.ai/docs/openapi/o11y/listllmsessions.md): Lists conversations — gen_ai spans grouped by session.id, with their trace and observation counts, tokens and cost.
- [List traces — GET /v1/o11y/llm/traces](https://docs.hanzo.ai/docs/openapi/o11y/listllmtraces.md): Lists LLM traces — gen_ai spans grouped by trace_id, with cost, tokens and latency rolled up across each trace.
- [List users](https://docs.hanzo.ai/docs/openapi/o11y/listllmusers.md): Lists end users — gen_ai spans grouped by user.id, with their session, trace and observation counts, tokens and cost.
- [List metric reduction rules](https://docs.hanzo.ai/docs/openapi/o11y/listmetricreductionrules.md): Lists the org's metric volume-control (label reduction) rules, pageable and sortable by name, volume or recency.
- [List metrics — GET /v1/o11y/metrics](https://docs.hanzo.ai/docs/openapi/o11y/listmetrics.md): Lists the distinct metric names seen in a time range, each with its description, type, unit, temporality and monotonicity.
- [List preferences — GET /v1/o11y/org/preferences](https://docs.hanzo.ai/docs/openapi/o11y/listorgpreferences.md): Lists every org-scoped preference, each with its current and default value.
- [List roles — GET /v1/o11y/roles](https://docs.hanzo.ai/docs/openapi/o11y/listroles.md): Lists every role in the caller's org — the managed ones the platform seeds and the custom ones its admins created.
- [List rules](https://docs.hanzo.ai/docs/openapi/o11y/listrules.md): Lists all alert rules with their current evaluation state.
- [List keys — GET /v1/o11y/service_accounts/{id}/keys](https://docs.hanzo.ai/docs/openapi/o11y/listserviceaccountkeys.md): Lists a service account's API keys — metadata only, never the secrets.
- [List service accounts](https://docs.hanzo.ai/docs/openapi/o11y/listserviceaccounts.md): Lists the caller's org's service accounts.
- [List services — GET /v1/o11y/cloud_integrations/{cloud_provider}/services](https://docs.hanzo.ai/docs/openapi/o11y/listservicesmetadata.md): Lists the services the given provider can collect from, optionally scoped to one cloud integration.
- [List span mapper groups](https://docs.hanzo.ai/docs/openapi/o11y/listspanmappergroups.md): Lists the caller's org's mapping groups, optionally only the enabled ones.
- [List span mappers](https://docs.hanzo.ai/docs/openapi/o11y/listspanmappers.md): Lists the mappers belonging to one group, in the order they are applied.
- [List trace funnels](https://docs.hanzo.ai/docs/openapi/o11y/listtracefunnels.md): Lists the caller's org's funnels, each with its steps and who last touched it.
- [List preferences — GET /v1/o11y/user/preferences](https://docs.hanzo.ai/docs/openapi/o11y/listuserpreferences.md): Lists every preference of the calling user, each with its current and default value.
- [Replace lock](https://docs.hanzo.ai/docs/openapi/o11y/lockdashboardv2.md): Locks a v2-shape dashboard.
- [Update reviews](https://docs.hanzo.ai/docs/openapi/o11y/patch-o11y-reviews-by-id.md): Changes a review queue's name, description or score-config set.
- [Update items](https://docs.hanzo.ai/docs/openapi/o11y/patch-o11y-reviews-by-id-items-by-itemid.md): Moves one queue item between PENDING and COMPLETED and sets its assignee.
- [Update dashboards](https://docs.hanzo.ai/docs/openapi/o11y/patchdashboardv2.md): Applies an RFC 6902 JSON Patch to a v2-shape dashboard.
- [Update rules](https://docs.hanzo.ai/docs/openapi/o11y/patchrulebyid.md): Applies a partial update to an alert rule, by id, answering with the stored rule — the common toggle for enabling or muting a rule.
- [Replace pins](https://docs.hanzo.ai/docs/openapi/o11y/pindashboardv2.md): Pins a dashboard for the calling user.
- [Create alerts](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-alerts-by-receiver.md): Records one Alertmanager webhook delivery and pages the on-call.
- [Create attribute values](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-auto-complete-attribute-values.md): Reads the attribute-value request from the body rather than off the query string — the spelling the newer builder uses to send its filters alongside the request.
- [List clusters](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-clusters-list.md): Lists Kubernetes clusters over a time range, each with its CPU and memory usage against allocatable capacity and its attributes; filterable, groupable and paginated.
- [Create countErrors](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-counterrors.md): Counts the grouped exceptions in the query window for the caller's org.
- [List daemonsets](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-daemonsets-list.md): Lists Kubernetes daemonsets over a time range, each with the CPU and memory its pods used against request and limit, desired and available node counts, restarts and attributes; filterable, groupable and paginated.
- [Create dependency graph](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-dependency-graph.md): Returns the service dependency graph over the requested window: every parent→child edge observed, with call and error rates and latency percentiles per edge.
- [List deployments](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-deployments-list.md): Lists Kubernetes deployments over a time range, each with the CPU and memory its pods used against request and limit, desired and available replica counts, restarts and attributes; filterable, groupable and paginated.
- [Create issues](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-errortracking-issues-by-id.md): Changes an issue's lifecycle — resolve, ignore, reopen or assign — and returns the updated issue.
- [Create event](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-event.md): Records one product-analytics event for the signed-in user — a track event with a name and free-form attributes.
- [Create views](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-explorer-views.md): Saves a new explorer view for the caller's org and returns its id.
- [Create export raw data](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-export-raw-data.md): Runs a query and returns its rows as a downloadable CSV or JSONL attachment, chunked, with a trailer that says whether the export completed — so a truncated download is detectable rather than silently short.
- [List hosts — POST /v1/o11y/hosts/list](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-hosts-list.md): Lists monitored hosts over a time range, each with its CPU, memory, I/O wait and 15-minute load, whether it is actively reporting, its OS and its attributes; filterable, groupable and paginated.
- [Create clusters](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-infra-monitoring-clusters.md): Lists Kubernetes clusters with CPU and memory usage against allocatable capacity summed over their nodes, plus per-group node readiness and pod phase counts.
- [Create daemonsets](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-infra-monitoring-daemonsets.md): Lists Kubernetes daemonsets with the CPU and memory their pods used against request and limit, the latest desired and current scheduled NODE counts (node counts, not pod counts), and per-group pod phase counts.
- [Create deployments](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-infra-monitoring-deployments.md): Lists Kubernetes deployments with the CPU and memory their pods used against request and limit, the latest desired and available replica counts, and per-group pod phase counts.
- [Create hosts](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-infra-monitoring-hosts.md): Lists hosts with key infrastructure metrics — CPU, memory, I/O wait and disk usage percentages and 15-minute load — plus an active/inactive status from whether the host reported in the last ten minutes.
- [Create jobs](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-infra-monitoring-jobs.md): Lists Kubernetes jobs with the CPU and memory their pods used against request and limit, the latest desired-successful, active, failed and successful pod counters, and per-group pod phase counts — the phase counts are current state while the counters are cumulative over the job's life.
- [Create namespaces](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-infra-monitoring-namespaces.md): Lists Kubernetes namespaces with the CPU and memory their pods used and per-group pod phase counts.
- [Create nodes](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-infra-monitoring-nodes.md): Lists Kubernetes nodes with CPU and memory usage against allocatable capacity, per-group readiness counts and per-group phase counts for the pods scheduled on them.
- [Create pods](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-infra-monitoring-pods.md): Lists Kubernetes pods with CPU and memory usage against request and limit, the pod's phase and its age, plus its namespace, node, owning workload and cluster attributes.
- [Create pvcs](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-infra-monitoring-pvcs.md): Lists Kubernetes persistent volume claims with available, capacity and used bytes and inode counts, plus the claim's pod, namespace, node, statefulset and cluster attributes.
- [Create statefulsets](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-infra-monitoring-statefulsets.md): Lists Kubernetes statefulsets with the CPU and memory their pods used against request and limit, the latest desired and current replica counts, and per-group pod phase counts.
- [List jobs](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-jobs-list.md): Lists Kubernetes jobs over a time range, each with the CPU and memory its pods used against request and limit, desired-successful, active, failed and successful pod counts, restarts and attributes; filterable, groupable and paginated.
- [Create listErrors](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-listerrors.md): Lists the grouped exceptions in the query window — each an exception type with its message, count, service and first/last-seen — for the caller's org.
- [Create fields — POST /v1/o11y/logs/fields](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-logs-fields.md): Changes how one log field is stored — selects or deselects it as a materialized column and tunes its index — and echoes the setting back.
- [Create pipelines](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-logs-pipelines.md): Saves the given log parsing pipelines as the new config version for the caller's org and starts deploying it.
- [Preview pipelines](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-logs-pipelines-preview.md): Runs the given log parsing pipelines over the given sample records without saving anything, and returns the transformed records plus whatever the collector logged while simulating them.
- [Create promote paths](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-logs-promote-paths.md): Promotes and indexes log body paths: each named path is lifted out of the JSON body into its own column, with the indexes the caller asked for.
- [Create consumer details — POST /v1/o11y/messaging-queues/kafka/consumer-lag/consumer-details](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-messaging-queues-kafka-consumer-lag-consumer-details.md): Returns the consumer side of a consumer-lag view: the consumer groups reading the topic/partition named in variables, with their throughput and latency over the window.
- [Create network latency](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-messaging-queues-kafka-consumer-lag-network-latency.md): Returns consumer network latency correlated per client: a throughput pass over the window finds the consumer clients, then their fetch latency joins in as a latency column per client/instance/service.
- [Create producer details — POST /v1/o11y/messaging-queues/kafka/consumer-lag/producer-details](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-messaging-queues-kafka-consumer-lag-producer-details.md): Returns the producer side of a consumer-lag view: the producers writing to the topic/partition named in variables, with their throughput and latency over the window.
- [Create consumers](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-messaging-queues-kafka-onboarding-consumers.md): Checks whether the spans the Kafka consumer views need are arriving, row for row like producersOnboarding.
- [Create kafka](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-messaging-queues-kafka-onboarding-kafka.md): Checks whether Kafka's own metrics — consumer lag and partition telemetry — are arriving, so the lag views can be lit up.
- [Create producers](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-messaging-queues-kafka-onboarding-producers.md): Checks whether the spans the Kafka producer views need are arriving — one row per required span attribute, with a pass/fail status and, on failure, what is missing from the instrumentation.
- [Create consumer — POST /v1/o11y/messaging-queues/kafka/partition-latency/consumer](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-messaging-queues-kafka-partition-latency-consumer.md): Returns the consumer-group latency detail for the topic and partition named in the request's variables.
- [Create overview — POST /v1/o11y/messaging-queues/kafka/partition-latency/overview](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-messaging-queues-kafka-partition-latency-overview.md): Returns the per-partition latency overview for the window — each topic/partition with its throughput and latency profile.
- [Create evaluation](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-messaging-queues-kafka-span-evaluation.md): Correlates producer and consumer spans over the evaluation window (eval_time bounds the scan) and returns the pairings with their end-to-end delay — the check that messages produced are being consumed.
- [Create consumer — POST /v1/o11y/messaging-queues/kafka/topic-throughput/consumer](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-messaging-queues-kafka-topic-throughput-consumer.md): Returns the consumer topic-throughput overview for the window — what each consumer group read, per topic.
- [Create consumer details — POST /v1/o11y/messaging-queues/kafka/topic-throughput/consumer-details](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-messaging-queues-kafka-topic-throughput-consumer-details.md): Breaks one consumer topic's throughput down using the topic and service named in variables.
- [Create producer](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-messaging-queues-kafka-topic-throughput-producer.md): Returns the producer topic-throughput overview for the window — what each producer service wrote, per topic.
- [Create producer details — POST /v1/o11y/messaging-queues/kafka/topic-throughput/producer-details](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-messaging-queues-kafka-topic-throughput-producer-details.md): Breaks one producer topic's throughput down using the topic and service named in variables.
- [Create queue overview](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-messaging-queues-queue-overview.md): Lists the messaging destinations observed in the window — one row per queue/destination/service combination with its throughput and latency columns.
- [List namespaces](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-namespaces-list.md): Lists Kubernetes namespaces over a time range, each with the CPU and memory its pods used, their phase counts and its attributes; filterable, groupable and paginated.
- [List nodes](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-nodes-list.md): Lists Kubernetes nodes over a time range, each with its CPU and memory usage against allocatable capacity, readiness condition counts and attributes; filterable, groupable and paginated.
- [List pods](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-pods-list.md): Lists Kubernetes pods over a time range, each with its CPU and memory usage against request and limit, restart count, phase counts and attributes; filterable, groupable and paginated.
- [List processes](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-processes-list.md): Lists monitored processes over a time range, each with its name, PID, command line and CPU and memory usage; filterable, groupable and paginated.
- [List pvcs](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-pvcs-list.md): Lists Kubernetes persistent volume claims over a time range, each with its available, capacity and used bytes, inode counts and attributes; filterable, groupable and paginated.
- [Create analyze](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-query-filter-analyze.md): Analyzes a query and extracts the metric names it reads and the columns it groups by.
- [Create query range](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-query-range.md): Executes a composite query over a time range: builder queries over traces, logs and metrics, formulas, trace operators, PromQL and Datastore SQL, answering time series, scalars or raw records as the request type asks.
- [Create format](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-query-range-format.md): Parses a builder query and echoes it back normalized to the v3 shape — the endpoint the UI uses to canonicalize a query without running it.
- [Preview query range](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-query-range-preview.md): Validates a composite query and renders the Datastore statements it would run WITHOUT executing it — a dry run for agentic and tooling use.
- [Create reviews](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-reviews.md): Creates a human-review queue in the caller's org and project.
- [Create items](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-reviews-by-id-items.md): Enqueues traces, observations or sessions on a review queue.
- [Create discover](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-sentinel-discover.md): Aggregates a project's captured errors into a table — the caller names the filters, the groupings and the aggregations, and gets back the columns and rows they asked for.
- [Create projects](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-sentinel-projects.md): Creates a Sentry project under the caller's org and returns it.
- [Create entry point operations](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-service-entry-point-operations.md): Returns one service's entry-point operations with the same latency and error profile topOperations reports.
- [Create top level operations](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-service-top-level-operations.md): Maps each service to its entry-point span names — for the one service named in the request, or for every service when none is.
- [Create top operations](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-service-top-operations.md): Returns one service's heaviest operations in the window, each with p50/p95/p99 latency, how often it ran and how often it errored.
- [Create services](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-services.md): Lists the instrumented services seen in the window, each with the request profile of its entry-point spans: p99 and average latency, call and error rates, and the entry-point operations the numbers were computed over.
- [Create apdex](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-settings-apdex.md): Sets one service's apdex threshold and the status codes excluded from its score.
- [Create ttl](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-settings-ttl.md): Sets the org's retention policy for one signal: the default TTL in days, ordered per-label retention rules, and optional cold-storage settings.
- [Create span percentile](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-span-percentile.md): Places one span's duration among its peers: the p50/p90/p99 durations of like spans, and the percentile the given duration lands at.
- [List statefulsets](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-statefulsets-list.md): Lists Kubernetes statefulsets over a time range, each with the CPU and memory its pods used against request and limit, desired and available replica counts, restarts and attributes; filterable, groupable and paginated.
- [Create substitute vars](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-substitute-vars.md): Substitutes a query's variables and returns the resolved request, without running it — what a dashboard does before it queries.
- [Create domain](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-third-party-apis-overview-domain.md): Returns one external domain's endpoint-level breakdown — each endpoint with its rate, error and latency columns over the window.
- [List overview](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-third-party-apis-overview-list.md): Lists the external domains the instrumented services call, with request rate, error percentage and latency per domain.
- [Query variables](https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-variables-query.md): Evaluates a dashboard variable query and returns the values the variable may take.
- [Preview metric reduction rules](https://docs.hanzo.ai/docs/openapi/o11y/previewmetricreductionrule.md): Estimates the series reduction and the dashboards and alerts a candidate volume-control rule would touch, without persisting it.
- [Replace views](https://docs.hanzo.ai/docs/openapi/o11y/put-o11y-explorer-views-by-viewid.md): Replaces one saved explorer view by id with the given view and echoes it back.
- [Replace issues](https://docs.hanzo.ai/docs/openapi/o11y/put-o11y-sentinel-issues-by-id.md): Changes an issue's lifecycle — resolve, ignore, reopen or assign — and returns the updated issue.
- [Replace hosts](https://docs.hanzo.ai/docs/openapi/o11y/puthost.md): Records the deployment's host in Zeus, overwriting any prior one.
- [Replace profiles](https://docs.hanzo.ai/docs/openapi/o11y/putprofile.md): Records the deployment's profile in Zeus — how the team uses observability today and what they plan — overwriting any prior one.
- [Delete keys](https://docs.hanzo.ai/docs/openapi/o11y/revokeserviceaccountkey.md): Revokes an API key.
- [Search ingestion keys](https://docs.hanzo.ai/docs/openapi/o11y/searchingestionkeys.md): Lists the workspace's ingestion keys whose name matches the search, paginated.
- [Get traces — GET /v1/o11y/traces/{traceId}](https://docs.hanzo.ai/docs/openapi/o11y/searchtraces.md): Returns one trace's spans as a column/row table, optionally centred on a span and walked a fixed number of levels up and down from it — the read the trace explorer opens a trace with.
- [Test channels](https://docs.hanzo.ai/docs/openapi/o11y/testchannel.md): Sends a test notification to the posted receiver.
- [Create testChannel](https://docs.hanzo.ai/docs/openapi/o11y/testchanneldeprecated.md): Sends a test notification to the posted receiver.
- [Test rules](https://docs.hanzo.ai/docs/openapi/o11y/testrule.md): Fires a test notification for a rule definition without saving it, answering with how many series would alert.
- [Create testRule](https://docs.hanzo.ai/docs/openapi/o11y/testrulenotification.md): Fires a test notification for the posted rule definition and answers with how many series alerted and a status message.
- [Create uninstall](https://docs.hanzo.ai/docs/openapi/o11y/uninstallintegration.md): Removes an integration from the caller's org by id.
- [Delete lock](https://docs.hanzo.ai/docs/openapi/o11y/unlockdashboardv2.md): Unlocks a v2-shape dashboard.
- [Delete pins](https://docs.hanzo.ai/docs/openapi/o11y/unpindashboardv2.md): Removes the caller's pin for a dashboard.
- [Replace accounts](https://docs.hanzo.ai/docs/openapi/o11y/updateaccount.md): Changes a connected account's configuration for the given provider, by id.
- [Replace channels](https://docs.hanzo.ai/docs/openapi/o11y/updatechannelbyid.md): Replaces a notification channel's receiver, by id.
- [Replace dashboards](https://docs.hanzo.ai/docs/openapi/o11y/updatedashboardv2.md): Updates a v2-shape dashboard's metadata, spec and tag set.
- [Replace dashboard views](https://docs.hanzo.ai/docs/openapi/o11y/updatedashboardview.md): Replaces a saved view's name and data.
- [Replace downtime schedules](https://docs.hanzo.ai/docs/openapi/o11y/updatedowntimeschedulebyid.md): Replaces a planned maintenance window, by id.
- [Update ingestion keys](https://docs.hanzo.ai/docs/openapi/o11y/updateingestionkey.md): Changes an ingestion key, by id.
- [Update limits](https://docs.hanzo.ai/docs/openapi/o11y/updateingestionkeylimit.md): Changes an ingestion key limit, by limit id.
- [Create metadata](https://docs.hanzo.ai/docs/openapi/o11y/updatemetricmetadata.md): Updates one metric's metadata — description, type, unit, temporality, monotonicity — and answers with the bare success envelope.
- [Replace metric reduction rules](https://docs.hanzo.ai/docs/openapi/o11y/updatemetricreductionrulebyid.md): Updates the match type and labels of a volume-control rule by its id; the metric name is immutable.
- [Replace me — PUT /v1/o11y/orgs/me](https://docs.hanzo.ai/docs/openapi/o11y/updatemyorganization.md): Rewrites the caller's own organization record — display name, name, alias — always addressed as "me", never by id.
- [Replace me — PUT /v1/o11y/service_accounts/me](https://docs.hanzo.ai/docs/openapi/o11y/updatemyserviceaccount.md): Renames the calling service account.
- [Replace preferences — PUT /v1/o11y/org/preferences/{name}](https://docs.hanzo.ai/docs/openapi/o11y/updateorgpreference.md): Sets one org-scoped preference, by name.
- [Replace public](https://docs.hanzo.ai/docs/openapi/o11y/updatepublicdashboard.md): Updates the public-sharing config for a dashboard.
- [Replace filters](https://docs.hanzo.ai/docs/openapi/o11y/updatequickfilters.md): Replaces the org's quick filters for one signal with the attribute list given.
- [Replace roles](https://docs.hanzo.ai/docs/openapi/o11y/updaterole.md): Replaces a custom role's description and transaction groups.
- [Replace route policies](https://docs.hanzo.ai/docs/openapi/o11y/updateroutepolicy.md): Replaces a route policy, by id, answering with the stored policy.
- [Replace rules](https://docs.hanzo.ai/docs/openapi/o11y/updaterulebyid.md): Replaces an alert rule's definition, by id.
- [Replace services](https://docs.hanzo.ai/docs/openapi/o11y/updateservice.md): Changes a service's configuration for one connected account of the given provider, by account id and service id.
- [Replace service accounts](https://docs.hanzo.ai/docs/openapi/o11y/updateserviceaccount.md): Renames a service account.
- [Replace keys](https://docs.hanzo.ai/docs/openapi/o11y/updateserviceaccountkey.md): Renames an API key or moves its expiry.
- [Update span mappers](https://docs.hanzo.ai/docs/openapi/o11y/updatespanmapper.md): Changes a mapper's field context, config or enabled state.
- [Update span mapper groups](https://docs.hanzo.ai/docs/openapi/o11y/updatespanmappergroup.md): Changes a group's name, condition or enabled state.
- [Create fields — POST /v1/o11y/traces/fields](https://docs.hanzo.ai/docs/openapi/o11y/updatetracefield.md): Changes how one span field is stored — selects or deselects it as a materialized column and tunes its index — and echoes the setting back.
- [Replace trace funnels](https://docs.hanzo.ai/docs/openapi/o11y/updatetracefunnel.md): Renames a funnel or rewrites its description, answering the funnel as it now stands.
- [Update steps](https://docs.hanzo.ai/docs/openapi/o11y/updatetracefunnelsteps.md): Replaces a funnel's steps — the funnel is named in the body rather than the path — and answers the funnel as it now stands.
- [Replace preferences — PUT /v1/o11y/user/preferences/{name}](https://docs.hanzo.ai/docs/openapi/o11y/updateuserpreference.md): Sets one preference of the calling user, by name.
- [Validate analytics — POST /v1/o11y/trace-funnels/analytics/validate](https://docs.hanzo.ai/docs/openapi/o11y/validatedraftfunneltraces.md): Lists the traces that match a funnel described inline — the builder's "try this" before anything is saved.
- [Validate analytics — POST /v1/o11y/trace-funnels/{funnel_id}/analytics/validate](https://docs.hanzo.ai/docs/openapi/o11y/validatetracefunneltraces.md): Lists the traces that match a saved funnel over a window — the read that answers "is this funnel finding anything at all".
- [OpenAPI](https://docs.hanzo.ai/docs/openapi/openapi.md): The served contract: the OpenAPI document every client, tool list and command group is generated from, its command projection, the agent endpoint that offers the same operations over MCP, and the index a client follows from the API root to reach any of it.
- [List v1](https://docs.hanzo.ai/docs/openapi/openapi/get-capabilities.md): The API root.
- [GET /v1/{name}](https://docs.hanzo.ai/docs/openapi/openapi/get-capability.md): What the capability named in the path answers: every published operation, its operationId, its method and its address, and the sentence lifted from the handler that serves it — plus the way back to /v1.
- [List commands](https://docs.hanzo.ai/docs/openapi/openapi/get-openapi-commands.md): The command projection of the OpenAPI document at /v1/openapi.json — each operation reduced to what running it by name needs: its service and command token, its method and path, the prose lifted from the handler, its path parameters as positional arguments and its remaining inputs as typed flags.
- [List openapi.json](https://docs.hanzo.ai/docs/openapi/openapi/get-openapijson.md): Serves the OpenAPI document for the routes this process actually answers — generated from the live router at request time, not from a checked-in file that can disagree with it.
- [Create mcp](https://docs.hanzo.ai/docs/openapi/openapi/post-mcp.md): Model Context Protocol over JSON-RPC 2.0 — one POST per message, stateless, protocol revision 2026-07-28.
- [Patrol](https://docs.hanzo.ai/docs/openapi/patrol.md): Stands watch over an estate: sites, units, tours, keys, cameras, and the incidents that interrupt them.
- [List camera](https://docs.hanzo.ai/docs/openapi/patrol/get-patrol-camera.md): Lists the cameras a caller may OPEN.
- [List stream](https://docs.hanzo.ai/docs/openapi/patrol/get-patrol-camera-by-name-stream.md): Mints a short-lived way in to one camera.
- [Get stream](https://docs.hanzo.ai/docs/openapi/patrol/get-patrol-camera-by-name-stream-by-ticket.md): Redeems a minted ticket for what opens the camera.
- [List event](https://docs.hanzo.ai/docs/openapi/patrol/get-patrol-event.md): Lists the feed, newest first.
- [List feed](https://docs.hanzo.ai/docs/openapi/patrol/get-patrol-feed.md): Holds a Server-Sent Events connection open and writes every change in the picture as it happens: a unit's position, an incident moving, a feed row, a checkpoint confirmed.
- [List incident](https://docs.hanzo.ai/docs/openapi/patrol/get-patrol-incident.md): Lists responses.
- [Get incident](https://docs.hanzo.ai/docs/openapi/patrol/get-patrol-incident-by-name.md): Returns one response whole: the incident, every act performed on it, and the SLA clocks those acts settled.
- [List key](https://docs.hanzo.ai/docs/openapi/patrol/get-patrol-key.md): Lists the key register.
- [Get key](https://docs.hanzo.ai/docs/openapi/patrol/get-patrol-key-by-name.md): Returns one key set from the register.
- [List note](https://docs.hanzo.ai/docs/openapi/patrol/get-patrol-note.md): Lists internal remarks.
- [Get report](https://docs.hanzo.ai/docs/openapi/patrol/get-patrol-report-by-name.md): Renders a filed report as a PDF and answers with the bytes under an attachment filename.
- [List site](https://docs.hanzo.ai/docs/openapi/patrol/get-patrol-site.md): Lists the estate.
- [Get site](https://docs.hanzo.ai/docs/openapi/patrol/get-patrol-site-by-name.md): Returns one site whole: the register row plus the panel's zones and the standing hazards, which ride inside the document.
- [List snapshot](https://docs.hanzo.ai/docs/openapi/patrol/get-patrol-snapshot.md): Returns the whole picture in one read: sites, units with their position trails, today's tours and checkpoints, the key register, the recent feed and the open incident.
- [Get tenant](https://docs.hanzo.ai/docs/openapi/patrol/get-patrol-tenant-by-org.md): Returns one org's public face — brand, company, operations, features and terminology.
- [List tour](https://docs.hanzo.ai/docs/openapi/patrol/get-patrol-tour.md): Lists patrol rounds with their checkpoints — the proof-of-presence record.
- [List unit](https://docs.hanzo.ai/docs/openapi/patrol/get-patrol-unit.md): Lists the fleet with each unit's position trail, which is what the map draws.
- [List near](https://docs.hanzo.ai/docs/openapi/patrol/get-patrol-unit-near.md): Answers which units can reach a site soonest.
- [Create alarm](https://docs.hanzo.ai/docs/openapi/patrol/post-patrol-alarm.md): Takes one activation.
- [Create event](https://docs.hanzo.ai/docs/openapi/patrol/post-patrol-event.md): Writes one feed row by hand and pushes it to every screen watching.
- [Create incident](https://docs.hanzo.ai/docs/openapi/patrol/post-patrol-incident.md): Records a response by hand, in state received and carrying the site's tier and SLA.
- [Create step](https://docs.hanzo.ai/docs/openapi/patrol/post-patrol-incident-by-name-step.md): Performs one act on an incident: it stamps the act's time, moves the state, appends the act to the trail, and runs what the act sets in motion — a unit assigned, a site secured, a report filed, a controller told.
- [Create move](https://docs.hanzo.ai/docs/openapi/patrol/post-patrol-key-by-name-move.md): Records a key set leaving, returning, or being counted, and moves the register row to match.
- [Create note](https://docs.hanzo.ai/docs/openapi/patrol/post-patrol-note.md): Records an internal remark, stamped with who wrote it.
- [Create confirm](https://docs.hanzo.ai/docs/openapi/patrol/post-patrol-point-by-name-confirm.md): Records presence at a checkpoint: who confirmed it, the method, where they stood, and the photo key if one was taken.
- [Create report](https://docs.hanzo.ai/docs/openapi/patrol/post-patrol-report.md): Composes and files a report from one estate read, so the same figures read the same a month later.
- [Create fix](https://docs.hanzo.ai/docs/openapi/patrol/post-patrol-unit-by-name-fix.md): Records where a unit is.
- [Create state](https://docs.hanzo.ai/docs/openapi/patrol/post-patrol-unit-by-name-state.md): Moves a unit between states — on shift, on a break, off, or in trouble.
- [Replace site](https://docs.hanzo.ai/docs/openapi/patrol/put-patrol-site-by-name.md): Changes a site's contract and brief fields.
- [Plan](https://docs.hanzo.ai/docs/openapi/plan.md): The plan catalog: every tier you can buy, what it costs, and what it grants.
- [List plan](https://docs.hanzo.ai/docs/openapi/plan/get-plan.md): Returns the Hanzo cloud plan catalog: every cloud tier with its price, included capacity, limits and feature list, scoped to the caller's catalog.
- [List blockchain](https://docs.hanzo.ai/docs/openapi/plan/get-plan-blockchain.md): Returns the blockchain RPC plan catalog: the tiers metered in monthly compute units, with their prices, limits and overage terms.
- [List dns](https://docs.hanzo.ai/docs/openapi/plan/get-plan-dns.md): Returns the DNS plan catalog: the tiers priced on zones, records per zone and queries per day.
- [Get entitlements](https://docs.hanzo.ai/docs/openapi/plan/get-plan-entitlements-by-id.md): Returns what one plan GRANTS and not what it costs: the canonical namespaced entitlement block and the flat license-feature list derived from it.
- [List gpu](https://docs.hanzo.ai/docs/openapi/plan/get-plan-gpu.md): Returns the rentable GPU configurations, each with its accelerator count and model, VRAM, vCPUs, host memory and hourly price.
- [List health](https://docs.hanzo.ai/docs/openapi/plan/get-plan-health.md): Reports that the plans subsystem is mounted and serving.
- [List policy](https://docs.hanzo.ai/docs/openapi/plan/get-plan-policy.md): Returns the published pricing policy: whether pricing is transparent, the revenue-sharing terms (idle compute resale and the open-source share) and the principles the catalog is priced by.
- [List regions](https://docs.hanzo.ai/docs/openapi/plan/get-plan-regions.md): Returns the regions cloud capacity is offered in, each with its display name and physical location.
- [Get resolve](https://docs.hanzo.ai/docs/openapi/plan/get-plan-resolve-by-id.md): Resolves one plan to everything a consumer of the catalog needs at once: its canonical entitlement block, the flat license-feature list a signed license carries, its billing reference, and the catalog it came from.
- [List schema](https://docs.hanzo.ai/docs/openapi/plan/get-plan-schema.md): Returns the two JSON Schema documents this surface speaks: entitlements.schema.json, which declares every entitlement key with its type, unit and enum, and plan.schema.json, which a catalog plan record conforms to.
- [List storage](https://docs.hanzo.ai/docs/openapi/plan/get-plan-storage.md): Returns the block-storage price block: the price per GB per month and the volume size bounds a cloud plan may attach.
- [List subscriptions](https://docs.hanzo.ai/docs/openapi/plan/get-plan-subscriptions.md): Returns the subscription ladder — the personal and team tiers a customer buys to use the cloud, each with its monthly and annual price, seat rules, limits and billing reference.
- [List tools](https://docs.hanzo.ai/docs/openapi/plan/get-plan-tools.md): Returns the per-use price of every metered tool — web search, code interpreter, image generation, speech — each with the unit it is billed in.
- [List vocab](https://docs.hanzo.ai/docs/openapi/plan/get-plan-vocab.md): Returns the entitlement key vocabulary: every key with its namespace, JSON type, nullability, unit, enum and title, the list of namespaces, and the engine features a license can grant.
- [Platform](https://docs.hanzo.ai/docs/openapi/platform.md): Hanzo PaaS: deploy containers to your own tenant namespace — builds, releases, environments, logs, custom domains.
- [Delete projects](https://docs.hanzo.ai/docs/openapi/platform/delete-platform-projects-by-project.md): Folds a project into another.
- [Delete apps](https://docs.hanzo.ai/docs/openapi/platform/delete-platform-projects-by-project-apps-by-app.md): Deletes an application and tears down what it runs.
- [Delete domains](https://docs.hanzo.ai/docs/openapi/platform/delete-platform-projects-by-project-apps-by-app-domains-by-host.md): Detaches a hostname and releases the claim.
- [Get build](https://docs.hanzo.ai/docs/openapi/platform/get-build-by-id.md): Answers one build: its status, and for a failed build the reason.
- [List apps — GET /v1/platform/apps](https://docs.hanzo.ai/docs/openapi/platform/get-platform-apps.md): Answers what this organisation has declared, joined with what the delivery plane has done about it.
- [Get apps — GET /v1/platform/apps/{app}](https://docs.hanzo.ai/docs/openapi/platform/get-platform-apps-by-app.md): Answers ONE declaration — what git says this app is, before the delivery plane has had any say in it.
- [List cd — GET /v1/platform/apps/{app}/cd](https://docs.hanzo.ai/docs/openapi/platform/get-platform-apps-by-app-cd.md): Answers ONE app's reconciliation alone — the poll a deploy console makes while it waits, without re-reading the whole inventory each time.
- [List builds](https://docs.hanzo.ai/docs/openapi/platform/get-platform-builds.md): Returns real build records for your org.
- [List cd — GET /v1/platform/cd](https://docs.hanzo.ai/docs/openapi/platform/get-platform-cd.md): Answers every Application the delivery plane holds.
- [List environments](https://docs.hanzo.ai/docs/openapi/platform/get-platform-environments.md): Returns your deploy targets, and what is running on each.
- [List fleet](https://docs.hanzo.ai/docs/openapi/platform/get-platform-fleet.md): Returns the platform's own service tier, and where it has drifted.
- [Get fleet](https://docs.hanzo.ai/docs/openapi/platform/get-platform-fleet-by-app.md): Returns one platform service, resolved to production by default.
- [List health](https://docs.hanzo.ai/docs/openapi/platform/get-platform-health.md): Reports whether this control plane can actually deploy anything.
- [List pipelines](https://docs.hanzo.ai/docs/openapi/platform/get-platform-pipelines.md): Returns one build-and-deploy pipeline per app, with its latest run.
- [List projects](https://docs.hanzo.ai/docs/openapi/platform/get-platform-projects.md): Answers every project the caller may see, with how its apps stand.
- [Get projects](https://docs.hanzo.ai/docs/openapi/platform/get-platform-projects-by-project.md): Answers one project and every app in it.
- [List apps — GET /v1/platform/projects/{project}/apps](https://docs.hanzo.ai/docs/openapi/platform/get-platform-projects-by-project-apps.md): Returns the applications in one project, with what the cluster says about them.
- [Get apps — GET /v1/platform/projects/{project}/apps/{app}](https://docs.hanzo.ai/docs/openapi/platform/get-platform-projects-by-project-apps-by-app.md): Returns one application, with its live phase, health and secret sync.
- [List deployments](https://docs.hanzo.ai/docs/openapi/platform/get-platform-projects-by-project-apps-by-app-deployments.md): Returns an app's deployment history.
- [Get deployments](https://docs.hanzo.ai/docs/openapi/platform/get-platform-projects-by-project-apps-by-app-deployments-by-id.md): Returns one deployment of one app.
- [List logs](https://docs.hanzo.ai/docs/openapi/platform/get-platform-projects-by-project-apps-by-app-deployments-by-id-logs.md): Returns real logs for a deployment — the build's, then the app's.
- [List domains](https://docs.hanzo.ai/docs/openapi/platform/get-platform-projects-by-project-apps-by-app-domains.md): Returns every hostname this app answers on.
- [List releases](https://docs.hanzo.ai/docs/openapi/platform/get-platform-releases.md): Returns the versions that actually reached the cluster.
- [Create build](https://docs.hanzo.ai/docs/openapi/platform/post-build.md): Triggers a native build — an image, or the binaries a repo declares.
- [Create apps — POST /v1/platform/apps](https://docs.hanzo.ai/docs/openapi/platform/post-platform-apps.md): Builds a git repository into an image and writes the declaration that names it — a values file in `hanzoai/universe` under `charts/app/values/<namespace>/<name>.yaml`, which the `fleet` ApplicationSet renders as one Application.
- [Create projects](https://docs.hanzo.ai/docs/openapi/platform/post-platform-projects.md): Creates a project from the apps it starts with.
- [Create apps — POST /v1/platform/projects/{project}/apps](https://docs.hanzo.ai/docs/openapi/platform/post-platform-projects-by-project-apps.md): Creates an application from a git repo or a container image.
- [Deploy apps](https://docs.hanzo.ai/docs/openapi/platform/post-platform-projects-by-project-apps-by-app-deploy.md): Deploys the app — building it first if it comes from git.
- [Create domains](https://docs.hanzo.ai/docs/openapi/platform/post-platform-projects-by-project-apps-by-app-domains.md): Attaches a hostname — instantly if you already own it, otherwise with a DNS challenge.
- [Verify domains](https://docs.hanzo.ai/docs/openapi/platform/post-platform-projects-by-project-apps-by-app-domains-by-host-verify.md): Checks a custom domain's DNS and turns it on if it passes.
- [Preview apps](https://docs.hanzo.ai/docs/openapi/platform/post-platform-projects-by-project-apps-by-app-preview.md): Puts a branch on its own URL.
- [Create promote](https://docs.hanzo.ai/docs/openapi/platform/post-platform-projects-by-project-apps-by-app-promote.md): Promotes an already-built release to the app.
- [Create rollback](https://docs.hanzo.ai/docs/openapi/platform/post-platform-projects-by-project-apps-by-app-rollback.md): Goes back to the previous release.
- [Start apps](https://docs.hanzo.ai/docs/openapi/platform/post-platform-projects-by-project-apps-by-app-start.md): Starts a stopped app back up.
- [Stop apps](https://docs.hanzo.ai/docs/openapi/platform/post-platform-projects-by-project-apps-by-app-stop.md): Stops an app without deleting it.
- [Run platform](https://docs.hanzo.ai/docs/openapi/platform/post-platform-run.md): Runs a container image and gives back a URL.
- [Replace project](https://docs.hanzo.ai/docs/openapi/platform/put-platform-apps-by-app-project.md): Moves an app to a project.
- [Replace projects](https://docs.hanzo.ai/docs/openapi/platform/put-platform-projects-by-project.md): Renames a project.
- [Replace env](https://docs.hanzo.ai/docs/openapi/platform/put-platform-projects-by-project-apps-by-app-env.md): Replaces an app's environment variables.
- [Plugins](https://docs.hanzo.ai/docs/openapi/plugins.md): Plugins — reached at /v1/admin/plugins; not in the public REST contract.
- [Pref](https://docs.hanzo.ai/docs/openapi/pref.md): Your own settings — theme, density, pinned nav — following you across every Hanzo app.
- [List pref](https://docs.hanzo.ai/docs/openapi/pref/get-pref.md): Returns the signed-in caller's OWN preference document — the theme, density and pinned nav that follow them across every Hanzo surface.
- [Update pref](https://docs.hanzo.ai/docs/openapi/pref/patch-pref.md): Merges a JSON object key-wise into the signed-in caller's OWN preference document and answers with the whole document after the merge, so a surface saves `theme` without having to send back the `density` another surface owns.
- [Pricing](https://docs.hanzo.ai/docs/openapi/pricing.md): The price list: what every model, provider, GPU tier, tool and hosting plan costs.
- [List pricing](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing.md): Returns the whole pricing catalog in one document: Zen and third-party models, providers, model families, the free-model list, plan and infrastructure pricing.
- [List base](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-base.md): Returns the Hanzo Base plans — the managed-instance tiers, each with its monthly and annual price, storage and request allowances and feature list.
- [List blockchain](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-blockchain.md): Returns the blockchain access plans — the RPC and node tiers, each with its monthly price, compute-unit allowance and feature list.
- [List cloud](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-cloud.md): Returns the public cloud section of the catalog in one document: its instance plans, its regions and its block-storage prices.
- [List plans](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-cloud-plans.md): Returns just the cloud instance plans — each with its vCPU, memory, disk, CPU type, VM allowance, feature list and monthly and hourly price.
- [List regions](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-cloud-regions.md): Returns the regions a cloud instance can be placed in, each with its id, display name and physical location.
- [List storage](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-cloud-storage.md): Returns the block-storage prices of the cloud section: the per-GB monthly rate and the volume size bounds a caller may ask for.
- [List compute](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-compute.md): Returns the compute section of the catalog: the cloud provider and region the prices are quoted for, the monthly markup applied to them, the full instance-size tier list and the named presets.
- [List presets](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-compute-presets.md): Returns just the named compute sizes — the short, human-labelled list ("Starter", "Pro") a size picker renders, each carrying its provider slug, vCPU, memory, disk and price.
- [List datastore](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-datastore.md): Returns the Hanzo Datastore rate card: the tier list, the per-GB storage and egress usage rates, the annual discount and the trial.
- [List enablement](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-enablement.md): Returns what the caller's org can actually use: every managed item with its global state, whether it is effective here, whether this org is already opted into its beta, and whether it may still opt in.
- [List featured](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-featured.md): Returns the models the catalog highlights, filtered to what the caller's org may see.
- [List free](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-free.md): Returns the models that cost nothing to call, filtered to what the caller's org may see.
- [List gpu](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-gpu.md): Returns the rentable GPU configurations, each with its accelerator count and model, VRAM, vCPU, host memory and hourly price.
- [List health](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-health.md): Reports that the pricing subsystem is mounted and serving.
- [List iam](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-iam.md): Returns the identity plans — the Hanzo IAM tiers, each with its monthly and annual price, monthly-active-user allowance and feature list.
- [Get model](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-model-by-name.md): Returns one model's catalog entry — its pricing, context window and capabilities as the pricing source records them.
- [List models](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-models.md): Returns the whole model catalog — every model the gateway serves, Zen and third-party alike — filtered to what the caller's org may see.
- [List paas](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-paas.md): Returns the application-hosting plans — the deploy-and-host tiers, each with its monthly and annual price, app and memory allowances and feature list.
- [List policy](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-policy.md): Returns the pricing policy document: the revenue-sharing terms (the idle-resale share and the open-source share, each with its percentage and who is eligible) and the commitments Hanzo makes about how it bills — no hidden fees, no egress charges, no surprise bills.
- [List providers](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-providers.md): Returns the model providers the catalog knows, each with its info object, filtered to what the caller's org may see.
- [List services](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-services.md): Returns the managed-service rate cards — Search, Crawl, Vector, Console and Managed Services — each with its own tiers, and some with usage rates or a comparison table.
- [List subscriptions](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-subscriptions.md): Returns the API subscription plans — the account-level tiers a customer subscribes to, each with its monthly and annual price, included credit, rate limits and feature list.
- [List summary](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-summary.md): Returns the catalog's headline statistics — model counts by family and the provider directory.
- [List tariff](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-tariff.md): Returns the platform's rate card: what a bill is made of, what each part costs, and the completion windows a request may ask for.
- [List tools](https://docs.hanzo.ai/docs/openapi/pricing/get-pricing-tools.md): Returns the per-use tool prices — web search, web fetch, code interpreter, file storage, image generation, speech-to-text and text-to-speech — each with the unit it is billed by and its price in that unit.
- [Create optin](https://docs.hanzo.ai/docs/openapi/pricing/post-pricing-enablement-optin.md): Opts the caller's OWN org into a beta item.
- [Create optout](https://docs.hanzo.ai/docs/openapi/pricing/post-pricing-enablement-optout.md): Removes the caller's OWN org from a beta item's grant list, the reverse of OptIntoBeta and idempotent.
- [Principal](https://docs.hanzo.ai/docs/openapi/principal.md): Serves an org as an economic principal: who it is, what it may pay, and which agents answer to it.
- [List principal](https://docs.hanzo.ai/docs/openapi/principal/get-principal.md): Returns the caller's org as an economic principal, composed from the apps that own each fact: its legal entity and founders' identity verification (company), the W-9 or W-8 it certified (tax), its wallets (wallet), the agents that answer to it — spawned ones with the agent that spawned them — (agents), its screening against the OFAC, UN, EU and UK sanctions lists and the embargoed jurisdictions, run now, and what it still lacks to pay and be paid.
- [Get agents](https://docs.hanzo.ai/docs/openapi/principal/get-principal-agents-by-ref.md): Attests which principal one of the caller's agents answers to: the org, the chain of agents that spawned it, and the same signed with the platform's key as a JWS (EdDSA) a verifier checks offline against GET /v1/principal/keys.
- [List clearance](https://docs.hanzo.ai/docs/openapi/principal/get-principal-clearance.md): Lists the caller org's clearances, newest first, 200 at most; a payee narrows them.
- [Get clearance](https://docs.hanzo.ai/docs/openapi/principal/get-principal-clearance-by-id.md): Reads one of the caller org's clearances, as it was decided.
- [List keys](https://docs.hanzo.ai/docs/openapi/principal/get-principal-keys.md): Publishes the keys attestations are signed with, as a JSON Web Key Set (RFC 7517; Ed25519 keys as RFC 8037 writes them).
- [Get statements](https://docs.hanzo.ai/docs/openapi/principal/get-principal-statements-by-id.md): Reads whether one statement the platform signed about an agent still stands: live, expired, or revoked and when.
- [Create clearance](https://docs.hanzo.ai/docs/openapi/principal/post-principal-clearance.md): Decides whether the caller's org may pay another org, BEFORE the payment: what must happen first, what must be withheld and why, what must be reported, by whom and when, and how the payment may settle net of withholding.
- [Project](https://docs.hanzo.ai/docs/openapi/project.md): Where your sites live: create one, deploy a build, roll back to any release.
- [Delete project](https://docs.hanzo.ai/docs/openapi/project/delete-project-by-slug.md): Deletes a project and takes its site off the internet.
- [Delete domains — DELETE /v1/project/{slug}/domains/{host}](https://docs.hanzo.ai/docs/openapi/project/delete-project-by-slug-domains-by-host.md): Gives a custom hostname back, so the name is free to reuse.
- [Delete star — DELETE /v1/project/{slug}/star](https://docs.hanzo.ai/docs/openapi/project/delete-project-by-slug-star.md): Removes the caller's own bookmark from a project, and answers whether it is starred afterwards.
- [Delete projects](https://docs.hanzo.ai/docs/openapi/project/delete-projects-by-slug.md): Deletes a project and takes its site off the internet.
- [Delete domains — DELETE /v1/projects/{slug}/domains/{host}](https://docs.hanzo.ai/docs/openapi/project/delete-projects-by-slug-domains-by-host.md): Gives a custom hostname back, so the name is free to reuse.
- [Delete star — DELETE /v1/projects/{slug}/star](https://docs.hanzo.ai/docs/openapi/project/delete-projects-by-slug-star.md): Removes the caller's own bookmark from a project, and answers whether it is starred afterwards.
- [List project](https://docs.hanzo.ai/docs/openapi/project/get-project.md): Returns every project your org owns.
- [Get project](https://docs.hanzo.ai/docs/openapi/project/get-project-by-slug.md): Returns one project of yours by slug — its settings, its live URL and the deployment currently serving it.
- [List deployments — GET /v1/project/{slug}/deployments](https://docs.hanzo.ai/docs/openapi/project/get-project-by-slug-deployments.md): Returns a project's deploy history, newest version first.
- [Get deployments — GET /v1/project/{slug}/deployments/{id}](https://docs.hanzo.ai/docs/openapi/project/get-project-by-slug-deployments-by-id.md): Returns one deployment of a project by id.
- [List domains — GET /v1/project/{slug}/domains](https://docs.hanzo.ai/docs/openapi/project/get-project-by-slug-domains.md): Returns every custom hostname this site holds: the live ones, plus any pending claim with the DNS records it still owes.
- [List releases — GET /v1/project/{slug}/releases](https://docs.hanzo.ai/docs/openapi/project/get-project-by-slug-releases.md): Returns a site's releases newest-first, marking the active one — the rollback menu.
- [List shot — GET /v1/project/{slug}/shot](https://docs.hanzo.ai/docs/openapi/project/get-project-by-slug-shot.md): Returns a screenshot of what this project currently serves, as image/png.
- [List edge — GET /v1/project/edge](https://docs.hanzo.ai/docs/openapi/project/get-project-edge.md): health reports whether a publish reaches readers, rather than whether it was accepted.
- [List sites — GET /v1/project/sites](https://docs.hanzo.ai/docs/openapi/project/get-project-sites.md): Returns the org's deployed sites at the pretty URLs they serve at.
- [Get sites — GET /v1/project/sites/{slug}](https://docs.hanzo.ai/docs/openapi/project/get-project-sites-by-slug.md): Returns one site — the same row ListSites carries, for one slug.
- [List tags](https://docs.hanzo.ai/docs/openapi/project/get-project-tags.md): Returns the client-side pixels the SITE has connected (GA4, Google Ads, LinkedIn, Meta, Pinterest, Reddit, TikTok, X) with their NON-SECRET ids, so the hosted tag injects them first-party and stamps each browser event with the same event_id the server-side Conversions API uses — deduping the two.
- [List projects](https://docs.hanzo.ai/docs/openapi/project/get-projects.md): Returns every project your org owns.
- [Get projects](https://docs.hanzo.ai/docs/openapi/project/get-projects-by-slug.md): Returns one project of yours by slug — its settings, its live URL and the deployment currently serving it.
- [List deployments — GET /v1/projects/{slug}/deployments](https://docs.hanzo.ai/docs/openapi/project/get-projects-by-slug-deployments.md): Returns a project's deploy history, newest version first.
- [Get deployments — GET /v1/projects/{slug}/deployments/{id}](https://docs.hanzo.ai/docs/openapi/project/get-projects-by-slug-deployments-by-id.md): Returns one deployment of a project by id.
- [List domains — GET /v1/projects/{slug}/domains](https://docs.hanzo.ai/docs/openapi/project/get-projects-by-slug-domains.md): Returns every custom hostname this site holds: the live ones, plus any pending claim with the DNS records it still owes.
- [List releases — GET /v1/projects/{slug}/releases](https://docs.hanzo.ai/docs/openapi/project/get-projects-by-slug-releases.md): Returns a site's releases newest-first, marking the active one — the rollback menu.
- [List shot — GET /v1/projects/{slug}/shot](https://docs.hanzo.ai/docs/openapi/project/get-projects-by-slug-shot.md): Returns a screenshot of what this project currently serves, as image/png.
- [List edge — GET /v1/projects/edge](https://docs.hanzo.ai/docs/openapi/project/get-projects-edge.md): health reports whether a publish reaches readers, rather than whether it was accepted.
- [List sites — GET /v1/projects/sites](https://docs.hanzo.ai/docs/openapi/project/get-projects-sites.md): Returns the org's deployed sites at the pretty URLs they serve at.
- [Get sites — GET /v1/projects/sites/{slug}](https://docs.hanzo.ai/docs/openapi/project/get-projects-sites-by-slug.md): Returns one site — the same row ListSites carries, for one slug.
- [Update project](https://docs.hanzo.ai/docs/openapi/project/patch-project-by-slug.md): Changes a project's settings, and only the settings you send.
- [Update projects](https://docs.hanzo.ai/docs/openapi/project/patch-projects-by-slug.md): Changes a project's settings, and only the settings you send.
- [Create project](https://docs.hanzo.ai/docs/openapi/project/post-project.md): Creates a project — the handle a site is deployed and served under — and answers 201 with it in `draft`.
- [Deploy project](https://docs.hanzo.ai/docs/openapi/project/post-project-by-slug-deploy.md): Takes a built site live at `https://<slug>.hanzo.app` in one call.
- [Create deployments — POST /v1/project/{slug}/deployments](https://docs.hanzo.ai/docs/openapi/project/post-project-by-slug-deployments.md): Opens a deployment and hands back a short-lived, prefix-scoped grant to write its bytes straight to object storage.
- [Complete deployments — POST /v1/project/{slug}/deployments/{id}/complete](https://docs.hanzo.ai/docs/openapi/project/post-project-by-slug-deployments-by-id-complete.md): The CI completion hook that flips a queued git deployment to live (or error) once CI has synced the built site to S3.
- [Create domains — POST /v1/project/{slug}/domains](https://docs.hanzo.ai/docs/openapi/project/post-project-by-slug-domains.md): Attaches one or more CUSTOM public hostnames to this org's site.
- [Verify domains — POST /v1/project/{slug}/domains/{host}/verify](https://docs.hanzo.ai/docs/openapi/project/post-project-by-slug-domains-by-host-verify.md): Checks the DNS challenge for a pending custom hostname and, when it passes, promotes the host so it begins routing at the edge.
- [Publish project](https://docs.hanzo.ai/docs/openapi/project/post-project-by-slug-publish.md): Promotes a build output into a new release AND goes live with it — create+activate in one call, which is the 99% path.
- [Create purge — POST /v1/project/{slug}/purge](https://docs.hanzo.ai/docs/openapi/project/post-project-by-slug-purge.md): Flushes the site's edge cache without redeploying anything.
- [Create releases — POST /v1/project/{slug}/releases](https://docs.hanzo.ai/docs/openapi/project/post-project-by-slug-releases.md): Promotes a build output into a new immutable release WITHOUT serving it — the staged half of publishing, for when you want to check a release before it goes live.
- [Create activate — POST /v1/project/{slug}/releases/{release}/activate](https://docs.hanzo.ai/docs/openapi/project/post-project-by-slug-releases-by-release-activate.md): Points the site at an existing release — the go-live, and equally the ROLLBACK.
- [Create fork — POST /v1/project/fork](https://docs.hanzo.ai/docs/openapi/project/post-project-fork.md): Creates a project seeded from a PUBLISHED EXAMPLE — either a starter-kit template from the ONE embedded gallery catalog, or any live project on the platform (an example a seeded creator published, or another org's app serving at <slug>.hanzo.app).
- [Create sites — POST /v1/project/sites](https://docs.hanzo.ai/docs/openapi/project/post-project-sites.md): Generates a self-contained, mobile-responsive static site from a natural-language brief and deploys it live in one call.
- [Deploy sites — POST /v1/project/sites/deploy](https://docs.hanzo.ai/docs/openapi/project/post-project-sites-deploy.md): Deploys a caller-supplied file manifest — the deploy_site capability an agent calls — and answers with where it went live.
- [Create projects](https://docs.hanzo.ai/docs/openapi/project/post-projects.md): Creates a project — the handle a site is deployed and served under — and answers 201 with it in `draft`.
- [Deploy projects](https://docs.hanzo.ai/docs/openapi/project/post-projects-by-slug-deploy.md): Takes a built site live at `https://<slug>.hanzo.app` in one call.
- [Create deployments — POST /v1/projects/{slug}/deployments](https://docs.hanzo.ai/docs/openapi/project/post-projects-by-slug-deployments.md): Opens a deployment and hands back a short-lived, prefix-scoped grant to write its bytes straight to object storage.
- [Complete deployments — POST /v1/projects/{slug}/deployments/{id}/complete](https://docs.hanzo.ai/docs/openapi/project/post-projects-by-slug-deployments-by-id-complete.md): The CI completion hook that flips a queued git deployment to live (or error) once CI has synced the built site to S3.
- [Create domains — POST /v1/projects/{slug}/domains](https://docs.hanzo.ai/docs/openapi/project/post-projects-by-slug-domains.md): Attaches one or more CUSTOM public hostnames to this org's site.
- [Verify domains — POST /v1/projects/{slug}/domains/{host}/verify](https://docs.hanzo.ai/docs/openapi/project/post-projects-by-slug-domains-by-host-verify.md): Checks the DNS challenge for a pending custom hostname and, when it passes, promotes the host so it begins routing at the edge.
- [Publish projects](https://docs.hanzo.ai/docs/openapi/project/post-projects-by-slug-publish.md): Promotes a build output into a new release AND goes live with it — create+activate in one call, which is the 99% path.
- [Create purge — POST /v1/projects/{slug}/purge](https://docs.hanzo.ai/docs/openapi/project/post-projects-by-slug-purge.md): Flushes the site's edge cache without redeploying anything.
- [Create releases — POST /v1/projects/{slug}/releases](https://docs.hanzo.ai/docs/openapi/project/post-projects-by-slug-releases.md): Promotes a build output into a new immutable release WITHOUT serving it — the staged half of publishing, for when you want to check a release before it goes live.
- [Create activate — POST /v1/projects/{slug}/releases/{release}/activate](https://docs.hanzo.ai/docs/openapi/project/post-projects-by-slug-releases-by-release-activate.md): Points the site at an existing release — the go-live, and equally the ROLLBACK.
- [Create fork — POST /v1/projects/fork](https://docs.hanzo.ai/docs/openapi/project/post-projects-fork.md): Creates a project seeded from a PUBLISHED EXAMPLE — either a starter-kit template from the ONE embedded gallery catalog, or any live project on the platform (an example a seeded creator published, or another org's app serving at <slug>.hanzo.app).
- [Create sites — POST /v1/projects/sites](https://docs.hanzo.ai/docs/openapi/project/post-projects-sites.md): Generates a self-contained, mobile-responsive static site from a natural-language brief and deploys it live in one call.
- [Deploy sites — POST /v1/projects/sites/deploy](https://docs.hanzo.ai/docs/openapi/project/post-projects-sites-deploy.md): Deploys a caller-supplied file manifest — the deploy_site capability an agent calls — and answers with where it went live.
- [Replace star — PUT /v1/project/{slug}/star](https://docs.hanzo.ai/docs/openapi/project/put-project-by-slug-star.md): Bookmarks a project for the person calling, and answers whether it is starred afterwards.
- [Replace star — PUT /v1/projects/{slug}/star](https://docs.hanzo.ai/docs/openapi/project/put-projects-by-slug-star.md): Bookmarks a project for the person calling, and answers whether it is starred afterwards.
- [Prompt](https://docs.hanzo.ai/docs/openapi/prompt.md): Your prompt library, versioned, so nothing changes silently.
- [Delete prompt](https://docs.hanzo.ai/docs/openapi/prompt/delete-prompt-by-name.md): Removes one of the caller org's prompts and every version of it, answering 204.
- [List prompt](https://docs.hanzo.ai/docs/openapi/prompt/get-prompt.md): Returns the caller org's prompt library as one row per prompt: its name, type, every version number it has, its taxonomy and when it last changed.
- [Get prompt](https://docs.hanzo.ai/docs/openapi/prompt/get-prompt-by-name.md): Returns one of the caller org's prompts: its CURRENT template text plus the metadata of every version it has had.
- [List catalog](https://docs.hanzo.ai/docs/openapi/prompt/get-prompt-catalog.md): Returns the read-only starter prompt library shipped with the binary — reference content every tenant sees the same, NOT the caller's own prompts and never mixed into them.
- [List metrics](https://docs.hanzo.ai/docs/openapi/prompt/get-prompt-metrics.md): Returns real per-prompt statistics for the caller's org: how many versions each prompt has, which one is current, and when it was created and last changed.
- [Create prompt](https://docs.hanzo.ai/docs/openapi/prompt/post-prompt.md): Records a prompt for the caller's org and answers 201 with it.
- [Provider](https://docs.hanzo.ai/docs/openapi/provider.md): How your org connects third-party accounts like Slack, and revokes them.
- [Delete connection](https://docs.hanzo.ai/docs/openapi/provider/delete-connection-by-id.md): Forgets a connector: every custodied secret, then the row.
- [Delete pages](https://docs.hanzo.ai/docs/openapi/provider/delete-provider-github-repos-by-repo-pages.md): Deletes the repo's Pages site.
- [Delete messages](https://docs.hanzo.ai/docs/openapi/provider/delete-provider-slack-messages.md): Takes back one of this app's messages: DELETE /v1/provider/slack/messages.
- [List connection](https://docs.hanzo.ai/docs/openapi/provider/get-connection.md): Lists the caller's OWN connectors across every provider — the set `hanzo connector ls` prints.
- [List token](https://docs.hanzo.ai/docs/openapi/provider/get-connection-by-id-token.md): Hands the custodied access token to its owner — the ONE place custody exits.
- [List providers](https://docs.hanzo.ai/docs/openapi/provider/get-connection-providers.md): Lists the USER-plane provider cards.
- [List provider](https://docs.hanzo.ai/docs/openapi/provider/get-provider.md): Returns every registered integration provider together with THIS org's connection status for it — the catalog the console's Integrations page renders.
- [Get provider](https://docs.hanzo.ai/docs/openapi/provider/get-provider-by-provider.md): Returns ONE provider with this org's connection status — the same view list carries, for a single id.
- [List callback — GET /v1/provider/{provider}/callback](https://docs.hanzo.ai/docs/openapi/provider/get-provider-by-provider-callback.md): The single address every connector's OAuth flow returns to.
- [List logo](https://docs.hanzo.ai/docs/openapi/provider/get-provider-by-provider-logo.md): Serves a connector's logo from the catalog.
- [List link — GET /v1/provider/discord/link](https://docs.hanzo.ai/docs/openapi/provider/get-provider-discord-link.md): The entry point behind the connect prompt Hanzo shows in a Discord server.
- [List callback — GET /v1/provider/discord/link/callback](https://docs.hanzo.ai/docs/openapi/provider/get-provider-discord-link-callback.md): The final leg: it binds the verified Discord user to the Hanzo account that just signed in, and answers a short confirmation page telling them to return to Discord.
- [List discord](https://docs.hanzo.ai/docs/openapi/provider/get-provider-discord-link-discord.md): Where Discord returns the user after the identify consent.
- [List installations](https://docs.hanzo.ai/docs/openapi/provider/get-provider-github-installations.md): Lists the GitHub accounts the caller may see the App installed on, each confirmed against the App's own list, plus where to add another.
- [List repos](https://docs.hanzo.ai/docs/openapi/provider/get-provider-github-repos.md): Lists the GitHub repositories the caller may work on, most recently pushed first, searched and paged on the server.
- [List branches](https://docs.hanzo.ai/docs/openapi/provider/get-provider-github-repos-by-owner-by-repo-branches.md): Lists a repository's branches, the default first, with prefix search.
- [List pages](https://docs.hanzo.ai/docs/openapi/provider/get-provider-github-repos-by-repo-pages.md): Returns the repo's Pages status, live URL, custom domain and build source.
- [List user](https://docs.hanzo.ai/docs/openapi/provider/get-provider-github-user.md): Reports whether the caller has connected their own GitHub account in the org they act in, and as whom.
- [List callback — GET /v1/provider/github/user/callback](https://docs.hanzo.ai/docs/openapi/provider/get-provider-github-user-callback.md): Where GitHub returns the person.
- [List projects](https://docs.hanzo.ai/docs/openapi/provider/get-provider-gitlab-projects.md): Lists the projects the org's GitLab connection can reach — membership projects, most recently active first.
- [List channels](https://docs.hanzo.ai/docs/openapi/provider/get-provider-slack-channels.md): Lists Slack conversations for the caller's connected workspace.
- [List file](https://docs.hanzo.ai/docs/openapi/provider/get-provider-slack-file.md): Streams the bytes of a file attached to a message in the workspace this organization connected.
- [List install](https://docs.hanzo.ai/docs/openapi/provider/get-provider-slack-install.md): The address behind Slack's "Add to Slack" and Marketplace Install buttons.
- [List link — GET /v1/provider/slack/link](https://docs.hanzo.ai/docs/openapi/provider/get-provider-slack-link.md): The entry point behind the connect prompt Hanzo posts in Slack.
- [List callback — GET /v1/provider/slack/link/callback](https://docs.hanzo.ai/docs/openapi/provider/get-provider-slack-link-callback.md): The final leg: the user has proved both who they are in Slack and who they are in Hanzo, and this binds the two.
- [List slack](https://docs.hanzo.ai/docs/openapi/provider/get-provider-slack-link-slack.md): Where Slack returns the user after they sign in.
- [List messages](https://docs.hanzo.ai/docs/openapi/provider/get-provider-slack-messages.md): Reads recent messages from a named Slack channel such as #hanzo-gtm.
- [List link — GET /v1/provider/teams/link](https://docs.hanzo.ai/docs/openapi/provider/get-provider-teams-link.md): The entry point behind the connect prompt Hanzo shows in Teams.
- [List aad](https://docs.hanzo.ai/docs/openapi/provider/get-provider-teams-link-aad.md): Where Microsoft returns the user after sign-in.
- [List callback — GET /v1/provider/teams/link/callback](https://docs.hanzo.ai/docs/openapi/provider/get-provider-teams-link-callback.md): The final leg: it binds the verified directory identity to the Hanzo account that just signed in, and answers a short confirmation page telling them to return to Teams.
- [List link — GET /v1/provider/telegram/link](https://docs.hanzo.ai/docs/openapi/provider/get-provider-telegram-link.md): The entry point behind the connect prompt Hanzo sends in Telegram.
- [List auth](https://docs.hanzo.ai/docs/openapi/provider/get-provider-telegram-link-auth.md): Where Telegram's Login Widget sends the user with its signed authentication data.
- [List callback — GET /v1/provider/telegram/link/callback](https://docs.hanzo.ai/docs/openapi/provider/get-provider-telegram-link-callback.md): The final leg: it binds the verified Telegram user to the Hanzo account that just signed in, and answers a short confirmation page telling them to return to Telegram.
- [List webhook](https://docs.hanzo.ai/docs/openapi/provider/get-provider-whatsapp-webhook.md): Meta calls this once when the webhook is subscribed, carrying the verify token this deployment was configured with and a challenge to echo.
- [Refresh connection](https://docs.hanzo.ai/docs/openapi/provider/post-connection-by-id-refresh.md): Forces a token rotation for a connected connector, ahead of the automatic rotation a token read would do inside the expiry window.
- [Create credential](https://docs.hanzo.ai/docs/openapi/provider/post-connection-by-provider-credential.md): The direct intake path: a customer-held token/setup-token (Verify) or an externally obtained OAuth bundle from the CLI's local PKCE (Adopt).
- [Create device](https://docs.hanzo.ai/docs/openapi/provider/post-connection-by-provider-device.md): Begins a device sign-in and returns the code to show the user plus how to poll for completion.
- [Create poll](https://docs.hanzo.ai/docs/openapi/provider/post-connection-by-provider-device-by-flow-poll.md): Advances a device sign-in.
- [Connect provider](https://docs.hanzo.ai/docs/openapi/provider/post-provider-by-provider-connect.md): Acquires the org's credential for one provider.
- [Disconnect provider](https://docs.hanzo.ai/docs/openapi/provider/post-provider-by-provider-disconnect.md): Revokes (best-effort) and forgets an org's connection: it deletes every custodied KMS secret and the connection row.
- [Run provider](https://docs.hanzo.ai/docs/openapi/provider/post-provider-by-provider-run.md): Runs one action of a connector as the caller's org, with the credential the org connected, and answers what the action returned.
- [Verify provider](https://docs.hanzo.ai/docs/openapi/provider/post-provider-by-provider-verify.md): Re-checks a CONNECTED apikey connector's stored credential against the provider, live (`hanzo connector verify`).
- [Create interactions](https://docs.hanzo.ai/docs/openapi/provider/post-provider-discord-interactions.md): The Interactions Endpoint URL for the Discord app.
- [Create webhook — POST /v1/provider/forge/webhook](https://docs.hanzo.ai/docs/openapi/provider/post-provider-forge-webhook.md): Receives the forge's workflow_job delivery.
- [Create fork](https://docs.hanzo.ai/docs/openapi/provider/post-provider-github-fork.md): Forks a granted repository.
- [Create backfill — POST /v1/provider/github/issues/backfill](https://docs.hanzo.ai/docs/openapi/provider/post-provider-github-issues-backfill.md): Seeds the native todo with the EXISTING issues across the org's granted repos (default state=open); the webhook keeps them live thereafter.
- [Create pages](https://docs.hanzo.ai/docs/openapi/provider/post-provider-github-repos-by-repo-pages.md): Creates the repo's Pages site and answers 201 Created with it.
- [Create builds](https://docs.hanzo.ai/docs/openapi/provider/post-provider-github-repos-by-repo-pages-builds.md): Requests a Pages rebuild and returns the queued build's status.
- [Import repos](https://docs.hanzo.ai/docs/openapi/provider/post-provider-github-repos-import.md): Imports the selected (or all) granted repos into git.hanzo.ai.
- [Search github](https://docs.hanzo.ai/docs/openapi/provider/post-provider-github-search.md): Finds repositories on GitHub.
- [Complete user](https://docs.hanzo.ai/docs/openapi/provider/post-provider-github-user-complete.md): Finishes connecting the caller's GitHub account: it takes the authorization the callback parked, trades it for the person's token, and seals it.
- [Connect user](https://docs.hanzo.ai/docs/openapi/provider/post-provider-github-user-connect.md): Begins connecting the caller's own GitHub account: it answers the App's authorization page, carrying a state signed for this org and this person.
- [Disconnect user](https://docs.hanzo.ai/docs/openapi/provider/post-provider-github-user-disconnect.md): Forgets the caller's GitHub connection in this org: the token is revoked at GitHub, and the sealed secrets and the row go.
- [Create webhook — POST /v1/provider/github/webhook](https://docs.hanzo.ai/docs/openapi/provider/post-provider-github-webhook.md): The address the GitHub App delivers events to.
- [Claim linear](https://docs.hanzo.ai/docs/openapi/provider/post-provider-linear-claim.md): Binds the caller's Linear organization to the org and seals the webhook secret.
- [Create comments](https://docs.hanzo.ai/docs/openapi/provider/post-provider-linear-comments.md): Posts a comment on a Linear issue with the caller's own key, so it carries their name.
- [Create backfill — POST /v1/provider/linear/issues/backfill](https://docs.hanzo.ai/docs/openapi/provider/post-provider-linear-issues-backfill.md): Seeds the native todo with the EXISTING Linear issues the caller's key can see (default state=open); the webhook keeps them live thereafter.
- [Create webhook — POST /v1/provider/linear/webhook](https://docs.hanzo.ai/docs/openapi/provider/post-provider-linear-webhook.md): The address Linear delivers Issue and Comment events to.
- [Create webhook — POST /v1/provider/openrouter/webhook](https://docs.hanzo.ai/docs/openapi/provider/post-provider-openrouter-webhook.md): OpenRouter's spend is invisible to every Hanzo money lens because those lenses read hanzo.cloud_usage and OpenRouter meters keys of its own.
- [Create commands](https://docs.hanzo.ai/docs/openapi/provider/post-provider-slack-commands.md): The address Slack posts a slash command to, form-encoded.
- [Create events — POST /v1/provider/slack/events](https://docs.hanzo.ai/docs/openapi/provider/post-provider-slack-events.md): The address a Slack app posts workspace events to.
- [Create join](https://docs.hanzo.ai/docs/openapi/provider/post-provider-slack-join.md): Joins every public channel in the caller org's workspace.
- [Create messages](https://docs.hanzo.ai/docs/openapi/provider/post-provider-slack-messages.md): Posts as Hanzo to the caller's connected Slack workspace.
- [Create reactions](https://docs.hanzo.ai/docs/openapi/provider/post-provider-slack-reactions.md): Adds an emoji reaction: POST /v1/provider/slack/reactions.
- [Search slack](https://docs.hanzo.ai/docs/openapi/provider/post-provider-slack-search.md): Answers a workspace question: POST /v1/provider/slack/search.
- [Create events — POST /v1/provider/teams/events](https://docs.hanzo.ai/docs/openapi/provider/post-provider-teams-events.md): The messaging endpoint for the Teams bot.
- [Connect telegram](https://docs.hanzo.ai/docs/openapi/provider/post-provider-telegram-connect.md): Mints a short, single-use deep-link code bound to the caller's org and returns the t.me link the console navigates to.
- [Create webhook — POST /v1/provider/telegram/webhook](https://docs.hanzo.ai/docs/openapi/provider/post-provider-telegram-webhook.md): The update webhook for the Telegram bot.
- [Create webhook — POST /v1/provider/whatsapp/webhook](https://docs.hanzo.ai/docs/openapi/provider/post-provider-whatsapp-webhook.md): One delivery from Meta.
- [Replace pages](https://docs.hanzo.ai/docs/openapi/provider/put-provider-github-repos-by-repo-pages.md): Sets or clears the custom domain (cname) and updates HTTPS enforcement, build type, or source.
- [Replace messages](https://docs.hanzo.ai/docs/openapi/provider/put-provider-slack-messages.md): Rewrites one of this app's messages: PUT /v1/provider/slack/messages.
- [Provisioning](https://docs.hanzo.ai/docs/openapi/provisioning.md): One-click data add-ons: a SQL, key-value, document, vector, search or object store, wired straight into your app.
- [Delete datastore](https://docs.hanzo.ai/docs/openapi/provisioning/delete-provisioning-datastore-by-name.md): Deprovisions one Hanzo Datastore warehouse.
- [Delete docdb](https://docs.hanzo.ai/docs/openapi/provisioning/delete-provisioning-docdb-by-name.md): Deprovisions one Hanzo DocDB database.
- [Delete kv](https://docs.hanzo.ai/docs/openapi/provisioning/delete-provisioning-kv-by-name.md): Deprovisions one Hanzo KV store.
- [Delete s3](https://docs.hanzo.ai/docs/openapi/provisioning/delete-provisioning-s3-by-name.md): Deletes one bucket from the shared object store and removes its metadata row.
- [Delete search](https://docs.hanzo.ai/docs/openapi/provisioning/delete-provisioning-search-by-name.md): Deletes one search index from the shared backend and removes its metadata row.
- [Delete sql](https://docs.hanzo.ai/docs/openapi/provisioning/delete-provisioning-sql-by-name.md): Deprovisions one Hanzo SQL database.
- [Delete vector](https://docs.hanzo.ai/docs/openapi/provisioning/delete-provisioning-vector-by-name.md): Deletes one vector collection from the shared backend and removes its metadata row.
- [List datastore](https://docs.hanzo.ai/docs/openapi/provisioning/get-provisioning-datastore.md): Lists the caller org's Hanzo Datastore warehouses.
- [Get datastore](https://docs.hanzo.ai/docs/openapi/provisioning/get-provisioning-datastore-by-name.md): Returns one Hanzo Datastore warehouse's metadata.
- [List docdb](https://docs.hanzo.ai/docs/openapi/provisioning/get-provisioning-docdb.md): Lists the caller org's Hanzo DocDB document databases.
- [Get docdb](https://docs.hanzo.ai/docs/openapi/provisioning/get-provisioning-docdb-by-name.md): Returns one Hanzo DocDB database's metadata.
- [List kv](https://docs.hanzo.ai/docs/openapi/provisioning/get-provisioning-kv.md): Lists the caller org's Hanzo KV stores.
- [Get kv](https://docs.hanzo.ai/docs/openapi/provisioning/get-provisioning-kv-by-name.md): Returns one Hanzo KV store's metadata.
- [List s3](https://docs.hanzo.ai/docs/openapi/provisioning/get-provisioning-s3.md): Lists the caller org's object-storage buckets.
- [Get s3](https://docs.hanzo.ai/docs/openapi/provisioning/get-provisioning-s3-by-name.md): Returns one bucket's metadata.
- [Search provisioning — GET /v1/provisioning/search](https://docs.hanzo.ai/docs/openapi/provisioning/get-provisioning-search.md): Lists the caller org's search indexes.
- [Get search](https://docs.hanzo.ai/docs/openapi/provisioning/get-provisioning-search-by-name.md): Returns one search index's metadata.
- [List sql](https://docs.hanzo.ai/docs/openapi/provisioning/get-provisioning-sql.md): Lists the caller org's Hanzo SQL databases.
- [Get sql](https://docs.hanzo.ai/docs/openapi/provisioning/get-provisioning-sql-by-name.md): Returns one Hanzo SQL database's metadata.
- [List vector](https://docs.hanzo.ai/docs/openapi/provisioning/get-provisioning-vector.md): Lists the caller org's vector collections.
- [Get vector](https://docs.hanzo.ai/docs/openapi/provisioning/get-provisioning-vector-by-name.md): Returns one vector collection's metadata.
- [Create datastore](https://docs.hanzo.ai/docs/openapi/provisioning/post-provisioning-datastore.md): Launches your org's OWN Hanzo Datastore instance and answers with its `datastore://` connection string.
- [Create docdb](https://docs.hanzo.ai/docs/openapi/provisioning/post-provisioning-docdb.md): Launches your org's OWN document-database instance and answers with its `mongodb://` connection string.
- [Create kv](https://docs.hanzo.ai/docs/openapi/provisioning/post-provisioning-kv.md): Launches your org's OWN key-value instance and answers with its `kv://` connection string.
- [Create s3](https://docs.hanzo.ai/docs/openapi/provisioning/post-provisioning-s3.md): Creates an S3-compatible bucket inside the already-running shared object store and answers with the endpoint that reaches it.
- [Search provisioning — POST /v1/provisioning/search](https://docs.hanzo.ai/docs/openapi/provisioning/post-provisioning-search.md): Creates a search index inside the already-running shared search backend and answers with the endpoint that reaches it.
- [Create sql](https://docs.hanzo.ai/docs/openapi/provisioning/post-provisioning-sql.md): Launches your org's OWN PostgreSQL instance and answers with its `postgres://` connection string.
- [Create vector](https://docs.hanzo.ai/docs/openapi/provisioning/post-provisioning-vector.md): Creates a vector collection inside the already-running shared vector backend and answers with the endpoint that reaches it.
- [Pubsub](https://docs.hanzo.ai/docs/openapi/pubsub.md): Your message bus: publish, subscribe, and durable streams your apps read at their own pace.
- [Publish pubsub](https://docs.hanzo.ai/docs/openapi/pubsub/post-pubsub-publish.md): Puts one message on the org's bus.
- [Create request](https://docs.hanzo.ai/docs/openapi/pubsub/post-pubsub-request.md): Sends one request on the org's bus and waits for one reply — the synchronous half of pub/sub, for callers speaking to a responder subscribed on the NATS port.
- [Reference](https://docs.hanzo.ai/docs/openapi/reference.md): The lookup data a risk decision needs but cannot derive: which email domains hand out throwaway inboxes, which addresses belong to a datacentre or a Tor exit, which card scheme an issuer prefix belongs to, which browsers the fleet sees everywhere, and how current the designation lists the screening engine holds actually are.
- [Delete reference](https://docs.hanzo.ai/docs/openapi/reference/riskclearreference.md): Removes one of your organisation's overrides.
- [Get reference](https://docs.hanzo.ai/docs/openapi/reference/riskreference.md): Describes one set and lists your org's overrides in it.
- [List reference](https://docs.hanzo.ai/docs/openapi/reference/riskreferencesets.md): Lists every set this plane publishes, with its version and how fresh it is.
- [Resolve reference](https://docs.hanzo.ai/docs/openapi/reference/riskresolvereference.md): Looks keys up against the reference plane.
- [Replace reference](https://docs.hanzo.ai/docs/openapi/reference/risksetreference.md): Writes your organisation's own allow and deny entries over a set.
- [Referral](https://docs.hanzo.ai/docs/openapi/referral.md): Referral ATTRIBUTION: who referred whom, and whether that referee ever became a real customer.
- [List referral](https://docs.hanzo.ai/docs/openapi/referral/get-referral.md): Returns the caller's referral code, share link and the referrals they have made.
- [Claim referral](https://docs.hanzo.ai/docs/openapi/referral/post-referral-claim.md): Records that the caller's org signed up through a referral code.
- [Registry](https://docs.hanzo.ai/docs/openapi/registry.md): Your container and package registry: push images, pull them back, see what you store.
- [List images](https://docs.hanzo.ai/docs/openapi/registry/get-registry-images.md): Lists the org's container repositories, read live from the OCI catalog and filtered server-side to the org's namespace — the page can only ever hold the caller's own images.
- [List packages](https://docs.hanzo.ai/docs/openapi/registry/get-registry-packages.md): Lists the org's npm packages — `<org>` and `@<org>/…` — from the npm registry's search index, optionally narrowed by a query within that scope.
- [List projects](https://docs.hanzo.ai/docs/openapi/registry/get-registry-projects.md): Lists the namespaces the caller can see with what each holds: the org's slug, its repository count on the OCI catalog, and its package count on the npm registry.
- [List status](https://docs.hanzo.ai/docs/openapi/registry/get-registry-status.md): Reports whether the OCI and npm registries are reachable and, when the OCI half is auth-gated, which token realm its challenge advertises — an honest lens for "is the registry plane up", never a fabricated ok.
- [List tags](https://docs.hanzo.ai/docs/openapi/registry/get-registry-tags.md): Lists one org-owned repository's tags, read live from the OCI registry.
- [Create token](https://docs.hanzo.ai/docs/openapi/registry/post-registry-token.md): Mints a short-lived, pull-only registry token for exactly one of the org's images, through the same IAM realm the docker CLI authenticates against.
- [Risk](https://docs.hanzo.ai/docs/openapi/risk.md): HANZO RISK's model plane: the per-organisation feature surface and the per-organisation models trained on it.
- [List health](https://docs.hanzo.ai/docs/openapi/risk/get-risk-health.md): Reports whether the per-organisation model plane is genuinely usable: that the plane was built, that the per-organisation stores can be written, and whether the event surface the feature plane is rolled up from is reachable.
- [Replace model](https://docs.hanzo.ai/docs/openapi/risk/riskadoptmodel.md): Puts one of your organisation's OWN PUBLISHED VALUES in force, by name — which is what an instant rollback is, what promoting a challenger is, and what installing the shape a search found is.
- [List features](https://docs.hanzo.ai/docs/openapi/risk/riskfeatures.md): The feature catalogue in its two honest lenses.
- [Create learn](https://docs.hanzo.ai/docs/openapi/risk/risklearn.md): Records a batch of events into the caller organisation's own aggregates and lets its model learn from them.
- [List policy](https://docs.hanzo.ai/docs/openapi/risk/riskpolicy.md): Reports the caller organisation's own decision-regime history: every distinct regime it has adopted, which version is in force, and what retention has taken.
- [Create model](https://docs.hanzo.ai/docs/openapi/risk/riskpublishmodel.md): Publishes your organisation's model as a NAMED VALUE, so a decision taken today can be reconstructed tomorrow and a change made today can be undone.
- [Create score](https://docs.hanzo.ai/docs/openapi/risk/riskscore.md): Judges one event against the caller organisation's OWN model and learns nothing from it.
- [Search risk](https://docs.hanzo.ai/docs/openapi/risk/risksearch.md): Runs an exhaustive search for the model shape that best fits the caller organisation's own history, and answers 202 with the run to read back.
- [Get search](https://docs.hanzo.ai/docs/openapi/risk/risksearchresult.md): Reads back one search run: every shape tried over this organisation's own history, best first, and the one that fit.
- [Replace policy](https://docs.hanzo.ai/docs/openapi/risk/risksetpolicy.md): States the decision regime the caller organisation's model decides under: how much of its own stream may be sent for examination, how much of the rest is sampled to measure what was missed, and whether the model may change an outcome at all.
- [List state](https://docs.hanzo.ai/docs/openapi/risk/riskstate.md): Reports the caller organisation's own model: what it has learned, whether it is live or still in shadow, the threshold in force, the appetite it stated beside the share it actually realised, every refusal by reason, every feature that read blind, and how much of the organisation's own event surface has been folded in.
- [S3](https://docs.hanzo.ai/docs/openapi/s3.md): Object storage: your buckets and the files in them, with signed URLs for upload and download.
- [Delete buckets](https://docs.hanzo.ai/docs/openapi/s3/delete-s3-buckets-by-bucket.md): Removes an EMPTY bucket and answers 204.
- [Delete uploads](https://docs.hanzo.ai/docs/openapi/s3/delete-s3-buckets-by-bucket-uploads-by-upload.md): Aborts a multipart upload and deletes the parts it stored.
- [List buckets](https://docs.hanzo.ai/docs/openapi/s3/get-s3-buckets.md): Lists the caller org's own buckets.
- [List objects](https://docs.hanzo.ai/docs/openapi/s3/get-s3-buckets-by-bucket-objects.md): Lists one folder level of a bucket.
- [Get uploads](https://docs.hanzo.ai/docs/openapi/s3/get-s3-buckets-by-bucket-uploads-by-upload.md): Answers the parts a multipart upload already holds, in order: what a client resuming after a dropped connection reads to send only the rest.
- [List health](https://docs.hanzo.ai/docs/openapi/s3/get-s3-health.md): Reports whether this deployment can serve object storage.
- [Create buckets](https://docs.hanzo.ai/docs/openapi/s3/post-s3-buckets.md): Makes a new bucket for the caller's org and answers 201 with it.
- [Create objects](https://docs.hanzo.ai/docs/openapi/s3/post-s3-buckets-by-bucket-objects.md): Mints a presigned PUT URL the caller uploads to DIRECTLY.
- [Create uploads](https://docs.hanzo.ai/docs/openapi/s3/post-s3-buckets-by-bucket-uploads.md): Begins a multipart upload of a large file into one of the caller's org buckets.
- [Complete uploads](https://docs.hanzo.ai/docs/openapi/s3/post-s3-buckets-by-bucket-uploads-by-upload-complete.md): Assembles a multipart upload into its object from every part the store holds, in order.
- [Create parts](https://docs.hanzo.ai/docs/openapi/s3/post-s3-buckets-by-bucket-uploads-by-upload-parts.md): Answers presigned PUT URLs for some parts of a multipart upload, at most 64 a call, each valid for minutes: mint them as the upload reaches them.
- [Sandbox](https://docs.hanzo.ai/docs/openapi/sandbox.md): The ONE compute primitive: a sandbox is a gVisor pod that runs somebody else's code, and every lifetime is the same object.
- [Delete sandbox](https://docs.hanzo.ai/docs/openapi/sandbox/delete-sandbox-by-id.md): Ends a sandbox and releases the compute behind it.
- [Create end](https://docs.hanzo.ai/docs/openapi/sandbox/end-sandbox.md): Ends the caller's sandbox lease: the pod goes, and the volume goes only when the caller asked for that too.
- [List sandbox](https://docs.hanzo.ai/docs/openapi/sandbox/get-sandbox.md): Lists the sandboxes the caller holds, newest first.
- [Get sandbox](https://docs.hanzo.ai/docs/openapi/sandbox/get-sandbox-by-id.md): Returns one sandbox: its class, project, image, the runtime it was given, its status and when its lease ends.
- [List fs](https://docs.hanzo.ai/docs/openapi/sandbox/get-sandbox-by-id-fs.md): Reads one file from the sandbox's project directory as text, or lists the entries when the path names a directory.
- [List ports](https://docs.hanzo.ai/docs/openapi/sandbox/get-sandbox-by-id-ports.md): Lists the TCP ports something listens on in a sandbox the caller holds, each with the preview host that serves it — what the sandbox's Browser can open.
- [List screen](https://docs.hanzo.ai/docs/openapi/sandbox/get-sandbox-by-id-screen.md): A complete, self-contained desktop — noVNC inline, no other origin — that opens its own socket and draws this sandbox's display.
- [List ws — GET /v1/sandbox/{id}/screen/ws](https://docs.hanzo.ai/docs/openapi/sandbox/get-sandbox-by-id-screen-ws.md): Upgrades to a WebSocket carrying RFB — the VNC wire protocol — from the sandbox's display, for a host that brings its own client.
- [List terminal](https://docs.hanzo.ai/docs/openapi/sandbox/get-sandbox-by-id-terminal.md): A complete, self-contained terminal — xterm inline, no other origin — that opens its own socket and runs a shell in this sandbox.
- [List ws — GET /v1/sandbox/{id}/terminal/ws](https://docs.hanzo.ai/docs/openapi/sandbox/get-sandbox-by-id-terminal-ws.md): Upgrades to a WebSocket carrying a login shell on a pseudo-terminal inside the sandbox — for a host that brings its own emulator.
- [Create lease](https://docs.hanzo.ai/docs/openapi/sandbox/lease-sandbox.md): Leases the caller's sandbox, or returns the one it named if that lease is still running, or gives it a pod again if it is parked — with its disk as it was left.
- [Create sandbox](https://docs.hanzo.ai/docs/openapi/sandbox/post-sandbox.md): Leases a sandbox — a real computer — for the caller's org.
- [Create exec](https://docs.hanzo.ai/docs/openapi/sandbox/post-sandbox-by-id-exec.md): Runs one command in a sandbox the caller holds and answers with its exit code, stdout and stderr.
- [Create fs](https://docs.hanzo.ai/docs/openapi/sandbox/post-sandbox-by-id-fs.md): Writes the request body to one file in the sandbox's project directory, creating parent directories.
- [Create pause](https://docs.hanzo.ai/docs/openapi/sandbox/post-sandbox-by-id-pause.md): Stops the pod, keeps the row and the volume, and settles the tail: POST /v1/sandbox/:id/pause.
- [Preview sandbox](https://docs.hanzo.ai/docs/openapi/sandbox/post-sandbox-by-id-preview.md): Opens a port of a sandbox the caller holds in a browser.
- [Resume sandbox](https://docs.hanzo.ai/docs/openapi/sandbox/post-sandbox-by-id-resume.md): Gives a parked sandbox a pod again: POST /v1/sandbox/:id/resume.
- [Create ticket — POST /v1/sandbox/{id}/screen/ticket](https://docs.hanzo.ai/docs/openapi/sandbox/post-sandbox-by-id-screen-ticket.md): Mints a short-lived grant to open the screen of a desktop sandbox.
- [Create ticket — POST /v1/sandbox/{id}/terminal/ticket](https://docs.hanzo.ai/docs/openapi/sandbox/post-sandbox-by-id-terminal-ticket.md): Mints a short-lived grant to open a terminal on a sandbox.
- [Create read](https://docs.hanzo.ai/docs/openapi/sandbox/read-sandbox-file.md): Reads one path in the caller's sandbox: a file's bytes, or a directory's entries when the path names one.
- [Run sandbox](https://docs.hanzo.ai/docs/openapi/sandbox/run-in-sandbox.md): Runs one command inside the caller's sandbox and answers its exit code, stdout and stderr.
- [Stop sandbox](https://docs.hanzo.ai/docs/openapi/sandbox/stop-run.md): Interrupts whatever the caller's sandbox is running and answers how many commands it ended.
- [Create write](https://docs.hanzo.ai/docs/openapi/sandbox/write-sandbox-file.md): Writes bytes to one path in the caller's sandbox, creating parents, and answers the resolved path.
- [SBOM](https://docs.hanzo.ai/docs/openapi/sbom.md): What is inside a container image: every component, resolvable by digest or image ref.
- [List health](https://docs.hanzo.ai/docs/openapi/sbom/get-sbom-health.md): A pure liveness probe: the service is up; datastore reflects whether the datastore store is connected.
- [Search](https://docs.hanzo.ai/docs/openapi/search.md): One ranked result set over everything your org has stored.
- [Create search](https://docs.hanzo.ai/docs/openapi/search/search.md): The typed op behind POST /v1/search.
- [Security](https://docs.hanzo.ai/docs/openapi/security.md): Secret scanning for your code: submit sources, get findings, masked never raw.
- [List findings](https://docs.hanzo.ai/docs/openapi/security/get-security-findings.md): The org's findings — rule, severity, path, line, masked preview and fingerprint — newest first, across scans or within one.
- [Get findings](https://docs.hanzo.ai/docs/openapi/security/get-security-findings-by-id.md): Returns a single finding: which rule fired, where (path and line), the masked preview and the SHA-256 fingerprint of the secret — the raw secret is not stored and cannot be read back.
- [List health](https://docs.hanzo.ai/docs/openapi/security/get-security-health.md): Reports that the scanning subsystem is serving and how many secret-detection rules the engine holds.
- [List rules](https://docs.hanzo.ai/docs/openapi/security/get-security-rules.md): The secret-detection catalog the engine scans with.
- [List scans](https://docs.hanzo.ai/docs/openapi/security/get-security-scans.md): The org's scan history, newest first, each as the same summary the submission answered — files read, findings fired, tally by severity.
- [Get scans](https://docs.hanzo.ai/docs/openapi/security/get-security-scans-by-id.md): Returns one scan together with every finding on it, so the detail view is one round-trip rather than a list call per scan.
- [Create scans](https://docs.hanzo.ai/docs/openapi/security/post-security-scans.md): Runs the detection engine over a batch of files and answers 201 with the scan summary: how many files were read, how many findings fired, and the tally by severity.
- [SEO](https://docs.hanzo.ai/docs/openapi/seo.md): Search visibility as data: what a phrase is worth, what a site already places for, who places beside it, who links to it, and what one page gets wrong.
- [Create audit](https://docs.hanzo.ai/docs/openapi/seo/seoaudit.md): Fetches one page and reports what it gets wrong.
- [Create backlinks](https://docs.hanzo.ai/docs/openapi/seo/seobacklink.md): Summarises who links to a target.
- [Create competitors](https://docs.hanzo.ai/docs/openapi/seo/seocompetitor.md): Names the domains that place for the same phrases.
- [Create ideas](https://docs.hanzo.ai/docs/openapi/seo/seoidea.md): Grows a seed phrase into the phrases nobody named yet.
- [Create keywords](https://docs.hanzo.ai/docs/openapi/seo/seokeyword.md): Measures phrases the caller already has.
- [Create rankings](https://docs.hanzo.ai/docs/openapi/seo/seorank.md): Reports every phrase a domain already places for.
- [List rates](https://docs.hanzo.ai/docs/openapi/seo/seorate.md): Publishes what every call on this surface costs.
- [Settings](https://docs.hanzo.ai/docs/openapi/settings.md): How an org configures each product it uses, secret fields included.
- [Get settings](https://docs.hanzo.ai/docs/openapi/settings/get-settings-by-product.md): Reads the caller org's configuration for one product, with every secret field MASKED — only the names of the set secrets come back, never their values, which live in KMS.
- [Replace settings](https://docs.hanzo.ai/docs/openapi/settings/put-settings-by-product.md): Writes the caller org's configuration for one product and answers the stored result, secrets masked.
- [Share](https://docs.hanzo.ai/docs/openapi/share.md): A public URL for a service on your own machine, and a list of what you have open.
- [List share](https://docs.hanzo.ai/docs/openapi/share/get-share.md): Returns the tunnel shares the caller's org currently has open, across every environment that org has enabled.
- [Enable share](https://docs.hanzo.ai/docs/openapi/share/post-share-enable.md): Provisions the caller org's tunnel account and returns the credential the `hanzo share` CLI needs to run a tunnel.
- [Skills](https://docs.hanzo.ai/docs/openapi/skills.md): Skills — reached at /.well-known/agent-skills/; not in the public REST contract.
- [Social](https://docs.hanzo.ai/docs/openapi/social.md): Posting to every social account you own, now or on a schedule.
- [Delete accounts](https://docs.hanzo.ai/docs/openapi/social/delete-social-accounts-by-id.md): Removes one connected account from the org and answers 204 with no body; an id that is not there is 404.
- [Delete posts](https://docs.hanzo.ai/docs/openapi/social/delete-social-posts-by-id.md): Removes one post from the org and answers 204 with no body; an id that is not there is 404.
- [List accounts](https://docs.hanzo.ai/docs/openapi/social/get-social-accounts.md): Returns the org's connected accounts — each one's id, network, handle, status and timestamps, most-recently-updated first.
- [Get accounts](https://docs.hanzo.ai/docs/openapi/social/get-social-accounts-by-id.md): Returns one of the org's connected accounts by id — its network, handle, status and timestamps — or 404.
- [List posts](https://docs.hanzo.ai/docs/openapi/social/get-social-posts.md): Returns the org's posts — content, channel, status, scheduled time, media and timestamps — most-recently-updated first.
- [Get posts](https://docs.hanzo.ai/docs/openapi/social/get-social-posts-by-id.md): Returns one of the org's posts by id, with its current status, scheduled time, media and — once it has published — the account and external id it published under.
- [List providers](https://docs.hanzo.ai/docs/openapi/social/get-social-providers.md): Reports each supported network's publish-readiness: whether this deployment holds the OAuth application credentials for it and, when it does not, exactly which environment variables are missing.
- [List summary](https://docs.hanzo.ai/docs/openapi/social/get-social-summary.md): Returns four counts for the caller's org: total posts, how many are scheduled, how many have published, and how many accounts are connected.
- [Create accounts](https://docs.hanzo.ai/docs/openapi/social/post-social-accounts.md): Records a social account for the org and answers 201 with the stored row, including the generated id later calls address it by.
- [Create posts](https://docs.hanzo.ai/docs/openapi/social/post-social-posts.md): Stores a post for the org and answers 201 with the stored row.
- [Publish posts](https://docs.hanzo.ai/docs/openapi/social/post-social-posts-by-id-publish.md): Publishes the post immediately to the connected accounts on its channel and answers with the updated row, carrying the account and external id it published under.
- [Replace accounts](https://docs.hanzo.ai/docs/openapi/social/put-social-accounts-by-id.md): Replaces the account's network, handle and status with what the body carries, and answers with the stored row.
- [Replace posts](https://docs.hanzo.ai/docs/openapi/social/put-social-posts-by-id.md): Replaces the post's content, channel, status, scheduled time and media with what the body carries, and answers with the stored row.
- [Space](https://docs.hanzo.ai/docs/openapi/space.md): Where work lives: drives, folders and the files in them.
- [Delete drives](https://docs.hanzo.ai/docs/openapi/space/delete-space-by-space-drives-by-drive.md): Removes an EMPTY drive and answers 204.
- [List drives](https://docs.hanzo.ai/docs/openapi/space/get-space-by-space-drives.md): Lists a space's drives.
- [List files](https://docs.hanzo.ai/docs/openapi/space/get-space-by-space-drives-by-drive-files.md): Lists one folder level of a drive.
- [List health](https://docs.hanzo.ai/docs/openapi/space/get-space-health.md): Reports whether this deployment can serve spaces, drives and files.
- [List spaces](https://docs.hanzo.ai/docs/openapi/space/get-space-spaces.md): Lists the caller org's own spaces.
- [Create drives](https://docs.hanzo.ai/docs/openapi/space/post-space-by-space-drives.md): Makes a new drive in a space and answers 201 with it.
- [Create spaces](https://docs.hanzo.ai/docs/openapi/space/post-space-spaces.md): Makes a new space for the caller's org and answers 201 with it.
- [Standing](https://docs.hanzo.ai/docs/openapi/standing.md): Prices and tracks what it costs to KEEP a company, as distinct from what it cost to form one.
- [Create upkeep](https://docs.hanzo.ai/docs/openapi/standing/post-standing-upkeep.md): Reports what keeping this entity costs every year, itemised.
- [Sync](https://docs.hanzo.ai/docs/openapi/sync.md): Data sync: link two endpoints and keep them in step, on a webhook, on a schedule, or on demand.
- [Delete sync](https://docs.hanzo.ai/docs/openapi/sync/delete-sync-by-id.md): Removes one sync and tears down the outbound mirror it derived, answering 204.
- [List sync](https://docs.hanzo.ai/docs/openapi/sync/get-sync.md): Returns every sync link the caller's org has, each with its two endpoints, its direction and trigger policy, the time it last reconciled, and for a repo link its native copy on the forge — the address to clone it from, its default branch and whether it is in step.
- [Get sync](https://docs.hanzo.ai/docs/openapi/sync/get-sync-by-id.md): Returns one sync by id.
- [Update sync](https://docs.hanzo.ai/docs/openapi/sync/patch-sync-by-id.md): Updates one sync's mutable policy — direction, trigger and actor — in place.
- [Create sync](https://docs.hanzo.ai/docs/openapi/sync/post-sync.md): Declares a sync between two endpoints and returns it.
- [Run sync](https://docs.hanzo.ai/docs/openapi/sync/post-sync-by-id-run.md): Reconciles one sync now — the manual re-sync, and the initial import for a link created without run=true.
- [Task](https://docs.hanzo.ai/docs/openapi/task.md): Hanzo Task: boards, the work items on them, and the filters that make a board.
- [Delete projects](https://docs.hanzo.ai/docs/openapi/task/delete-task-projects-by-key.md): Answers 405.
- [List board](https://docs.hanzo.ai/docs/openapi/task/get-task-board.md): Returns a board's issues — work items with their column, priority, assignee, labels and schedule.
- [List issues — GET /v1/task/issues](https://docs.hanzo.ai/docs/openapi/task/get-task-issues.md): Answers across every project in the org.
- [List projects](https://docs.hanzo.ai/docs/openapi/task/get-task-projects.md): Returns the boards of your org — the places your work actually is.
- [Get projects](https://docs.hanzo.ai/docs/openapi/task/get-task-projects-by-key.md): Returns one board of your org by its key — the repository name.
- [List issues — GET /v1/task/projects/{key}/issues](https://docs.hanzo.ai/docs/openapi/task/get-task-projects-by-key-issues.md): Returns a board's issues — work items with their column, priority, assignee, labels and schedule.
- [Get issues](https://docs.hanzo.ai/docs/openapi/task/get-task-projects-by-key-issues-by-num.md): Returns ONE work item in full — its description included.
- [List comments](https://docs.hanzo.ai/docs/openapi/task/get-task-projects-by-key-issues-by-num-comments.md): One issue's conversation, oldest first, read as the caller.
- [Get rooms](https://docs.hanzo.ai/docs/openapi/task/get-task-rooms-by-room.md): Summarises one room's work.
- [Update projects](https://docs.hanzo.ai/docs/openapi/task/patch-task-projects-by-key.md): Answers 405.
- [Update issues](https://docs.hanzo.ai/docs/openapi/task/patch-task-projects-by-key-issues-by-num.md): Edits a work item — rename it, rewrite it, move it to another column, re-prioritise it, hand it to somebody, or comment on it.
- [Create projects](https://docs.hanzo.ai/docs/openapi/task/post-task-projects.md): Answers 405.
- [Create issues](https://docs.hanzo.ai/docs/openapi/task/post-task-projects-by-key-issues.md): Opens a work item on the board, filed as YOU, where the repository lives: an issue on the deployment's forge, or on GitHub for a repository the forge mirrors from there or does not hold at all.
- [Claim issues](https://docs.hanzo.ai/docs/openapi/task/post-task-projects-by-key-issues-by-num-claim.md): Takes an issue: it becomes yours and it moves to in_progress.
- [Tax](https://docs.hanzo.ai/docs/openapi/tax.md): How companies formed on Hanzo exchange W-9s, W-8s and 1099s with each other, from the payments that moved between them on Hanzo's rails.
- [List filings](https://docs.hanzo.ai/docs/openapi/tax/get-tax-filings.md): Lists the caller org's IRS return exports and where each stands, without their files.
- [Get filings](https://docs.hanzo.ai/docs/openapi/tax/get-tax-filings-by-id.md): Reads one IRS return export WITH its files, rebuilt from the sealed forms and proven identical to what was exported.
- [List forms](https://docs.hanzo.ai/docs/openapi/tax/get-tax-forms.md): Lists the 1099s the caller org prepared as payer, oldest first, voided and superseded ones included — a return that was furnished stays on the record.
- [Get forms](https://docs.hanzo.ai/docs/openapi/tax/get-tax-forms-by-id.md): Reads one 1099 the caller org prepared as payer, every box and both parties, TINs masked.
- [List pdf — GET /v1/tax/forms/{id}/pdf](https://docs.hanzo.ai/docs/openapi/tax/get-tax-forms-by-id-pdf.md): Answers one 1099 the caller org prepared as payer as a one-page PDF — `application/pdf` under a Content-Disposition naming the form — rendered from the form's own content: the payer's copy by default, or Copy B (For Recipient) with `?copy=B` for a statement owed on paper.
- [List inbox](https://docs.hanzo.ai/docs/openapi/tax/get-tax-inbox.md): Lists the Copy B statements furnished to the caller org — every 1099 a payer on Hanzo delivered to it electronically, corrected ones beside the ones they supersede.
- [Get inbox](https://docs.hanzo.ai/docs/openapi/tax/get-tax-inbox-by-id.md): Reads one Copy B furnished to the caller org.
- [List pdf — GET /v1/tax/inbox/{id}/pdf](https://docs.hanzo.ai/docs/openapi/tax/get-tax-inbox-by-id-pdf.md): Answers one Copy B furnished to the caller org as a one-page PDF — `application/pdf` under a Content-Disposition naming the form — rendered from the statement exactly as it was furnished, which can never change.
- [List payments](https://docs.hanzo.ai/docs/openapi/tax/get-tax-payments.md): Returns the caller org's tax year as a PAYER: every payment it made to another org in that calendar year, on any rail, as the event plane records it, each classified — reportable or not, in which 1099 box, and the rule that decided it, with its source — and each payee's totals tested against the year's threshold.
- [List profile](https://docs.hanzo.ai/docs/openapi/tax/get-tax-profile.md): Returns the caller org's own tax profile — every line of its Form W-9, W-8BEN or W-8BEN-E, every number masked to its last four characters, where the certification stands, whether a W-8 is valid and when it expires, and whether the org consents to receive its 1099s electronically.
- [List w9](https://docs.hanzo.ai/docs/openapi/tax/get-tax-w9.md): Lists the caller org's W-9 relationships on both sides: the W-9s it asked its payees for, with where each stands, and the requests other orgs made for its own W-9.
- [Get w9](https://docs.hanzo.ai/docs/openapi/tax/get-tax-w9-by-id.md): Reads one W-9 relationship from the caller's side.
- [List tin](https://docs.hanzo.ai/docs/openapi/tax/get-tax-w9-by-id-tin.md): Reads a payee's TIN in full — and, for a payee on a W-8, its foreign TIN, which the payer's Form 1042-S carries.
- [Create filings](https://docs.hanzo.ai/docs/openapi/tax/post-tax-filings.md): Exports the caller org's return for a tax year and form, as the files the IRIS Taxpayer Portal takes, and records the export.
- [Create receipt](https://docs.hanzo.ai/docs/openapi/tax/post-tax-filings-by-id-receipt.md): Records what IRIS answered for an exported return — the Receipt ID on submission, then the acknowledgment.
- [Create forms](https://docs.hanzo.ai/docs/openapi/tax/post-tax-forms.md): Prepares the caller org's 1099 drafts for a tax year, as the PAYER: one 1099-NEC and/or 1099-MISC per payee whose reportable payments on Hanzo's rails reach the year's threshold, from the same derivation GET /v1/tax/payments answers.
- [Create correct](https://docs.hanzo.ai/docs/openapi/tax/post-tax-forms-by-id-correct.md): Corrects a furnished (or owed) 1099 with a NEW form that supersedes it.
- [Create furnish](https://docs.hanzo.ai/docs/openapi/tax/post-tax-forms-by-id-furnish.md): Furnishes Copy B of a reviewed 1099 to its payee.
- [Create mailed](https://docs.hanzo.ai/docs/openapi/tax/post-tax-forms-by-id-mailed.md): Records that the payer mailed a paper Copy B it owed.
- [Create review](https://docs.hanzo.ai/docs/openapi/tax/post-tax-forms-by-id-review.md): Marks a draft 1099 reviewed — a person has checked it.
- [Create void](https://docs.hanzo.ai/docs/openapi/tax/post-tax-forms-by-id-void.md): Voids a draft or reviewed 1099, which is then never furnished or filed.
- [Create certify](https://docs.hanzo.ai/docs/openapi/tax/post-tax-profile-certify.md): Signs the caller org's certification — Form W-9 Part II, Form W-8BEN Part III or Form W-8BEN-E Part XXX — through /v1/legal's e-signature.
- [Create w9](https://docs.hanzo.ai/docs/openapi/tax/post-tax-w9.md): Asks another org for its W-9, as the org that pays it.
- [Create decline](https://docs.hanzo.ai/docs/openapi/tax/post-tax-w9-by-id-decline.md): Declines a request for this org's W-9.
- [Create grant](https://docs.hanzo.ai/docs/openapi/tax/post-tax-w9-by-id-grant.md): Grants the payer that asked a live read of this org's W-9 — every line, the TIN masked, and the full TIN to that payer's org admins alone, each read audited.
- [Create match](https://docs.hanzo.ai/docs/openapi/tax/post-tax-w9-by-id-match.md): Records the result of IRS TIN Matching for a payee, as the payer.
- [Revoke w9](https://docs.hanzo.ai/docs/openapi/tax/post-tax-w9-by-id-revoke.md): Revokes a W-9 this org granted.
- [Replace profile](https://docs.hanzo.ai/docs/openapi/tax/put-tax-profile.md): Writes the caller org's tax profile — its Form W-9, or its Form W-8BEN or W-8BEN-E when it is a foreign person — and answers it, every number masked.
- [Taxonomy](https://docs.hanzo.ai/docs/openapi/taxonomy.md): The product catalogue's shape: which categories exist, what each product is called, which category it sits in, what it is tagged with, and the order the two are shown in.
- [Delete categories](https://docs.hanzo.ai/docs/openapi/taxonomy/delete-taxonomy-categories-by-id.md): Removes one empty category.
- [Delete taxa](https://docs.hanzo.ai/docs/openapi/taxonomy/delete-taxonomy-taxa-by-id.md): Removes one product from the catalogue.
- [List taxonomy](https://docs.hanzo.ai/docs/openapi/taxonomy/get-taxonomy.md): Returns the product catalogue as this caller sees it: the PLATFORM catalogue — Hanzo's own products, the part that is true for everyone — plus the caller's own org's rows, every category in display order and each carrying the products filed under it in theirs.
- [Replace categories](https://docs.hanzo.ai/docs/openapi/taxonomy/put-taxonomy-categories-by-id.md): Creates or replaces one category and returns it as stored.
- [Replace taxa](https://docs.hanzo.ai/docs/openapi/taxonomy/put-taxonomy-taxa-by-id.md): Creates or replaces one product and returns it as stored.
- [Team](https://docs.hanzo.ai/docs/openapi/team.md): Your org's shared space: documents edited together, files, seats, and agents as teammates.
- [Delete cookie](https://docs.hanzo.ai/docs/openapi/team/delete-team-account-cookie.md): Signs this browser out of team by expiring the HttpOnly account-token cookie the OAuth callback set.
- [Delete docs](https://docs.hanzo.ai/docs/openapi/team/delete-team-docs-by-id.md): Removes a document with everything nested under it and every comment on any of them — the Team client's own delete, which takes the subtree with it.
- [Delete files](https://docs.hanzo.ai/docs/openapi/team/delete-team-files-by-space-by-filename.md): Removes one blob from a space's file store.
- [Delete messages](https://docs.hanzo.ai/docs/openapi/team/delete-team-messages-by-id.md): Removes a message, with its replies, reactions, files and the inbox notifications that point at it.
- [Delete reactions](https://docs.hanzo.ai/docs/openapi/team/delete-team-messages-by-id-reactions-by-emoji.md): Takes back the caller's reaction to a message and answers the message with its reactions as they now stand.
- [Delete members](https://docs.hanzo.ai/docs/openapi/team/delete-team-rooms-by-id-members-by-account.md): Takes one person out of a room — the caller leaving, when the account is their own.
- [Get auth](https://docs.hanzo.ai/docs/openapi/team/get-team-account-auth-by-provider.md): STARTS the OAuth hop: answers 302 to hanzo.id's authorize endpoint and sets the short-lived HttpOnly state cookie that binds the flow to this browser.
- [List callback](https://docs.hanzo.ai/docs/openapi/team/get-team-account-auth-by-provider-callback.md): COMPLETES the OAuth hop: hanzo.id redirects the browser here with ?code and ?state, and the answer is another 302 — back to the client's login route carrying the freshly minted team session token in the query.
- [List providers](https://docs.hanzo.ai/docs/openapi/team/get-team-account-providers.md): Returns the identity providers this deployment starts a login with.
- [List plan](https://docs.hanzo.ai/docs/openapi/team/get-team-billing-plan.md): Returns the plan and seat counts for the caller's OWN org, resolved from the VERIFIED team session token — never a client header.
- [List ui](https://docs.hanzo.ai/docs/openapi/team/get-team-billing-ui.md): Serves the usage-and-wallet page the Team front links to — HTML, not JSON.
- [List collaborator](https://docs.hanzo.ai/docs/openapi/team/get-team-collaborator.md): Upgrades to the hocuspocus WebSocket the Team editor syncs its Y.js documents over: binary frames of document name, message type and payload, with ONE socket multiplexing every document a tab has open.
- [List docs](https://docs.hanzo.ai/docs/openapi/team/get-team-docs.md): Returns the documents of a space the caller may see, with the teamspaces they are grouped in.
- [Get docs](https://docs.hanzo.ai/docs/openapi/team/get-team-docs-by-id.md): Returns one document the caller may see.
- [List comments](https://docs.hanzo.ai/docs/openapi/team/get-team-docs-by-id-comments.md): Returns the comments on a document, oldest first — the same message shape a room's conversation answers.
- [List events](https://docs.hanzo.ai/docs/openapi/team/get-team-events.md): Holds one text/event-stream open per caller and pushes each change as it is written — by the Team client, a typed op or an agent — filtered to the rooms, documents and inbox the caller may see under the same rule the ops apply.
- [Get files](https://docs.hanzo.ai/docs/openapi/team/get-team-files-by-space-by-filename.md): Streams one blob's raw BYTES back — this is the read side of the space file store, not a JSON envelope around it.
- [List inbox](https://docs.hanzo.ai/docs/openapi/team/get-team-inbox.md): Returns the caller's notifications, newest first, each with the room or document it is about and the message that caused it.
- [List members — GET /v1/team/members](https://docs.hanzo.ai/docs/openapi/team/get-team-members.md): Returns the people and agents in a space, with the name, avatar, role and presence a client draws them with.
- [List replies](https://docs.hanzo.ai/docs/openapi/team/get-team-messages-by-id-replies.md): Returns a message's thread, oldest first, each reply with its reactions and files.
- [List public](https://docs.hanzo.ai/docs/openapi/team/get-team-public.md): Lists the rooms orgs have published, across every org.
- [List rooms](https://docs.hanzo.ai/docs/openapi/team/get-team-rooms.md): Returns the rooms the caller may see, with the kind and work facet each carries.
- [List members — GET /v1/team/rooms/{id}/members](https://docs.hanzo.ai/docs/openapi/team/get-team-rooms-by-id-members.md): Returns the people and agents in one room, as the roster describes them.
- [List messages](https://docs.hanzo.ai/docs/openapi/team/get-team-rooms-by-id-messages.md): Returns the tail of one room's conversation, oldest first, each message with its reactions, files and thread count.
- [Get transactor](https://docs.hanzo.ai/docs/openapi/team/get-team-transactor-by-token.md): Upgrades to the WebSocket the Team client runs an entire space over: every frame is a ZAP envelope wrapping one JSON-RPC message — findAll/findOne reads against the space's documents, tx writes that broadcast to the other live sessions, hello negotiating JSON rather than msgpack.
- [List statistics](https://docs.hanzo.ai/docs/openapi/team/get-team-transactor-statistics.md): Returns the transactor's live sessions for the space the caller's credential names — the endpoint the front's space switcher and server panel poll on the transactor base.
- [Update docs](https://docs.hanzo.ai/docs/openapi/team/patch-team-docs-by-id.md): Renames a document or moves it — under another document, to the top of its teamspace, or to another teamspace with everything nested under it.
- [Update messages](https://docs.hanzo.ai/docs/openapi/team/patch-team-messages-by-id.md): Rewrites what a message says.
- [Update rooms](https://docs.hanzo.ai/docs/openapi/team/patch-team-rooms-by-id.md): Renames a channel, sets its topic, or archives or reopens it, and answers the room as it now stands.
- [Create account](https://docs.hanzo.ai/docs/openapi/team/post-team-account.md): The account control plane the Team client speaks: one POST carries a `method` verb and its `params`, and answers {"result": …}.
- [Create rpc](https://docs.hanzo.ai/docs/openapi/team/post-team-collaborator-rpc-by-documentid.md): The collaborative-markup snapshot plane the Team front's editor speaks: createContent stores a document field's markup at a fresh, immutable blob ref and returns it, updateContent stores a new snapshot and answers nothing, and getContent reads back the exact snapshot a ref names.
- [Create dms](https://docs.hanzo.ai/docs/openapi/team/post-team-dms.md): Opens the direct message between the caller and the people named, or answers the one that already exists — there is one conversation per set of people, however many times it is asked for.
- [Create docs](https://docs.hanzo.ai/docs/openapi/team/post-team-docs.md): Creates a document, as the caller, after its siblings.
- [Create comments](https://docs.hanzo.ai/docs/openapi/team/post-team-docs-by-id-comments.md): Comments on a document, as the caller.
- [Create files](https://docs.hanzo.ai/docs/openapi/team/post-team-files-by-space.md): Stores one file in a space's blob store and answers the blob id it is addressable by, as plain text — the front discards that body, it is there for a caller driving this by hand.
- [Create archive](https://docs.hanzo.ai/docs/openapi/team/post-team-inbox-by-id-archive.md): Archives one of the caller's notifications — read, and out of the live inbox — and answers it.
- [Create read — POST /v1/team/inbox/{id}/read](https://docs.hanzo.ai/docs/openapi/team/post-team-inbox-by-id-read.md): Marks one of the caller's notifications read and answers it.
- [Create read — POST /v1/team/inbox/read](https://docs.hanzo.ai/docs/openapi/team/post-team-inbox-read.md): Marks every live notification of the caller's read, and says how many it changed.
- [Create replies](https://docs.hanzo.ai/docs/openapi/team/post-team-messages-by-id-replies.md): Answers a message in its thread, as the caller.
- [Create rooms](https://docs.hanzo.ai/docs/openapi/team/post-team-rooms.md): Opens a named room and answers it as the store now holds it.
- [Create members](https://docs.hanzo.ai/docs/openapi/team/post-team-rooms-by-id-members.md): Adds people to a room and answers the room as it now stands.
- [Create messages](https://docs.hanzo.ai/docs/openapi/team/post-team-rooms-by-id-messages.md): Says one thing in a room, as the caller.
- [Replace cookie](https://docs.hanzo.ai/docs/openapi/team/put-team-account-cookie.md): Writes the team session token into the HttpOnly `account-token` cookie — Secure, SameSite=Lax, whole-origin scope, thirty days — and answers {"result": true}.
- [Replace reactions](https://docs.hanzo.ai/docs/openapi/team/put-team-messages-by-id-reactions-by-emoji.md): Adds the caller's reaction to a message and answers the message with its reactions as they now stand.
- [Replace rooms](https://docs.hanzo.ai/docs/openapi/team/put-team-rooms-by-id.md): States what a room is for: its lifecycle intent, and what it is about.
- [Tel](https://docs.hanzo.ai/docs/openapi/tel.md): The telecommunications surface: phone numbers, calls and messages, on whatever carrier the deployment is configured for.
- [Delete calls](https://docs.hanzo.ai/docs/openapi/tel/delete-tel-calls-by-id.md): Ends a call this org placed.
- [Delete numbers](https://docs.hanzo.ai/docs/openapi/tel/delete-tel-numbers-by-id.md): Checks the holding is THIS org's before it reaches the carrier.
- [List calls](https://docs.hanzo.ai/docs/openapi/tel/get-tel-calls.md): Lists the calls this org has placed or received, newest first.
- [List messages](https://docs.hanzo.ai/docs/openapi/tel/get-tel-messages.md): Lists the messages this org has sent or received, newest first.
- [List numbers](https://docs.hanzo.ai/docs/openapi/tel/get-tel-numbers.md): Lists the phone numbers this org HOLDS — the ones it has bought and not released.
- [List available](https://docs.hanzo.ai/docs/openapi/tel/get-tel-numbers-available.md): Asks the carrier what is available to buy.
- [List summary](https://docs.hanzo.ai/docs/openapi/tel/get-tel-summary.md): Counts what this org holds on the telephony plane: its numbers, its calls and its messages.
- [Create calls](https://docs.hanzo.ai/docs/openapi/tel/post-tel-calls.md): Dials.
- [Create messages](https://docs.hanzo.ai/docs/openapi/tel/post-tel-messages.md): Sends a message from one of this org's own numbers.
- [Create numbers](https://docs.hanzo.ai/docs/openapi/tel/post-tel-numbers.md): Provisions with the carrier FIRST and records second.
- [Template](https://docs.hanzo.ai/docs/openapi/template.md): A gallery of starter kits you can deploy as they come.
- [Delete template](https://docs.hanzo.ai/docs/openapi/template/delete-template-by-slug.md): Deletes the caller org's OWN starter kit.
- [List template](https://docs.hanzo.ai/docs/openapi/template/get-template.md): Lists the public starter-kit catalog plus, for a validated caller, that org's own private kits.
- [Get template](https://docs.hanzo.ai/docs/openapi/template/get-template-by-slug.md): Returns one starter kit: the caller org's own by that slug, else the public catalog's.
- [Create template](https://docs.hanzo.ai/docs/openapi/template/post-template.md): Creates a starter kit PRIVATE to the caller's org and answers 201 with the stored kit.
- [Replace template](https://docs.hanzo.ai/docs/openapi/template/put-template-by-slug.md): Overwrites the caller org's OWN starter kit at the path slug, answering the stored kit.
- [Tool](https://docs.hanzo.ai/docs/openapi/tool.md): Everything your org can call, in one list: connector actions, functions, agents, skills and your own MCP servers.
- [Delete servers](https://docs.hanzo.ai/docs/openapi/tool/delete-tool-mcp-servers-by-id.md): Deregisters one of the caller org's external MCP servers, so its tools leave the registry.
- [Delete authored](https://docs.hanzo.ai/docs/openapi/tool/delete-tool-plugins-authored-by-id.md): Removes one of the caller org's built plugins, so the runtime can no longer load it.
- [Delete skills](https://docs.hanzo.ai/docs/openapi/tool/delete-tool-skills-by-id.md): Removes one of the caller org's authored skills.
- [List tool](https://docs.hanzo.ai/docs/openapi/tool/get-tool.md): Lists every tool the caller's org and project can reach, from every source, each flagged with whether it is activated.
- [List activation](https://docs.hanzo.ai/docs/openapi/tool/get-tool-activation.md): Reports which tools are switched on for the caller's org and project.
- [List catalog](https://docs.hanzo.ai/docs/openapi/tool/get-tool-catalog.md): Lists the MCP servers the public registries publish, as we hold them: our canonical copy of registry.modelcontextprotocol.io, plus what we decided about each entry.
- [Get catalog](https://docs.hanzo.ai/docs/openapi/tool/get-tool-catalog-by-id.md): Returns one catalog entry in full: the publisher's description, its repository and site, every package form with the runtime that launches it, and every hosted endpoint.
- [List kit](https://docs.hanzo.ai/docs/openapi/tool/get-tool-kit.md): Answers the caller's kit: what their coding runs carry of the org's tool plane.
- [List servers](https://docs.hanzo.ai/docs/openapi/tool/get-tool-mcp-servers.md): Lists the external MCP servers the caller's org has registered.
- [List plugins](https://docs.hanzo.ai/docs/openapi/tool/get-tool-plugins.md): Reports what this deployment actually mounted: every subsystem the composition root declared and whether it is switched on.
- [List authored — GET /v1/tool/plugins/authored](https://docs.hanzo.ai/docs/openapi/tool/get-tool-plugins-authored.md): Lists the plugins the caller's org BUILT, newest first, each with the TypeScript as authored.
- [List skills](https://docs.hanzo.ai/docs/openapi/tool/get-tool-skills.md): Lists the skills the caller's org can reach — the brand's embedded catalogue plus the org's own authored ones — with each one's activation flag.
- [List authored — GET /v1/tool/skills/authored](https://docs.hanzo.ai/docs/openapi/tool/get-tool-skills-authored.md): Lists the caller org's OWN skills with their SKILL.md bodies.
- [Create call](https://docs.hanzo.ai/docs/openapi/tool/post-tool-call.md): Runs one of the caller's activated tools and answers with its output.
- [Create servers](https://docs.hanzo.ai/docs/openapi/tool/post-tool-mcp-servers.md): Gives the caller's org one more external MCP server, so its tools join the org's tool plane and the fleet's MCP server.
- [Create build](https://docs.hanzo.ai/docs/openapi/tool/post-tool-plugins-build.md): Builds and stores one plugin for the caller's org.
- [Create skills](https://docs.hanzo.ai/docs/openapi/tool/post-tool-skills.md): Adds or revises one of the caller org's own skills, and answers 201 with the stored record.
- [Replace activation](https://docs.hanzo.ai/docs/openapi/tool/put-tool-activation.md): Switches tools on and off for the caller's org and project, and answers with the resulting activated set.
- [Replace kit](https://docs.hanzo.ai/docs/openapi/tool/put-tool-kit.md): Mutes and unmutes names of the org's kit for the caller's own runs, and answers the caller's kit after.
- [Train](https://docs.hanzo.ai/docs/openapi/train.md): The cloud's one training endpoint, /v1/train (HIP-1333): clients the caller drives on the engine, and jobs the org's linked machines or Hanzo's executor run, whose adaptation, protection, objective and output are fields and whose artifacts, bases and evaluations are what they produce.
- [Delete artifacts](https://docs.hanzo.ai/docs/openapi/train/delete-train-artifacts-by-sha256.md): Deletes one of the org's objects — an upload or a job's output — from the store: every artifact naming it then reads deleted, and its storage is no longer billed.
- [Delete clients](https://docs.hanzo.ai/docs/openapi/train/delete-train-clients-by-id.md): Drops one of the org's clients and frees its memory on the engine.
- [List artifacts — GET /v1/train/artifacts](https://docs.hanzo.ai/docs/openapi/train/get-train-artifacts.md): Answers the org's objects — its uploads and its jobs' outputs, one per sha256 — with what produced each, whether it is published and when retention deletes it.
- [Get artifacts](https://docs.hanzo.ai/docs/openapi/train/get-train-artifacts-by-sha256.md): Answers one of the org's objects, as the list does, with an address that fetches its bytes for ten minutes once it is stored: how an executor reads an `artifact:<sha256>` dataset its job names, and how the org downloads what it uploaded.
- [List clients](https://docs.hanzo.ai/docs/openapi/train/get-train-clients.md): Answers the org's live clients as the engine reports them.
- [Get clients](https://docs.hanzo.ai/docs/openapi/train/get-train-clients-by-id.md): Answers one of the org's clients with its loss history.
- [List jobs](https://docs.hanzo.ai/docs/openapi/train/get-train-jobs.md): Answers the org's jobs, newest first, narrowed by ?status=.
- [Get jobs](https://docs.hanzo.ai/docs/openapi/train/get-train-jobs-by-id.md): Answers one job: what it asked for, its status and tasks, its artifacts, its result and verdict, and whether it was published.
- [List artifacts — GET /v1/train/jobs/{id}/artifacts](https://docs.hanzo.ai/docs/openapi/train/get-train-jobs-by-id-artifacts.md): Answers a job's artifacts — checkpoint, capability, lora, basis or merged, each named by the SHA-256 of its bytes — with a download address that lives ten minutes for each one stored.
- [List events](https://docs.hanzo.ai/docs/openapi/train/get-train-jobs-by-id-events.md): Answers a job's events after a cursor — status changes, the coordinator's address, metrics, log lines, artifacts and the result — waiting up to `wait` seconds for the first new one, so a caller following a run holds one request at a time.
- [List metrics](https://docs.hanzo.ai/docs/openapi/train/get-train-jobs-by-id-metrics.md): Answers a job's metric series — loss, throughput and each validation suite's numbers as the executor reported them — one per name, each point [step, value, unix seconds].
- [List models](https://docs.hanzo.ai/docs/openapi/train/get-train-models.md): Answers each base the caller can train today, in one shape: the base, the methods it trains by (adaptations), where it runs (runs: Hanzo's devices or the org's machines) with what one device-second costs there in nano-USD, then the resources that run it (nouns), its executor and devices, and the protections, objective terms, outputs and dataset schemes it takes.
- [Create artifacts — POST /v1/train/artifacts](https://docs.hanzo.ai/docs/openapi/train/post-train-artifacts.md): Records rows the org is about to upload, named by the SHA-256 of their bytes, and answers the same grant an executor's artifact gets: a presigned PUT S3 accepts only with that checksum and length, encrypted under the org's key — a PUT per 64 MiB part over 64 MiB — or stored: true when the org already holds those bytes.
- [Create clients](https://docs.hanzo.ai/docs/openapi/train/post-train-clients.md): Loads base_model on the engine with a LoRA adapter and answers the client, loading; poll it until ready.
- [Create forward backward](https://docs.hanzo.ai/docs/openapi/train/post-train-clients-by-id-forward-backward.md): Accumulates the gradients of a batch on the client.
- [Create optim step](https://docs.hanzo.ai/docs/openapi/train/post-train-clients-by-id-optim-step.md): Applies the optimizer to the accumulated gradients.
- [Create sample](https://docs.hanzo.ai/docs/openapi/train/post-train-clients-by-id-sample.md): Decodes from the client's current weights.
- [Create save weights](https://docs.hanzo.ai/docs/openapi/train/post-train-clients-by-id-save-weights.md): Writes the client's adapter on the engine.
- [Create jobs](https://docs.hanzo.ai/docs/openapi/train/post-train-jobs.md): Creates a job that teaches base_model one capability: the data, the objective, how the trained parameters are represented (adaptation), what they must not damage and by how much (protect), where it runs and how far (resources), the suites it is judged on (evaluation) and what it produces (output).
- [Create artifacts — POST /v1/train/jobs/{id}/artifacts](https://docs.hanzo.ai/docs/openapi/train/post-train-jobs-by-id-artifacts.md): Records an output its executor is about to store, named by the SHA-256 of its bytes, and answers a presigned PUT for exactly that object under the org's prefix — S3 accepts it only with the checksum and encrypts it under the org's key — or, over 64 MiB, a presigned PUT per 64 MiB part, or stored: true when the org already holds those bytes.
- [Cancel jobs](https://docs.hanzo.ai/docs/openapi/train/post-train-jobs-by-id-cancel.md): Stops a job that has not ended.
- [Create events](https://docs.hanzo.ai/docs/openapi/train/post-train-jobs-by-id-events.md): An executor's report for the task it holds: status changes, the lead's coordinator address, metrics, log lines, stored artifacts and, last, the lead's result.
- [Publish jobs](https://docs.hanzo.ai/docs/openapi/train/post-train-jobs-by-id-publish.md): Publishes a job's output under a name.
- [Claim jobs](https://docs.hanzo.ai/docs/openapi/train/post-train-jobs-claim.md): An executor's long poll for work: it names the machine it runs on, its devices and what its build runs, and is answered, within 25 seconds, one task it can run — a job's lead first; a join once its lead has said where it coordinates — or 204.
- [Translate](https://docs.hanzo.ai/docs/openapi/translate.md): Text in, the same text out in the language you asked for.
- [List memory](https://docs.hanzo.ai/docs/openapi/translate/get-translate-memory.md): Returns the org's own translation-memory entries, newest first, optionally narrowed to one target language and/or one position on the review ladder.
- [Create translate](https://docs.hanzo.ai/docs/openapi/translate/post-translate.md): Returns one translation per input string, in input order, each carrying where it sits on the review ladder and whether it came from your memory rather than an engine — plus a usage block of REAL counts (strings, cached, translated, and the source characters that actually reached an engine).
- [Replace memory](https://docs.hanzo.ai/docs/openapi/translate/put-translate-memory.md): Records a human decision on one translation-memory entry, and returns the entry as stored.
- [Treasury](https://docs.hanzo.ai/docs/openapi/treasury.md): The reserve fund behind every payout: real capital, held and accounted for.
- [List treasury](https://docs.hanzo.ai/docs/openapi/treasury/get-treasury.md): Returns the reserve fund's health and the current revenue-share policy for any validated caller.
- [List accounts](https://docs.hanzo.ai/docs/openapi/treasury/get-treasury-accounts.md): Returns the ledger accounts the caller may see, with their balances.
- [Trust](https://docs.hanzo.ai/docs/openapi/trust.md): Your trust centre: the controls you publish, the coverage they compute to, the documents a reviewer asks for, and who you send data to.
- [Delete trust](https://docs.hanzo.ai/docs/openapi/trust/delete-trust-by-kind-by-id.md): Removes one record from a section of your organization's trust centre.
- [List trust](https://docs.hanzo.ai/docs/openapi/trust/get-trust.md): Reads YOUR organization's whole trust centre, including the addresses of your own gated documents.
- [List controls](https://docs.hanzo.ai/docs/openapi/trust/get-trust-controls.md): Lists every control your organization publishes, with the counts.
- [Get controls](https://docs.hanzo.ai/docs/openapi/trust/get-trust-controls-by-id.md): Reads one control by id.
- [List coverage](https://docs.hanzo.ai/docs/openapi/trust/get-trust-coverage.md): Reads coverage: per framework, how many clauses have an automated control behind them, how many are partial, and how many have none — each carrying the unit it is counted in, because "12 of 20" is not a fact until you know what the 20 are.
- [Get coverage](https://docs.hanzo.ai/docs/openapi/trust/get-trust-coverage-by-framework.md): Reads one framework clause by clause: every clause the standard publishes, what covers it, and which controls stand behind it — so a coverage number can be checked line by line rather than taken on trust.
- [List documents](https://docs.hanzo.ai/docs/openapi/trust/get-trust-documents.md): Lists your organization's documents.
- [List evidence](https://docs.hanzo.ai/docs/openapi/trust/get-trust-evidence.md): Reads the audit rows that stand behind one control, over a window.
- [List faq](https://docs.hanzo.ai/docs/openapi/trust/get-trust-faq.md): Lists your knowledge base — the questions a reviewer asks, answered once.
- [List frameworks](https://docs.hanzo.ai/docs/openapi/trust/get-trust-frameworks.md): Lists the frameworks coverage is computed against, and how many clauses each publishes.
- [List policies](https://docs.hanzo.ai/docs/openapi/trust/get-trust-policies.md): Lists your organization's published policies.
- [List profile](https://docs.hanzo.ai/docs/openapi/trust/get-trust-profile.md): Reads your organization's trust-centre profile — the name, tagline and summary a visitor sees, whether the centre is published, and where to send somebody who wants a gated document.
- [Get published](https://docs.hanzo.ai/docs/openapi/trust/get-trust-published-by-org.md): Reads a published trust centre — the whole thing in one answer: the organization's profile, its control inventory, coverage computed against each framework's whole published clause list, its documents, subprocessors, policies, knowledge base, updates and risk profile.
- [List risk](https://docs.hanzo.ai/docs/openapi/trust/get-trust-risk.md): Reads your risk profile — the label and value pairs describing what your organization handles and how.
- [List subprocessors](https://docs.hanzo.ai/docs/openapi/trust/get-trust-subprocessors.md): Lists the third parties your organization sends data to, each naming what it is for.
- [List updates](https://docs.hanzo.ai/docs/openapi/trust/get-trust-updates.md): Lists your trust-centre updates, newest as you ordered them.
- [Replace trust](https://docs.hanzo.ai/docs/openapi/trust/put-trust-by-kind-by-id.md): Writes one record into a section of YOUR organization's trust centre — profile, control, document, subprocessor, policy, faq, update or risk.
- [Usage](https://docs.hanzo.ai/docs/openapi/usage.md): What your org ran and what it cost, broken down per account.
- [List analytics](https://docs.hanzo.ai/docs/openapi/usage/get-usage-analytics.md): The entitlement-GATED per-provider breakdown of the caller org's LLM usage — the paid lens over the same warehouse ledger GET /v1/usage/summary reads its totals from.
- [List access](https://docs.hanzo.ai/docs/openapi/usage/get-usage-analytics-access.md): Echoes a plan's resolved analytics entitlement so a dashboard can configure itself against the LIVE catalog instead of hardcoding tier numbers.
- [List samples](https://docs.hanzo.ai/docs/openapi/usage/get-usage-samples.md): The PER-PROVIDER view: one connected account's own consumption of its own plan — "my plan is 47% through its 6h window, resets at 14:20".
- [List summary](https://docs.hanzo.ai/docs/openapi/usage/get-usage-summary.md): Answers GET /v1/usage/summary: the caller's own usage footprint over one window — the categorized spend roll-up from the commerce ledger, the org's LLM usage totals from the warehouse, and the caller's OWN linked provider accounts beside the org's Hanzo-routed usage.
- [Create usage](https://docs.hanzo.ai/docs/openapi/usage/post-usage.md): Ingests a batch of account-usage samples — what a developer's OWN AI accounts have consumed of their OWN plans, metered from each provider's own login — and appends them to the warehouse series.
- [Validator](https://docs.hanzo.ai/docs/openapi/validator.md): One-click validator onboarding: prove your Genesis NFT, get a node provisioned, queue its registration.
- [List validator](https://docs.hanzo.ai/docs/openapi/validator/get-validator.md): Returns the validator slots the caller's org has claimed.
- [Get validator](https://docs.hanzo.ai/docs/openapi/validator/get-validator-by-tokenid.md): Returns one claimed validator slot, scoped to the caller's org.
- [List challenge](https://docs.hanzo.ai/docs/openapi/validator/get-validator-challenge.md): Issues the single-use nonce and the exact message a wallet must sign to claim a validator slot.
- [Create validator](https://docs.hanzo.ai/docs/openapi/validator/post-validator.md): Claims a validator slot and provisions its node, after proving the caller's wallet owns the slot's NFT.
- [Wallet](https://docs.hanzo.ai/docs/openapi/wallet.md): Blockchain key custody: create wallets, rotate their keys, and sign with them.
- [List wallet](https://docs.hanzo.ai/docs/openapi/wallet/get-wallet.md): Returns the caller org's wallets, newest first, optionally NARROWED within the org by project, agent or account.
- [List accounts](https://docs.hanzo.ai/docs/openapi/wallet/get-wallet-accounts.md): Returns the caller org's wallet accounts, newest first.
- [Get wallet](https://docs.hanzo.ai/docs/openapi/wallet/get-wallet-by-id.md): Returns one of the caller org's wallets: its scope, custody kind, tier, chain and on-chain address.
- [Create wallet](https://docs.hanzo.ai/docs/openapi/wallet/post-wallet.md): Provisions a new signing identity under one of the caller org's accounts and answers the stored wallet including its on-chain address.
- [Create accounts](https://docs.hanzo.ai/docs/openapi/wallet/post-wallet-accounts.md): Opens a named wallet account for the caller's org.
- [Create keys](https://docs.hanzo.ai/docs/openapi/wallet/post-wallet-by-id-keys.md): Rolls one wallet's signing material through its own custody backend and answers the wallet with whatever address that produced.
- [Create sign](https://docs.hanzo.ai/docs/openapi/wallet/post-wallet-by-id-sign.md): Produces a secp256k1 signature from one of the caller org's wallets over a 32-byte digest, through whichever custody backend that wallet uses.
- [Create transactions](https://docs.hanzo.ai/docs/openapi/wallet/post-wallet-by-id-transactions.md): Composes a Safe transaction on the MPC ring and answers its EIP-712 hash together with the owner approval the ring's threshold signature produced.
- [Web3](https://docs.hanzo.ai/docs/openapi/web3.md): The chain-access surface: which chains this deployment can reach, a JSON-RPC endpoint onto each, and the two token reads every wallet UI needs.
- [List chains](https://docs.hanzo.ai/docs/openapi/web3/get-web3-chains.md): Reports the chains this deployment can reach.
- [Get chains](https://docs.hanzo.ai/docs/openapi/web3/get-web3-chains-by-chain.md): Reports one chain and whether its upstream is answering.
- [Get tokens](https://docs.hanzo.ai/docs/openapi/web3/get-web3-tokens-by-chain-by-address.md): Reads an address's native balance on a chain.
- [Create rpc](https://docs.hanzo.ai/docs/openapi/web3/post-web3-rpc-by-chain.md): Forwards a JSON-RPC call to the named chain and returns its answer unchanged.
- [Webhook](https://docs.hanzo.ai/docs/openapi/webhook.md): How your app hears about events: register an endpoint, pick the events, get each one delivered and signed.
- [Delete webhook](https://docs.hanzo.ai/docs/openapi/webhook/delete-webhook-by-id.md): Removes one of the caller org's webhook endpoints and answers 204 with no body.
- [List webhook](https://docs.hanzo.ai/docs/openapi/webhook/get-webhook.md): Returns every webhook endpoint the caller's org has registered, newest first, each with its 7-day delivery and failure counts.
- [Get webhook](https://docs.hanzo.ai/docs/openapi/webhook/get-webhook-by-id.md): Returns one of the caller org's webhook endpoints with its 7-day delivery and failure counts, signing secret redacted.
- [List deliveries](https://docs.hanzo.ai/docs/openapi/webhook/get-webhook-by-id-deliveries.md): Returns one endpoint's per-attempt delivery log, newest first — the record of what was sent, what the subscriber answered, and how long it took.
- [Create webhook](https://docs.hanzo.ai/docs/openapi/webhook/post-webhook.md): Registers a new webhook subscription for the caller's org and answers 201 with the endpoint INCLUDING its freshly minted signing secret.
- [Create secret](https://docs.hanzo.ai/docs/openapi/webhook/post-webhook-by-id-secret.md): Mints a NEW HMAC signing secret for the endpoint and answers the endpoint WITH it — the only other response besides create that ever carries a secret.
- [Test webhook](https://docs.hanzo.ai/docs/openapi/webhook/post-webhook-by-id-test.md): Sends ONE signed test event to the endpoint right now and answers the outcome inline, so the console can show whether the subscriber is reachable without waiting for real traffic.
- [Replace webhook](https://docs.hanzo.ai/docs/openapi/webhook/put-webhook-by-id.md): Replaces the editable fields of one of the caller org's endpoints — url, events, status and description — and answers the stored row with its secret redacted.
- [Websearch](https://docs.hanzo.ai/docs/openapi/websearch.md): A web search and a page fetch your agents can call.
- [Search websearch — DELETE /v1/websearch/search](https://docs.hanzo.ai/docs/openapi/websearch/delete-websearch-search.md): Answers {query, number_of_results, results:[{url, title, content, engine}]} — the exact /search?format=json contract a SearXNG client decodes, so an agent tool configured against SearXNG reaches this with no change.
- [Search websearch — GET /v1/websearch/search](https://docs.hanzo.ai/docs/openapi/websearch/get-websearch-search.md): Answers {query, number_of_results, results:[{url, title, content, engine}]} — the exact /search?format=json contract a SearXNG client decodes, so an agent tool configured against SearXNG reaches this with no change.
- [Search websearch — PATCH /v1/websearch/search](https://docs.hanzo.ai/docs/openapi/websearch/patch-websearch-search.md): Answers {query, number_of_results, results:[{url, title, content, engine}]} — the exact /search?format=json contract a SearXNG client decodes, so an agent tool configured against SearXNG reaches this with no change.
- [Create scrape](https://docs.hanzo.ai/docs/openapi/websearch/post-websearch-scrape.md): Takes {url} and answers {success, data:{markdown, metadata}} — the exact contract a firecrawl client decodes.
- [Search websearch — POST /v1/websearch/search](https://docs.hanzo.ai/docs/openapi/websearch/post-websearch-search.md): Answers {query, number_of_results, results:[{url, title, content, engine}]} — the exact /search?format=json contract a SearXNG client decodes, so an agent tool configured against SearXNG reaches this with no change.
- [Search websearch — PUT /v1/websearch/search](https://docs.hanzo.ai/docs/openapi/websearch/put-websearch-search.md): Answers {query, number_of_results, results:[{url, title, content, engine}]} — the exact /search?format=json contract a SearXNG client decodes, so an agent tool configured against SearXNG reaches this with no change.
- [Create websearch](https://docs.hanzo.ai/docs/openapi/websearch/search-web.md): Searches the live web and answers with ranked results.
- [Workflow](https://docs.hanzo.ai/docs/openapi/workflow.md): Hanzo Workflow: durable workflows that survive a crash, with every run visible and replayable.
- [Delete workflow](https://docs.hanzo.ai/docs/openapi/workflow/delete-workflow.md): Answers 307 with Location /v1/workflow/ — this address serves nothing itself.
- [List workflow](https://docs.hanzo.ai/docs/openapi/workflow/get-workflow.md): Answers 307 with Location /v1/workflow/ — this address serves nothing itself.
- [Update workflow](https://docs.hanzo.ai/docs/openapi/workflow/patch-workflow.md): Answers 307 with Location /v1/workflow/ — this address serves nothing itself.
- [Create workflow](https://docs.hanzo.ai/docs/openapi/workflow/post-workflow.md): Answers 307 with Location /v1/workflow/ — this address serves nothing itself.
- [Replace workflow](https://docs.hanzo.ai/docs/openapi/workflow/put-workflow.md): Answers 307 with Location /v1/workflow/ — this address serves nothing itself.
- [World](https://docs.hanzo.ai/docs/openapi/world.md): A live news feed filtered to what your project cares about.
- [List world](https://docs.hanzo.ai/docs/openapi/world/get-world.md): Answers GET /v1/world — the product's public endpoint, naming every wire this surface answers on.
- [List limits](https://docs.hanzo.ai/docs/openapi/world/get-world-limits.md): Echoes a World plan's rate limits, alert quota and model-API grant, read straight from the live @hanzo/plans catalog, so agents and dashboards configure themselves against the catalog instead of hardcoding tier numbers.
- [List news](https://docs.hanzo.ai/docs/openapi/world/get-world-news.md): Returns the caller's merged world-news feed: every source their project's pipeline names — GDELT once per keyword, plus each allowlisted RSS or Atom feed — fetched concurrently, narrowed by the pipeline's keyword/region/source filters, deduplicated by link and sorted freshest first, capped at 50 items.
- [List pipeline](https://docs.hanzo.ai/docs/openapi/world/get-world-pipeline.md): Returns the caller project's news pipeline: which feeds it reads and how the merged result is filtered.
- [List stream](https://docs.hanzo.ai/docs/openapi/world/get-world-stream.md): Holds the connection open as text/event-stream and pushes a `news` event — the same {items:[…]} body GET /v1/world/news answers — each time the caller's (org, project) feed refreshes, with a `: ping` heartbeat comment every 25s.
- [Replace pipeline](https://docs.hanzo.ai/docs/openapi/world/put-world-pipeline.md): Replaces the caller project's news pipeline and returns what was stored.
- [x402](https://docs.hanzo.ai/docs/openapi/x402.md): Pay-per-request over HTTP 402: quote a price, take the payment, serve the resource.
- [List settlements](https://docs.hanzo.ai/docs/openapi/x402/get-x402-settlements.md): Lists the caller's x402 receipts, newest first: as payer, what its ledger paid; as payee, what it was paid — each settled payment with what it bought, both parties, the exact amount and when.
- [Get settlements](https://docs.hanzo.ai/docs/openapi/x402/get-x402-settlements-by-id.md): Reads one x402 payment receipt by id.
- [Zen](https://docs.hanzo.ai/docs/openapi/zen.md): Zen — reached at co-resident on ai's router; not in the public REST contract.

## CLI — the `hanzo` command line, one page per capability

- [CLI](https://docs.hanzo.ai/docs/cli.md): The `hanzo` command line — 2263 commands across 121 capabilities, generated from the CLI's own command table.
- [Account](https://docs.hanzo.ai/docs/cli/account.md): The `hanzo account` commands.
- [Ad](https://docs.hanzo.ai/docs/cli/ad.md): The `hanzo ad` commands.
- [Affiliate](https://docs.hanzo.ai/docs/cli/affiliate.md): The `hanzo affiliate` commands.
- [Agent](https://docs.hanzo.ai/docs/cli/agent.md): The `hanzo agent` commands.
- [AI](https://docs.hanzo.ai/docs/cli/ai.md): The `hanzo 3d` commands.
- [Allowance](https://docs.hanzo.ai/docs/cli/allowance.md): The `hanzo allowance` commands.
- [Ask](https://docs.hanzo.ai/docs/cli/ask.md): The `hanzo ask` commands.
- [Audit](https://docs.hanzo.ai/docs/cli/audit.md): The `hanzo audit` commands.
- [Author](https://docs.hanzo.ai/docs/cli/author.md): The `hanzo author` commands.
- [Authz](https://docs.hanzo.ai/docs/cli/authz.md): The `hanzo authz` commands.
- [Auto](https://docs.hanzo.ai/docs/cli/auto.md): The `hanzo auto` commands.
- [Base](https://docs.hanzo.ai/docs/cli/base.md): The `hanzo base` commands.
- [Benchmark](https://docs.hanzo.ai/docs/cli/benchmark.md): The `hanzo benchmark` commands.
- [Billing](https://docs.hanzo.ai/docs/cli/billing.md): The `hanzo billing` commands.
- [Blueprint](https://docs.hanzo.ai/docs/cli/blueprint.md): The `hanzo blueprint` commands.
- [Books](https://docs.hanzo.ai/docs/cli/books.md): The `hanzo books` commands.
- [Bot](https://docs.hanzo.ai/docs/cli/bot.md): The `hanzo bot` commands.
- [Campaign](https://docs.hanzo.ai/docs/cli/campaign.md): The `hanzo campaign` commands.
- [Captable](https://docs.hanzo.ai/docs/cli/captable.md): The `hanzo captable` commands.
- [Catalog](https://docs.hanzo.ai/docs/cli/catalog.md): The `hanzo catalog` commands.
- [Channel](https://docs.hanzo.ai/docs/cli/channel.md): The `hanzo channel` commands.
- [Ci](https://docs.hanzo.ai/docs/cli/ci.md): The `hanzo ci` commands.
- [Cloudflare](https://docs.hanzo.ai/docs/cli/cloudflare.md): The `hanzo cloudflare` commands.
- [Code](https://docs.hanzo.ai/docs/cli/code.md): The `hanzo code` commands.
- [Commerce](https://docs.hanzo.ai/docs/cli/commerce.md): The `hanzo commerce` commands.
- [Company](https://docs.hanzo.ai/docs/cli/company.md): The `hanzo company` commands.
- [Compliance](https://docs.hanzo.ai/docs/cli/compliance.md): The `hanzo compliance` commands.
- [Compute](https://docs.hanzo.ai/docs/cli/compute.md): The `hanzo compute` commands.
- [Content](https://docs.hanzo.ai/docs/cli/content.md): The `hanzo content` commands.
- [Crawl](https://docs.hanzo.ai/docs/cli/crawl.md): The `hanzo crawl` commands.
- [Dataroom](https://docs.hanzo.ai/docs/cli/dataroom.md): The `hanzo dataroom` commands.
- [Dataset](https://docs.hanzo.ai/docs/cli/dataset.md): The `hanzo dataset` commands.
- [Deploy](https://docs.hanzo.ai/docs/cli/deploy.md): The `hanzo deploy` commands.
- [Destination](https://docs.hanzo.ai/docs/cli/destination.md): The `hanzo destination` commands.
- [DNS](https://docs.hanzo.ai/docs/cli/dns.md): The `hanzo dns` commands.
- [Domain](https://docs.hanzo.ai/docs/cli/domain.md): The `hanzo domain` commands.
- [Engine](https://docs.hanzo.ai/docs/cli/engine.md): The `hanzo engine` commands.
- [Entitlement](https://docs.hanzo.ai/docs/cli/entitlement.md): The `hanzo entitlement` commands.
- [eSign](https://docs.hanzo.ai/docs/cli/esign.md): The `hanzo esign` commands.
- [Eval](https://docs.hanzo.ai/docs/cli/eval.md): The `hanzo eval` commands.
- [Event](https://docs.hanzo.ai/docs/cli/event.md): The `hanzo event` commands.
- [Exec](https://docs.hanzo.ai/docs/cli/exec.md): The `hanzo exec` commands.
- [Experiment](https://docs.hanzo.ai/docs/cli/experiment.md): The `hanzo experiment` commands.
- [Explorer](https://docs.hanzo.ai/docs/cli/explorer.md): The `hanzo explorer` commands.
- [Flag](https://docs.hanzo.ai/docs/cli/flag.md): The `hanzo flag` commands.
- [Flow](https://docs.hanzo.ai/docs/cli/flow.md): The `hanzo flow` commands.
- [Framework](https://docs.hanzo.ai/docs/cli/framework.md): The `hanzo framework` commands.
- [Function](https://docs.hanzo.ai/docs/cli/function.md): The `hanzo function` commands.
- [Gateway](https://docs.hanzo.ai/docs/cli/gateway.md): The `hanzo gateway` commands.
- [Git](https://docs.hanzo.ai/docs/cli/git.md): The `hanzo git` commands.
- [Graph](https://docs.hanzo.ai/docs/cli/graph.md): The `hanzo graph` commands.
- [Guide](https://docs.hanzo.ai/docs/cli/guide.md): The `hanzo guide` commands.
- [Help](https://docs.hanzo.ai/docs/cli/help.md): The `hanzo help` commands.
- [IAM](https://docs.hanzo.ai/docs/cli/iam.md): The `hanzo iam` commands.
- [Index](https://docs.hanzo.ai/docs/cli/index.md): The `hanzo index` commands.
- [Ingress](https://docs.hanzo.ai/docs/cli/ingress.md): The `hanzo ingress` commands.
- [KMS](https://docs.hanzo.ai/docs/cli/kms.md): The `hanzo kms` commands.
- [Knowledge](https://docs.hanzo.ai/docs/cli/knowledge.md): The `hanzo knowledge` commands.
- [KV](https://docs.hanzo.ai/docs/cli/kv.md): The `hanzo kv` commands.
- [Label](https://docs.hanzo.ai/docs/cli/label.md): The `hanzo label` commands.
- [Leaderboard](https://docs.hanzo.ai/docs/cli/leaderboard.md): The `hanzo leaderboard` commands.
- [Legal](https://docs.hanzo.ai/docs/cli/legal.md): The `hanzo legal` commands.
- [Licensing](https://docs.hanzo.ai/docs/cli/licensing.md): The `hanzo licensing` commands.
- [Link](https://docs.hanzo.ai/docs/cli/link.md): The `hanzo auth link` commands.
- [LSP](https://docs.hanzo.ai/docs/cli/lsp.md): The `hanzo lsp` commands.
- [Market](https://docs.hanzo.ai/docs/cli/market.md): The `hanzo market` commands.
- [Marketing](https://docs.hanzo.ai/docs/cli/marketing.md): The `hanzo marketing` commands.
- [Marketplace](https://docs.hanzo.ai/docs/cli/marketplace.md): The `hanzo marketplace` commands.
- [Meet](https://docs.hanzo.ai/docs/cli/meet.md): The `hanzo meet` commands.
- [Metrics](https://docs.hanzo.ai/docs/cli/metrics.md): The `hanzo metrics` commands.
- [ML](https://docs.hanzo.ai/docs/cli/ml.md): The `hanzo ml` commands.
- [MQ](https://docs.hanzo.ai/docs/cli/mq.md): The `hanzo mq` commands.
- [Network](https://docs.hanzo.ai/docs/cli/network.md): The `hanzo network` commands.
- [Node](https://docs.hanzo.ai/docs/cli/node.md): The `hanzo node` commands.
- [Notify](https://docs.hanzo.ai/docs/cli/notify.md): The `hanzo notify` commands.
- [O11y](https://docs.hanzo.ai/docs/cli/o11y.md): The `hanzo o11y` commands.
- [OpenAPI](https://docs.hanzo.ai/docs/cli/openapi.md): The `hanzo mcp` commands.
- [Patrol](https://docs.hanzo.ai/docs/cli/patrol.md): The `hanzo patrol` commands.
- [Plan](https://docs.hanzo.ai/docs/cli/plan.md): The `hanzo plan` commands.
- [Platform](https://docs.hanzo.ai/docs/cli/platform.md): The `hanzo build` commands.
- [Pref](https://docs.hanzo.ai/docs/cli/pref.md): The `hanzo pref` commands.
- [Pricing](https://docs.hanzo.ai/docs/cli/pricing.md): The `hanzo pricing` commands.
- [Project](https://docs.hanzo.ai/docs/cli/project.md): The `hanzo project` commands.
- [Prompt](https://docs.hanzo.ai/docs/cli/prompt.md): The `hanzo prompt` commands.
- [Provider](https://docs.hanzo.ai/docs/cli/provider.md): The `hanzo connection` commands.
- [Provisioning](https://docs.hanzo.ai/docs/cli/provisioning.md): The `hanzo provisioning` commands.
- [Pubsub](https://docs.hanzo.ai/docs/cli/pubsub.md): The `hanzo pubsub` commands.
- [Reference](https://docs.hanzo.ai/docs/cli/reference.md): The `hanzo reference` commands.
- [Referral](https://docs.hanzo.ai/docs/cli/referral.md): The `hanzo referral` commands.
- [Registry](https://docs.hanzo.ai/docs/cli/registry.md): The `hanzo registry` commands.
- [Risk](https://docs.hanzo.ai/docs/cli/risk.md): The `hanzo risk` commands.
- [S3](https://docs.hanzo.ai/docs/cli/s3.md): The `hanzo s3` commands.
- [Sandbox](https://docs.hanzo.ai/docs/cli/sandbox.md): The `hanzo sandbox` commands.
- [SBOM](https://docs.hanzo.ai/docs/cli/sbom.md): The `hanzo sbom` commands.
- [Search](https://docs.hanzo.ai/docs/cli/search.md): The `hanzo search` commands.
- [Security](https://docs.hanzo.ai/docs/cli/security.md): The `hanzo security` commands.
- [SEO](https://docs.hanzo.ai/docs/cli/seo.md): The `hanzo seo` commands.
- [Settings](https://docs.hanzo.ai/docs/cli/settings.md): The `hanzo settings` commands.
- [Share](https://docs.hanzo.ai/docs/cli/share.md): The `hanzo share` commands.
- [Social](https://docs.hanzo.ai/docs/cli/social.md): The `hanzo social` commands.
- [Space](https://docs.hanzo.ai/docs/cli/space.md): The `hanzo space` commands.
- [Standing](https://docs.hanzo.ai/docs/cli/standing.md): The `hanzo standing` commands.
- [Sync](https://docs.hanzo.ai/docs/cli/sync.md): The `hanzo sync` commands.
- [Task](https://docs.hanzo.ai/docs/cli/task.md): The `hanzo task` commands.
- [Taxonomy](https://docs.hanzo.ai/docs/cli/taxonomy.md): The `hanzo taxonomy` commands.
- [Team](https://docs.hanzo.ai/docs/cli/team.md): The `hanzo team` commands.
- [Tel](https://docs.hanzo.ai/docs/cli/tel.md): The `hanzo tel` commands.
- [Template](https://docs.hanzo.ai/docs/cli/template.md): The `hanzo template` commands.
- [Tool](https://docs.hanzo.ai/docs/cli/tool.md): The `hanzo tool` commands.
- [Translate](https://docs.hanzo.ai/docs/cli/translate.md): The `hanzo translate` commands.
- [Treasury](https://docs.hanzo.ai/docs/cli/treasury.md): The `hanzo treasury` commands.
- [Trust](https://docs.hanzo.ai/docs/cli/trust.md): The `hanzo trust` commands.
- [Usage](https://docs.hanzo.ai/docs/cli/usage.md): The `hanzo usage` commands.
- [Validator](https://docs.hanzo.ai/docs/cli/validator.md): The `hanzo validator` commands.
- [Wallet](https://docs.hanzo.ai/docs/cli/wallet.md): The `hanzo wallet` commands.
- [Web3](https://docs.hanzo.ai/docs/cli/web3.md): The `hanzo web3` commands.
- [Webhook](https://docs.hanzo.ai/docs/cli/webhook.md): The `hanzo webhook` commands.
- [Websearch](https://docs.hanzo.ai/docs/cli/websearch.md): The `hanzo websearch` commands.
- [Workflow](https://docs.hanzo.ai/docs/cli/workflow.md): The `hanzo workflow` commands.
- [World](https://docs.hanzo.ai/docs/cli/world.md): The `hanzo world` commands.
- [x402](https://docs.hanzo.ai/docs/cli/x402.md): The `hanzo x402` commands.

## MCP — one page per tool MCP exposes

- [Cloud MCP](https://docs.hanzo.ai/docs/mcp-tools.md): One JSON-RPC endpoint that gives any MCP client 120 tools over the Hanzo cloud, plus the external servers your org registers.
- [Account](https://docs.hanzo.ai/docs/mcp-tools/account.md): account: 6 operations.
- [Ad](https://docs.hanzo.ai/docs/mcp-tools/ad.md): ad: 6 operations.
- [Affiliate](https://docs.hanzo.ai/docs/mcp-tools/affiliate.md): affiliate: 10 operations.
- [Agent](https://docs.hanzo.ai/docs/mcp-tools/agent.md): agent: 38 operations.
- [AI](https://docs.hanzo.ai/docs/mcp-tools/ai.md): ai: 3 operations.
- [Tool catalogue](https://docs.hanzo.ai/docs/mcp-tools/all-tools.md): Every one of the 120 tools documented here, grouped by the product it calls.
- [Ask](https://docs.hanzo.ai/docs/mcp-tools/ask.md): ask: 1 operations.
- [Author](https://docs.hanzo.ai/docs/mcp-tools/author.md): author: 5 operations.
- [Auto](https://docs.hanzo.ai/docs/mcp-tools/auto.md): auto: 14 operations.
- [Base](https://docs.hanzo.ai/docs/mcp-tools/base.md): base: 3 operations.
- [Benchmark](https://docs.hanzo.ai/docs/mcp-tools/benchmark.md): benchmark: 9 operations.
- [Billing](https://docs.hanzo.ai/docs/mcp-tools/billing.md): billing: 39 operations.
- [Blueprint](https://docs.hanzo.ai/docs/mcp-tools/blueprint.md): blueprint: 2 operations.
- [Campaign](https://docs.hanzo.ai/docs/mcp-tools/campaign.md): campaign: 9 operations.
- [Captable](https://docs.hanzo.ai/docs/mcp-tools/captable.md): captable: 30 operations.
- [Channel](https://docs.hanzo.ai/docs/mcp-tools/channel.md): channel: 8 operations.
- [Ci](https://docs.hanzo.ai/docs/mcp-tools/ci.md): ci: 2 operations.
- [Code](https://docs.hanzo.ai/docs/mcp-tools/code.md): code: 7 operations.
- [Commerce](https://docs.hanzo.ai/docs/mcp-tools/commerce.md): commerce: 5 operations.
- [Company](https://docs.hanzo.ai/docs/mcp-tools/company.md): company: 22 operations.
- [Compliance](https://docs.hanzo.ai/docs/mcp-tools/compliance.md): compliance: 16 operations.
- [Compute](https://docs.hanzo.ai/docs/mcp-tools/compute.md): compute: 28 operations.
- [Content](https://docs.hanzo.ai/docs/mcp-tools/content.md): content: 6 operations.
- [Crawl](https://docs.hanzo.ai/docs/mcp-tools/crawl.md): crawl: 1 operations.
- [Dataroom](https://docs.hanzo.ai/docs/mcp-tools/dataroom.md): dataroom: 19 operations.
- [Dataset](https://docs.hanzo.ai/docs/mcp-tools/dataset.md): dataset: 7 operations.
- [Deploy](https://docs.hanzo.ai/docs/mcp-tools/deploy.md): deploy: 11 operations.
- [Destination](https://docs.hanzo.ai/docs/mcp-tools/destination.md): destination: 4 operations.
- [Domain](https://docs.hanzo.ai/docs/mcp-tools/domain.md): domain: 7 operations.
- [Engine](https://docs.hanzo.ai/docs/mcp-tools/engine.md): engine: 4 operations.
- [Environment](https://docs.hanzo.ai/docs/mcp-tools/environment.md): environment: 4 operations.
- [eSign](https://docs.hanzo.ai/docs/mcp-tools/esign.md): esign: 9 operations.
- [Event](https://docs.hanzo.ai/docs/mcp-tools/event.md): event: 9 operations.
- [Experiment](https://docs.hanzo.ai/docs/mcp-tools/experiment.md): experiment: 7 operations.
- [Flag](https://docs.hanzo.ai/docs/mcp-tools/flag.md): flag: 8 operations.
- [Flow](https://docs.hanzo.ai/docs/mcp-tools/flow.md): flow: 8 operations.
- [Framework](https://docs.hanzo.ai/docs/mcp-tools/framework.md): framework: 14 operations.
- [Function](https://docs.hanzo.ai/docs/mcp-tools/function.md): function: 10 operations.
- [Gateway](https://docs.hanzo.ai/docs/mcp-tools/gateway.md): gateway: 3 operations.
- [Git](https://docs.hanzo.ai/docs/mcp-tools/git.md): git: 38 operations.
- [Graph](https://docs.hanzo.ai/docs/mcp-tools/graph.md): graph: 14 operations.
- [Guide](https://docs.hanzo.ai/docs/mcp-tools/guide.md): guide: 13 operations.
- [IAM](https://docs.hanzo.ai/docs/mcp-tools/iam.md): iam: 44 operations.
- [Index](https://docs.hanzo.ai/docs/mcp-tools/indexes.md): index: 14 operations.
- [Ingress](https://docs.hanzo.ai/docs/mcp-tools/ingress.md): ingress: 18 operations.
- [KMS](https://docs.hanzo.ai/docs/mcp-tools/kms.md): kms: 2 operations.
- [Knowledge](https://docs.hanzo.ai/docs/mcp-tools/knowledge.md): knowledge: 9 operations.
- [KV](https://docs.hanzo.ai/docs/mcp-tools/kv.md): kv: 6 operations.
- [Label](https://docs.hanzo.ai/docs/mcp-tools/label.md): label: 7 operations.
- [Leaderboard](https://docs.hanzo.ai/docs/mcp-tools/leaderboard.md): leaderboard: 5 operations.
- [Legal](https://docs.hanzo.ai/docs/mcp-tools/legal.md): legal: 10 operations.
- [Licensing](https://docs.hanzo.ai/docs/mcp-tools/licensing.md): licensing: 9 operations.
- [Link](https://docs.hanzo.ai/docs/mcp-tools/link.md): link: 11 operations.
- [Market](https://docs.hanzo.ai/docs/mcp-tools/market.md): market: 3 operations.
- [Marketing](https://docs.hanzo.ai/docs/mcp-tools/marketing.md): marketing: 35 operations.
- [Marketplace](https://docs.hanzo.ai/docs/mcp-tools/marketplace.md): marketplace: 23 operations.
- [Meet](https://docs.hanzo.ai/docs/mcp-tools/meet.md): meet: 5 operations.
- [MQ](https://docs.hanzo.ai/docs/mcp-tools/mq.md): mq: 15 operations.
- [Network](https://docs.hanzo.ai/docs/mcp-tools/network.md): network: 7 operations.
- [Notify](https://docs.hanzo.ai/docs/mcp-tools/notify.md): notify: 4 operations.
- [O11y](https://docs.hanzo.ai/docs/mcp-tools/o11y.md): o11y: 307 operations.
- [Patrol](https://docs.hanzo.ai/docs/mcp-tools/patrol.md): patrol: 26 operations.
- [Plan](https://docs.hanzo.ai/docs/mcp-tools/plan.md): plan: 14 operations.
- [Platform](https://docs.hanzo.ai/docs/mcp-tools/platform.md): platform: 38 operations.
- [Pricing](https://docs.hanzo.ai/docs/mcp-tools/pricing.md): pricing: 28 operations.
- [Principal](https://docs.hanzo.ai/docs/mcp-tools/principal.md): principal: 7 operations.
- [Project](https://docs.hanzo.ai/docs/mcp-tools/project.md): project: 52 operations.
- [Prompt](https://docs.hanzo.ai/docs/mcp-tools/prompt.md): prompt: 6 operations.
- [Provider](https://docs.hanzo.ai/docs/mcp-tools/provider.md): provider: 38 operations.
- [Provisioning](https://docs.hanzo.ai/docs/mcp-tools/provisioning.md): provisioning: 28 operations.
- [Reference](https://docs.hanzo.ai/docs/mcp-tools/reference.md): reference: 5 operations.
- [Registry](https://docs.hanzo.ai/docs/mcp-tools/registry.md): registry: 5 operations.
- [Risk](https://docs.hanzo.ai/docs/mcp-tools/risk.md): risk: 9 operations.
- [S3](https://docs.hanzo.ai/docs/mcp-tools/s3.md): s3: 6 operations.
- [Sandbox](https://docs.hanzo.ai/docs/mcp-tools/sandbox.md): sandbox: 17 operations.
- [SBOM](https://docs.hanzo.ai/docs/mcp-tools/sbom.md): sbom: 1 operations.
- [Search](https://docs.hanzo.ai/docs/mcp-tools/search.md): search: 1 operations.
- [Security](https://docs.hanzo.ai/docs/mcp-tools/security.md): security: 7 operations.
- [SEO](https://docs.hanzo.ai/docs/mcp-tools/seo.md): seo: 7 operations.
- [Social](https://docs.hanzo.ai/docs/mcp-tools/social.md): social: 13 operations.
- [Space](https://docs.hanzo.ai/docs/mcp-tools/space.md): space: 7 operations.
- [Sync](https://docs.hanzo.ai/docs/mcp-tools/sync.md): sync: 6 operations.
- [Task](https://docs.hanzo.ai/docs/mcp-tools/task.md): task: 10 operations.
- [Tax](https://docs.hanzo.ai/docs/mcp-tools/tax.md): tax: 26 operations.
- [Team](https://docs.hanzo.ai/docs/mcp-tools/team.md): team: 33 operations.
- [Tel](https://docs.hanzo.ai/docs/mcp-tools/tel.md): tel: 10 operations.
- [Template](https://docs.hanzo.ai/docs/mcp-tools/template.md): template: 5 operations.
- [Tool](https://docs.hanzo.ai/docs/mcp-tools/tool.md): tool: 17 operations.
- [Translate](https://docs.hanzo.ai/docs/mcp-tools/translate.md): translate: 2 operations.
- [Trust](https://docs.hanzo.ai/docs/mcp-tools/trust.md): trust: 17 operations.
- [Unmapped](https://docs.hanzo.ai/docs/mcp-tools/unmapped.md): 25 MCP tools MCP exposes that the OpenAPI document does not describe.
- [allowance](https://docs.hanzo.ai/docs/mcp-tools/unmapped/allowance.md): allowance: 1 operations.
- [audit](https://docs.hanzo.ai/docs/mcp-tools/unmapped/audit.md): audit: 1 operations.
- [books](https://docs.hanzo.ai/docs/mcp-tools/unmapped/books.md): books: 20 operations.
- [bot](https://docs.hanzo.ai/docs/mcp-tools/unmapped/bot.md): bot: 3 operations.
- [catalog](https://docs.hanzo.ai/docs/mcp-tools/unmapped/catalog.md): catalog: 1 operations.
- [cloudflare](https://docs.hanzo.ai/docs/mcp-tools/unmapped/cloudflare.md): cloudflare: 29 operations.
- [describe](https://docs.hanzo.ai/docs/mcp-tools/unmapped/describe.md): The description and input schema of ONE operation, named as it appears in a subsystem tool's "op" enum.
- [entitlement](https://docs.hanzo.ai/docs/mcp-tools/unmapped/entitlement.md): entitlement: 3 operations.
- [eval](https://docs.hanzo.ai/docs/mcp-tools/unmapped/eval.md): eval: 16 operations.
- [exec](https://docs.hanzo.ai/docs/mcp-tools/unmapped/exec.md): exec: 2 operations.
- [explorer](https://docs.hanzo.ai/docs/mcp-tools/unmapped/explorer.md): explorer: 2 operations.
- [help](https://docs.hanzo.ai/docs/mcp-tools/unmapped/help.md): help: 4 operations.
- [lsp](https://docs.hanzo.ai/docs/mcp-tools/unmapped/lsp.md): lsp: 5 operations.
- [ml](https://docs.hanzo.ai/docs/mcp-tools/unmapped/ml.md): ml: 4 operations.
- [node](https://docs.hanzo.ai/docs/mcp-tools/unmapped/node.md): node: 1 operations.
- [pref](https://docs.hanzo.ai/docs/mcp-tools/unmapped/pref.md): pref: 1 operations.
- [pubsub](https://docs.hanzo.ai/docs/mcp-tools/unmapped/pubsub.md): pubsub: 2 operations.
- [referral](https://docs.hanzo.ai/docs/mcp-tools/unmapped/referral.md): referral: 2 operations.
- [settings](https://docs.hanzo.ai/docs/mcp-tools/unmapped/settings.md): settings: 2 operations.
- [share](https://docs.hanzo.ai/docs/mcp-tools/unmapped/share.md): share: 2 operations.
- [standing](https://docs.hanzo.ai/docs/mcp-tools/unmapped/standing.md): standing: 1 operations.
- [taxonomy](https://docs.hanzo.ai/docs/mcp-tools/unmapped/taxonomy.md): taxonomy: 5 operations.
- [treasury](https://docs.hanzo.ai/docs/mcp-tools/unmapped/treasury.md): treasury: 2 operations.
- [web3](https://docs.hanzo.ai/docs/mcp-tools/unmapped/web3.md): web3: 3 operations.
- [x402](https://docs.hanzo.ai/docs/mcp-tools/unmapped/x402.md): x402: 2 operations.
- [Usage](https://docs.hanzo.ai/docs/mcp-tools/usage.md): usage: 5 operations.
- [Validator](https://docs.hanzo.ai/docs/mcp-tools/validator.md): validator: 4 operations.
- [Wallet](https://docs.hanzo.ai/docs/mcp-tools/wallet.md): wallet: 7 operations.
- [Webhook](https://docs.hanzo.ai/docs/mcp-tools/webhook.md): webhook: 7 operations.
- [Websearch](https://docs.hanzo.ai/docs/mcp-tools/websearch.md): websearch: 1 operations.
- [World](https://docs.hanzo.ai/docs/mcp-tools/world.md): world: 5 operations.

## Open source — docs ported from the repositories themselves

- [Projects](https://docs.hanzo.ai/docs/projects.md): Aggregated documentation across Hanzo organizations.
- [hanzoai](https://docs.hanzo.ai/docs/projects/hanzoai.md): Projects in the hanzoai organization.
- [Authz](https://docs.hanzo.ai/docs/projects/hanzoai/authz.md): Hanzo Authz — access control library for Go: ACL, RBAC, ABAC policy enforcement
- [Base](https://docs.hanzo.ai/docs/projects/hanzoai/base.md): Hanzo Base — multi-tenant SQLite backend with polyglot in-process extension runtimes and age-encrypted WAL replication; the storage substrate of the Hanzo cloud.
- [Ci](https://docs.hanzo.ai/docs/projects/hanzoai/ci.md): Reusable CI/CD: build/test/deploy any repo from its hanzo.yml on arc
- [Core Networkmanagement](https://docs.hanzo.ai/docs/projects/hanzoai/core-networkmanagement.md): Networkmanager built with coreDNS and coreDHCP with web gui
- [Index](https://docs.hanzo.ai/docs/projects/hanzoai/datastore.md)
- [Formats for Input and Output Data](https://docs.hanzo.ai/docs/projects/hanzoai/datastore/en/sql-reference/formats.md): Supported input and output formats
- [Deepspec](https://docs.hanzo.ai/docs/projects/hanzoai/deepspec.md): DeepSpec (DSpark/DFlash/Eagle3 draft training) + Hanzo V4 pipeline — fork of deepseek-ai/DeepSpec
- [Esign](https://docs.hanzo.ai/docs/projects/hanzoai/esign.md): Hanzo eSign — open-source electronic document signing.
- [Expr](https://docs.hanzo.ai/docs/projects/hanzoai/expr.md): Expression language and expression evaluation for Go
- [Forum](https://docs.hanzo.ai/docs/projects/hanzoai/forum.md): Tracking fork of Discourse, kept for a future Hanzo community forum. Nothing Hanzo-specific built on it yet.
- [Gateway](https://docs.hanzo.ai/docs/projects/hanzoai/gateway.md): Hanzo Gateway — the stateless trust boundary at api.hanzo.ai: IAM identity, rate limiting, metering and CORS, then a straight forward to cloud. Routing lives in cloud, not here.
- [Go Fuse](https://docs.hanzo.ai/docs/projects/hanzoai/go-fuse.md): FUSE bindings for Go
- [Goa](https://docs.hanzo.ai/docs/projects/hanzoai/goa.md): Pure-Go polyglot embedding: run Go, JS/TS (goja), Python (gpython), Rust/WASM (wazero) as goroutines in one static binary. Unifies Hanzo cloud services.
- [Goexif](https://docs.hanzo.ai/docs/projects/hanzoai/goexif.md): EXIF decoder for Go — Hanzo fork of goexif (BSD-2-Clause). Module: github.com/hanzoai/goexif
- [Govaluate](https://docs.hanzo.ai/docs/projects/hanzoai/govaluate.md): MIT expression evaluation for Go (fork of Knetic/govaluate)
- [Helpdesk](https://docs.hanzo.ai/docs/projects/hanzoai/helpdesk.md): Hanzo Help Center — Frappe Helpdesk fork (Base/SQLite, IAM SSO). Second Frappe app proving one-Frappe-core → all-Frappe-apps.
- [Helper](https://docs.hanzo.ai/docs/projects/hanzoai/helper.md): Hanzo helper CLI: configure Claude Code, Claude Desktop, and Codex to use Hanzo AI
- [Iam](https://docs.hanzo.ai/docs/projects/hanzoai/iam.md): Hanzo IAM v2 — proprietary identity service on zap-proto/zip + hanzoai/orm + hanzoai/base. Clean-room, original work.
- [Authentication](https://docs.hanzo.ai/docs/projects/hanzoai/iam/sdk/authentication.md): JWT validation, OIDC discovery, and OAuth2 PKCE flows with @hanzo/iam.
- [Billing](https://docs.hanzo.ai/docs/projects/hanzoai/iam/sdk/billing.md): Subscription management, plans, pricing, and payment APIs with the IAM billing client.
- [React Bindings](https://docs.hanzo.ai/docs/projects/hanzoai/iam/sdk/react.md): Drop-in React provider and hooks for Hanzo IAM — authentication, org switching, and token management.
- [IAM SDK](https://docs.hanzo.ai/docs/projects/hanzoai/iam/sdk/README.md): TypeScript SDK for Hanzo IAM — OIDC auth, JWT validation, OAuth2 PKCE, org/billing APIs, and React bindings.
- [Ingress](https://docs.hanzo.ai/docs/projects/hanzoai/ingress.md): Hanzo Ingress -- cloud-native, Kubernetes-native L7 reverse proxy and load balancer for Hanzo AI infrastructure (automatic TLS, dynamic config, zero-downtime reloads).
- [Insights](https://docs.hanzo.ai/docs/projects/hanzoai/insights.md): Hanzo Insights — product analytics and feature flags.
- [SDK feature support](https://docs.hanzo.ai/docs/projects/hanzoai/insights/published/docs/surveys/sdk-feature-support.md)
- [Kv](https://docs.hanzo.ai/docs/projects/hanzoai/kv.md): Ultra-fast key-value store with Redis API compatibility
- [Migrate](https://docs.hanzo.ai/docs/projects/hanzoai/migrate.md): Database migrations. CLI and Golang library.
- [Ml](https://docs.hanzo.ai/docs/projects/hanzoai/ml.md): Hanzo ML — fast multi-backend (CPU/CUDA/Metal/ROCm/Vulkan) tensor & ML framework for Rust with quantization; the compute core of the Hanzo stack.
- [O11y](https://docs.hanzo.ai/docs/projects/hanzoai/o11y.md): Hanzo o11y — OpenTelemetry-native observability (metrics, traces, logs) for the Hanzo platform, backed by Hanzo Datastore.
- [O11y Foundry](https://docs.hanzo.ai/docs/projects/hanzoai/o11y-foundry.md): Foundry is a centralized hub for SigNoz installation configurations and deployments: integrations for install. Select yours, configure, and run SigNoz.
- [Orm](https://docs.hanzo.ai/docs/projects/hanzoai/orm.md): Generics-based ORM for Go — type-safe Model[T] with auto-registration, auto-serialization, KV cache, and multi-backend support (Hanzo SQLite, Hanzo SQL, Hanzo DocDB)
- [Otel Collector](https://docs.hanzo.ai/docs/projects/hanzoai/otel-collector.md): Hanzo O11y Otel Collector — Hanzo's OpenTelemetry Collector distro: ZAP-native + OTLP ingest into hanzoai/datastore
- [Paas Demo](https://docs.hanzo.ai/docs/projects/hanzoai/paas-demo.md): Demo — proves the Hanzo native PaaS: built from git by in-cluster BuildKit, calls api.hanzo.ai/v1/chat per request.
- [ROCm](https://docs.hanzo.ai/docs/projects/hanzoai/ROCm.md): Hanzo downstream of AMD ROCm (MIT), manifest pinned to rocm-7.2.0 for gfx builds
- [Rocm Rs](https://docs.hanzo.ai/docs/projects/hanzoai/rocm-rs.md): Hanzo fork of rocm-rs — cross-platform (Linux + Windows/MSVC) ROCm bindings for gfx1151: portable enum/status types, edition-2024 unsafe blocks, gated amdgcn GPU-sort kernel.
- [S3](https://docs.hanzo.ai/docs/projects/hanzoai/s3.md): Hanzo S3 — S3-compatible distributed object storage
- [Social](https://docs.hanzo.ai/docs/projects/hanzoai/social.md): 📨 Hanzo Social — agentic social media scheduling 🤖
- [Sql](https://docs.hanzo.ai/docs/projects/hanzoai/sql.md): [RETIRED — use hanzoai/sql] Identical HEAD e80fa4c80 to hanzoai/sql; the product is Hanzo SQL, not "postgres". Kept for history only.
- [Sqlite3](https://docs.hanzo.ai/docs/projects/hanzoai/sqlite3.md): Go bindings to SQLite using wasm2go
- [Vfs](https://docs.hanzo.ai/docs/projects/hanzoai/vfs.md): S3-backed virtual block filesystem with PQ encryption — unlimited write storage for stateful services
- [Zen Dub](https://docs.hanzo.ai/docs/projects/hanzoai/zen-dub.md): Zen Dub - Real-time high-quality lip-sync model

## SDKs — one page per language

- [SDKs](https://docs.hanzo.ai/docs/sdks.md): One generated client per language for the whole /v1 surface, plus the hand-written AI and per-service libraries for TypeScript. What each one is called on its registry, and the same first call in each.
- [@hanzo/app](https://docs.hanzo.ai/docs/sdks/app.md): The Hanzo app as React components. The window with Chat, Dev and Studio, the organization gate, and the workspace apps (Home, Inbox, Contacts, Meet, Calendar, Drive, Board, Work, Bots), mounted by a host under its own router. hanzo.ai draws it for a signed-in reader.
- [AST (AI Structured Training)](https://docs.hanzo.ai/docs/sdks/ast.md): Structured AI training data collection SDK for capturing interactions, feedback, and model outputs.
- [C++](https://docs.hanzo.ai/docs/sdks/cpp.md): A native client over every /v1 service, taken from a tag with CMake. C++17, cpprestsdk, generated from the API's own document.
- [Go](https://docs.hanzo.ai/docs/sdks/go.md): go get github.com/hanzoai/go-sdk/v8 — package hanzoai at the module root, one service per capability, generated from the API's own document.
- [IAM SDK](https://docs.hanzo.ai/docs/sdks/iam.md): TypeScript SDK for Hanzo IAM — authentication, organizations, billing, and React bindings.
- [Java](https://docs.hanzo.ai/docs/sdks/java.md): ai.hanzo:hanzo-java-cloud on Maven Central — the generated client for every /v1 capability, on OkHttp and Gson.
- [Kotlin](https://docs.hanzo.ai/docs/sdks/kotlin.md): ai.hanzo:hanzo-kotlin-cloud — the generated client for every /v1 capability, on OkHttp and Gson. Built from source until it lands on Maven Central.
- [@hanzo/mod](https://docs.hanzo.ai/docs/sdks/mod.md): Five platform look profiles (iOS, Android, macOS, Windows, Linux), theme mods as JSON, and web fonts, written as CSS custom properties on the page's root element and kept in this browser's localStorage. No server, no account sync, no mod loader.
- [Python](https://docs.hanzo.ai/docs/sdks/python.md): hanzoai on PyPI, Python 3.12 or newer, is the whole /v1 surface as hanzoai.cloud, and what the separate hanzo, hanzo-agents and hanzo-mcp distributions are for.
- [Rust](https://docs.hanzo.ai/docs/sdks/rust.md): cargo add hanzo-client — the generated async client for every /v1 capability. The separate hanzo crate is the umbrella over the wider Rust stack.
- [Swift](https://docs.hanzo.ai/docs/sdks/swift.md): The Hanzo package for SwiftPM — async/await, no dependencies, one class per capability. Builds on Apple platforms and Linux.
- [TypeScript](https://docs.hanzo.ai/docs/sdks/typescript.md): Four npm packages, and which one to install — hanzoai for the whole /v1 surface, @hanzo/ai for inference and agents, @hanzo/sdk per service, @hanzo/iam for identity.

## Architecture

- [Architecture](https://docs.hanzo.ai/docs/architecture.md): How Hanzo Cloud is built today, and the plugin-platform direction it is evolving toward.
- [The Platform Algebra](https://docs.hanzo.ai/docs/architecture/algebra.md): The whole cloud is a small set of primitives — Principal, Tenant, Resource, Policy, Ledger, Meter, Schedule, Bus, Gateway, Store, Money — and every product is a composition of them. Declare a schema, attach a policy, and persistence, tenancy, audit, and metering come free.
- [Engineering Philosophy](https://docs.hanzo.ai/docs/architecture/philosophy.md): The principles behind Hanzo V8 — one and one way, decomplect, ZAP-native, the language seam is the wire not FFI, one contract to N SDKs to thin CLIs.
- [Consensus-Backed Plugin Platform](https://docs.hanzo.ai/docs/architecture/plugin-platform.md): The architecture direction for Hanzo Cloud — plugins as the unit of deployment, a small consensus control plane over placement, and ZAP-native authoring. Specified in HIP-0125 (Draft).

## Contributing

- [User Guide](https://docs.hanzo.ai/docs/contributing/authoring-cli.md): The CLI tool that automates setups and installs components.
- [Docs Architecture (ADR)](https://docs.hanzo.ai/docs/contributing/docs-architecture.md): The one and only way Hanzo documentation is sourced, built, and joined into docs.hanzo.ai. Hub-and-spoke over a single unified build.
- [Preview](https://docs.hanzo.ai/docs/contributing/preview.md): A light tool to view Markdown files.
- [Style](https://docs.hanzo.ai/docs/contributing/style.md): How code and prose are written here — one base URL, one key, one way to do a thing — and the traps that keep catching agents working in this repo.

## About Hanzo

- [About Hanzo](https://docs.hanzo.ai/docs/about/company.md): The AI operating system for business. Building business software since 2014. Techstars '17.

## Docs

- [Documentation](https://docs.hanzo.ai/docs.md): The AI operating system for business. Building business software since 2014. Techstars '17. Every model, every tool, one key — in our cloud or on your own machine.

## Authentication

- [Authentication](https://docs.hanzo.ai/docs/api-keys.md): How a request proves who it is — the two Hanzo key types, which one may ship in a browser, and how to create, limit, edit and revoke keys.

## Extensions

- [Integrations & Extensions](https://docs.hanzo.ai/docs/apps.md): Install and connect Hanzo across your browser, editor, desktop, docs, design tools, and business apps — one API key, one identity, everywhere.
- [Browser](https://docs.hanzo.ai/docs/apps/browser.md): Hanzo in Chrome, Edge, Firefox, and Safari — AI chat, page context, and one-click actions on any tab.
- [Business](https://docs.hanzo.ai/docs/apps/business.md): Connect Hanzo to Salesforce, DocuSign, Notion, HubSpot, and Shopify — summarize records, draft content, and act on your business data over OAuth.
- [Comms](https://docs.hanzo.ai/docs/apps/comms.md): Hanzo in Slack, Zoom, Google Meet, Microsoft Teams, and Zendesk — summarize threads and meetings and draft replies in the tools your team already uses.
- [Design](https://docs.hanzo.ai/docs/apps/design.md): Hanzo in Figma and Sketch — generate, rename, and annotate layers and copy from your AI assistant.
- [Desktop](https://docs.hanzo.ai/docs/apps/desktop.md): Two desktop apps — one that runs agents on your own machine against local or remote models, one that puts Hanzo a keystroke away in your menubar — plus Hanzo's tools in Claude Desktop.
- [Dev](https://docs.hanzo.ai/docs/apps/dev.md): The Hanzo GitHub App and GitLab integration — automated PR/MR review, issue triage, and @hanzo mentions in your repos.
- [IDEs & Editors](https://docs.hanzo.ai/docs/apps/ides.md): Hanzo in VS Code, Cursor, Windsurf, Antigravity, JetBrains, and JupyterLab — the same models and tools, over MCP and an OpenAI-compatible endpoint.
- [Docs & Office](https://docs.hanzo.ai/docs/apps/office.md): Hanzo in Word, Excel, PowerPoint, Outlook, Google Workspace, and PDF — draft, summarize, and edit documents in place.
- [Productivity](https://docs.hanzo.ai/docs/apps/productivity.md): Hanzo in Clio and Raycast — AI in your legal practice management and one keystroke away from your command bar.
- [Verticals](https://docs.hanzo.ai/docs/apps/verticals.md): Industry integrations — Epic (healthcare), Procore (construction), and QuickBooks (finance) — connected over their native app models with data kept server-side.

## Hanzo Chat

- [Hanzo Chat](https://docs.hanzo.ai/docs/chat.md): The chat app on Hanzo Cloud — enso and Zen models, MCP tools, agents, file uploads and RAG. Hosted at chat.hanzo.ai, or self-host it.
- [Agents](https://docs.hanzo.ai/docs/chat/agents.md): Create custom AI agents in Hanzo Chat with system prompts, model selection, and MCP tool access.
- [Authentication](https://docs.hanzo.ai/docs/chat/authentication.md): Configure authentication for Hanzo Chat — Hanzo IAM, OAuth2/OIDC, social login, and local auth.
- [Configuration](https://docs.hanzo.ai/docs/chat/configuration.md): Configure Hanzo Chat — models, endpoints, MCP tools, environment variables, and chat.yaml reference.
- [Environment Variables](https://docs.hanzo.ai/docs/chat/environment.md): Complete reference for all Hanzo Chat environment variables — server, database, auth, models, moderation, and more.
- [Features](https://docs.hanzo.ai/docs/chat/features.md): Hanzo Chat features — presets, file uploads, RAG, search, vision, conversation import/export, bookmarks, and more.
- [File Uploads & RAG](https://docs.hanzo.ai/docs/chat/file-uploads.md): Upload files to Hanzo Chat for context-aware responses using Retrieval-Augmented Generation (RAG).
- [Models](https://docs.hanzo.ai/docs/chat/models.md): Which models Hanzo Chat can reach, and how to choose and configure them in chat.yaml.
- [Moderation](https://docs.hanzo.ai/docs/chat/moderation.md): Automated moderation system for Hanzo Chat — rate limiting, violation tracking, and user bans.
- [Plugins](https://docs.hanzo.ai/docs/chat/plugins.md): Hanzo Chat plugin system — built-in plugins, ChatGPT plugins, and custom plugin development.
- [Self-Hosting](https://docs.hanzo.ai/docs/chat/self-hosting.md): Deploy Hanzo Chat with Docker, Kubernetes, or on cloud providers. Full self-hosting guide with production configuration.

## Coding tools

- [Coding agents](https://docs.hanzo.ai/docs/coding.md): Run Hanzo Dev, Claude Code, Codex, Cursor, Gemini CLI, Qwen Code, OpenCode, Goose, Hermes and more from one command, with Enso and Kai a tool call away.

## Core ideas

- [Concepts](https://docs.hanzo.ai/docs/concepts.md): Seven ideas the whole API is built out of — tenancy, projects, sandboxes, agents, budgets, memory and workflows.
- [Agents](https://docs.hanzo.ai/docs/concepts/agents.md): An agent is a definition; a session is a run you can steer and replay. One flow is one tree, and a command is an intent rather than a state change.
- [Budgets](https://docs.hanzo.ai/docs/concepts/budgets.md): An agent is quoted before it spends and refused when it would breach. Four ceilings, integer micro-USD, and a refusal the agent can read while it is still running.
- [Memory](https://docs.hanzo.ai/docs/concepts/memory.md): What an agent remembers and who else can read it — one org-scoped store for the team wiki and agent memory, plus a per-user recall surface.
- [Multitenancy](https://docs.hanzo.ai/docs/concepts/multitenancy.md): The org is the one tenancy boundary. How a credential becomes a tenant at the edge, and why the answer is never re-decided behind it.
- [Projects](https://docs.hanzo.ai/docs/concepts/projects.md): Two different things are called a project — a site you deploy and a scope inside an org. Which one you have decides which API you want.
- [Sandboxes](https://docs.hanzo.ai/docs/concepts/sandboxes.md): The one compute primitive — a lease on a pod that runs somebody else's code. Four classes, two ways to end one, and no pool.
- [Workflows](https://docs.hanzo.ai/docs/concepts/workflows.md): Work that runs itself — on a schedule, on a webhook, or on a canvas. And why an unbounded loop is the thing the design bounds against.

## Console

- [Console](https://docs.hanzo.ai/docs/console.md): The Hanzo Cloud console at platform.hanzo.ai -- manage every product, key, and organization from one app.

## Credits & billing

- [Credits & billing](https://docs.hanzo.ai/docs/credits.md): What a credit is, how a call draws one down, where the balance lives, and what happens when it reaches zero.

## Decisions

- [Decisions](https://docs.hanzo.ai/docs/decisions.md): POST /v1/decisions: typed questions about a state, answered with calibrated distributions instead of generated text. Kai, or Jev through the same wire.
- [Kai Early Access](https://docs.hanzo.ai/docs/decisions/early-access.md): Early access preview for Kai-1.7: unified multimodal decision intelligence across vision, audio, video, code, and text with adaptive reasoning budgets.

## Hanzo Dev

- [Hanzo Dev](https://docs.hanzo.ai/docs/dev.md): AI-powered coding assistant for your terminal. Install, configure, and operate Hanzo Dev.
- [Architecture](https://docs.hanzo.ai/docs/dev/architecture.md): System design and component overview for Hanzo Dev.
- [Agent Mesh Architecture](https://docs.hanzo.ai/docs/dev/architecture/agent-mesh.md): ZAP + RNS + Consensus + x402 — high performance mesh collective intelligence for multi-agent coordination.
- [Configuration](https://docs.hanzo.ai/docs/dev/configuration.md): Configure Hanzo Dev with config.toml, environment variables, and CLI flags.
- [Example Configuration](https://docs.hanzo.ai/docs/dev/configuration/example-config.md): Annotated sample config.toml for Hanzo Dev.
- [Platform Sandboxing](https://docs.hanzo.ai/docs/dev/configuration/platform-sandboxing.md): OS-specific sandboxing mechanisms in Hanzo Dev.
- [Sandboxing](https://docs.hanzo.ai/docs/dev/configuration/sandbox.md): How Hanzo Dev sandboxes command execution for safety.
- [Contributing](https://docs.hanzo.ai/docs/dev/contributing.md): Guidelines for contributing to Hanzo Dev.
- [Contributor License Agreement](https://docs.hanzo.ai/docs/dev/contributing/cla.md): CLA requirements for contributing to Hanzo Dev.
- [FAQ](https://docs.hanzo.ai/docs/dev/faq.md): Frequently asked questions about Hanzo Dev.
- [Getting Started](https://docs.hanzo.ai/docs/dev/getting-started.md): Get up and running with Hanzo Dev in minutes.
- [Authentication](https://docs.hanzo.ai/docs/dev/getting-started/authentication.md): Sign Hanzo Dev in to the Hanzo cloud.
- [Homebrew](https://docs.hanzo.ai/docs/dev/getting-started/homebrew.md): Install Hanzo Dev via Homebrew on macOS.
- [Installation](https://docs.hanzo.ai/docs/dev/getting-started/install.md): Install Hanzo Dev from npm, Homebrew, or build from source.
- [Integrations](https://docs.hanzo.ai/docs/dev/integrations.md): Connect Hanzo Dev with your favorite editors and tools.
- [Agent Platform (Local + Cloud)](https://docs.hanzo.ai/docs/dev/integrations/agent-platform.md): Unify Hanzo Dev local sessions with Agent Base and Agent Field cloud tracking.
- [GitHub Copilot](https://docs.hanzo.ai/docs/dev/integrations/copilot.md): GitHub Copilot CLI integration for AI-powered code assistance.
- [Zed Integration](https://docs.hanzo.ai/docs/dev/integrations/zed.md): Use Hanzo Dev as an external agent in the Zed editor via ACP.
- [Reference](https://docs.hanzo.ai/docs/dev/reference.md): Complete command-line reference for Hanzo Dev.
- [CLI Reference](https://docs.hanzo.ai/docs/dev/reference/cli.md): Complete command-line reference for the dev CLI tool.
- [Usage](https://docs.hanzo.ai/docs/dev/usage.md): Learn how to use Hanzo Dev for interactive and non-interactive AI-powered development.
- [Advanced Usage](https://docs.hanzo.ai/docs/dev/usage/advanced.md): CI/CD integration, MCP configuration, verbose logging, and advanced workflows.
- [Agents & Subagents](https://docs.hanzo.ai/docs/dev/usage/agents.md): Configure and orchestrate external CLI agents and multi-agent workflows.
- [Auto Drive](https://docs.hanzo.ai/docs/dev/usage/auto-drive.md): Fully automated multi-turn task execution in Hanzo Dev.
- [Non-Interactive Mode](https://docs.hanzo.ai/docs/dev/usage/exec.md): Run Hanzo Dev headless for single tasks and CI/CD pipelines.
- [Execution Policy](https://docs.hanzo.ai/docs/dev/usage/execpolicy.md): Control how Hanzo Dev executes commands with execution policy rules.
- [JavaScript REPL](https://docs.hanzo.ai/docs/dev/usage/js-repl.md): Run JavaScript in a persistent Node-backed kernel with top-level await.
- [Custom Prompts](https://docs.hanzo.ai/docs/dev/usage/prompts.md): Create and manage custom prompt snippets in Hanzo Dev.
- [Settings](https://docs.hanzo.ai/docs/dev/usage/settings.md): Full-screen TUI settings panel for model, theme, agents, and more.
- [Skills](https://docs.hanzo.ai/docs/dev/usage/skills.md): Extend Hanzo Dev with reusable skill bundles.
- [Slash Commands](https://docs.hanzo.ai/docs/dev/usage/slash-commands.md): All built-in slash commands available in the Hanzo Dev TUI.
- [Dev on hanzo.ai](https://docs.hanzo.ai/docs/dev/web.md): Hanzo Dev in the browser — runs, templates, projects, your own machines, and what is paid.

## Environments

- [Environments](https://docs.hanzo.ai/docs/environments.md): An environment is derived from the apps that point at it — there is nothing to create. How production, staging and previews actually work.

## Error codes

- [Error codes](https://docs.hanzo.ai/docs/errors.md): Every error code Hanzo Index can return, with its HTTP status and type. The `link` in an error body points here.

## Events

- [Events](https://docs.hanzo.ai/docs/events.md): One ingest endpoint that dispatches on the shape of the body, what each credential may write, and the receipt every wire gets back.

## Extend

- [Extend](https://docs.hanzo.ai/docs/extend.md): Add a tool to Hanzo three ways — a Go provider inside the fleet, your own MCP server, or an auto connector. The contract all three land on, and how to choose.

## Build a game

- [Build a game](https://docs.hanzo.ai/docs/games.md): The shortest path from nothing to something you can play — in the browser, from your terminal, or against the raw API.

## Glossary

- [Glossary](https://docs.hanzo.ai/docs/glossary.md): One name per idea, and the names other systems use for the same idea. Read the second column when a word here does not match the word you arrived with.

## Guides

- [Guides](https://docs.hanzo.ai/docs/guides.md): One task per page, each written four ways: a CLI command, an SDK call, an HTTP request and an MCP tool.
- [Agent](https://docs.hanzo.ai/docs/guides/agent.md): Create an agent, run it, read the run back.
- [Chat](https://docs.hanzo.ai/docs/guides/chat.md): One completion.
- [Coding tools](https://docs.hanzo.ai/docs/guides/coding.md): Run Claude Code, Codex, Cursor, Gemini CLI, Qwen Code, OpenCode, Goose, Hermes and every other major coding agent from the Hanzo CLI, hand work to Enso and Kai, and see what each session used.
- [More agents](https://docs.hanzo.ai/docs/guides/coding/agents.md): Gemini CLI, Qwen Code, OpenCode, Kilo Code, Crush, Pi, GitHub Copilot CLI, Amp, Grok Build, Goose, Aider, Hermes Agent, OpenHands, Open Interpreter, Cline, Continue, Kimi Code, Oh My Pi, Letta Code and Kode from `hanzo --<agent>`: how each takes the Hanzo toolset and Hanzo's models.
- [Antigravity](https://docs.hanzo.ai/docs/guides/coding/antigravity.md): What `hanzo --agy` does for the Antigravity CLI: it starts it and links the session, and routes and meters nothing.
- [Claude Code](https://docs.hanzo.ai/docs/guides/coding/claude-code.md): Run Claude Code with `hanzo --claude`: on your Claude plan with the Hanzo toolset beside it, or fully on Hanzo with `--cloud`.
- [Codex](https://docs.hanzo.ai/docs/guides/coding/codex.md): Run Codex with `hanzo --codex`: on your ChatGPT plan with the Hanzo toolset beside it, or fully on Hanzo with `--cloud`.
- [Cursor](https://docs.hanzo.ai/docs/guides/coding/cursor.md): What `hanzo --cursor` does for Cursor's agent CLI: it starts it and links the session, and routes and meters nothing.
- [Desktop apps and editors](https://docs.hanzo.ai/docs/guides/coding/desktop.md): Give Claude Desktop, Cursor, VS Code, Windsurf, Zed, JetBrains and the Codex and Claude Code apps the Hanzo toolset, and run their models on your Hanzo plan.
- [Cookbook](https://docs.hanzo.ai/docs/guides/cookbook.md): Four recipes that put Enso, Kai and Zen in one loop: route a request, triage with typed answers, gate an agent's command, and drive an agent from programs instead of prompts.
- [Enterprise Blueprints & Production Archetypes](https://docs.hanzo.ai/docs/guides/cookbook/blueprints.md): Production AI architecture blueprints across retail availability, supply chain logistics, asset protection, and autonomous DevOps grounded in white papers, research posts, and OSS code.
- [Gate an agent's command](https://docs.hanzo.ai/docs/guides/cookbook/gate.md): Before an agent runs a shell command, ask Kai allow, ask or deny under a program's thresholds, then join the answer with your own policy by mode.
- [Drive an agent loop](https://docs.hanzo.ai/docs/guides/cookbook/loop.md): An agent's control flow as Decision Programs: preflight picks the model, Zen does the work, a completion check decides whether to stop. Prompts only where text is the output.
- [Modular Decision Recipes](https://docs.hanzo.ai/docs/guides/cookbook/recipes.md): Production-grade, composable decision blueprints in Rust and TypeScript for Hanzo Kai: retail triage, industrial diagnostics, confidence routing, and agent gates.
- [Route with Enso](https://docs.hanzo.ai/docs/guides/cookbook/route.md): Send model auto, cap the price of each call, read which model answered, and tell the router how it went.
- [Triage with Kai, reply with Zen](https://docs.hanzo.ai/docs/guides/cookbook/triage.md): Route a support ticket with three typed decisions and no generated tokens, act only on the answers the model stands behind, then let Zen write the reply.
- [Hello](https://docs.hanzo.ai/docs/guides/hello.md): Identity — prove the key works and print who it belongs to.
- [Integrations](https://docs.hanzo.ai/docs/guides/integrations.md): Point any agent framework at Hanzo. One host, one key, two lines — and the exact parameter name for each of sixteen frameworks.
- [Agno](https://docs.hanzo.ai/docs/guides/integrations/agno.md): OpenAILike takes base_url. A sibling class reaches the responses shape on the same parameter.
- [AutoGen](https://docs.hanzo.ai/docs/guides/integrations/autogen.md): OpenAIChatCompletionClient takes base_url, and model_info alongside it whenever the model name is not one OpenAI serves.
- [Claude Agent SDK](https://docs.hanzo.ai/docs/guides/integrations/claude-agent-sdk.md): The one framework on the Anthropic shape, and the one that wants the bare host — ANTHROPIC_BASE_URL takes no /v1.
- [Cloudflare Agents](https://docs.hanzo.ai/docs/guides/integrations/cloudflare-agents.md): No base-URL parameter of its own — instantiate the openai client inside the Agent and set baseURL on it.
- [CrewAI](https://docs.hanzo.ai/docs/guides/integrations/crewai.md): LLM takes base_url. custom_openai=True is what lets you name a model id CrewAI does not recognise.
- [DSPy](https://docs.hanzo.ai/docs/guides/integrations/dspy.md): dspy.LM takes api_base through kwargs, forwarded to LiteLLM. Name the model in provider/name form.
- [Google ADK](https://docs.hanzo.ai/docs/guides/integrations/google-adk.md): ADK reaches an OpenAI-compatible endpoint through LiteLlm, whose parameter is api_base — not base_url.
- [LangGraph](https://docs.hanzo.ai/docs/guides/integrations/langgraph.md): The base URL goes on the model, not the agent. ChatOpenAI takes base_url; hand the instance to create_agent.
- [Letta](https://docs.hanzo.ai/docs/guides/integrations/letta.md): A configuration flow, not a constructor. Add an OpenAI-compatible provider through /connect, then pick the model.
- [LlamaIndex](https://docs.hanzo.ai/docs/guides/integrations/llamaindex.md): OpenAILike takes api_base — not base_url — and needs is_chat_model set, because it defaults to the completions endpoint.
- [Mastra](https://docs.hanzo.ai/docs/guides/integrations/mastra.md): No provider factory. The base URL is the url field of the agent's model object, beside a routing id.
- [OpenAI Agents SDK](https://docs.hanzo.ai/docs/guides/integrations/openai-agents.md): base_url goes on an AsyncOpenAI client. The SDK defaults to Responses, so choose the endpoint deliberately.
- [Pydantic AI](https://docs.hanzo.ai/docs/guides/integrations/pydantic-ai.md): OpenAIProvider takes base_url. Which model class you pick decides whether you land on chat completions or responses.
- [Semantic Kernel](https://docs.hanzo.ai/docs/guides/integrations/semantic-kernel.md): .NET takes endpoint as a Uri behind an experimental pragma. Python has no such parameter — hand it an AsyncOpenAI client.
- [smolagents](https://docs.hanzo.ai/docs/guides/integrations/smolagents.md): OpenAIModel takes api_base. The class is OpenAIModel — OpenAIServerModel is gone from the reference.
- [Vercel AI SDK](https://docs.hanzo.ai/docs/guides/integrations/vercel-ai-sdk.md): createOpenAICompatible takes baseURL. Two other providers on the same parameter reach the responses and messages shapes.
- [Migrate](https://docs.hanzo.ai/docs/guides/migrate.md): 45 vendors and tools, each mapped to the Hanzo capability that answers it — how to start, nouns, the call before and after, and what does not carry.
- [AgentMail](https://docs.hanzo.ai/docs/guides/migrate/agentmail.md): AgentMail gives an agent its own mailbox. Here /v1/notify sends and /v1/channel carries the conversation — but there is no mailbox, so read the last section first.
- [Algolia](https://docs.hanzo.ai/docs/guides/migrate/algolia.md): Algolia hosts search indexes and ranks documents against a query. Here that is /v1/index (17 operations), which speaks the Meilisearch dialect, plus /v1/search (1) when a lexical index and a vector leg should answer as one ranking.
- [Anthropic](https://docs.hanzo.ai/docs/guides/migrate/anthropic.md): The Anthropic Messages API is served at POST /v1/messages: point the SDK or Claude Code at api.hanzo.ai with a Hanzo key as the bearer, and name a model as anthropic/claude-* or any other model in the catalogue.
- [Auth0](https://docs.hanzo.ai/docs/guides/migrate/auth0.md): Auth0 is the identity provider your app redirects to. Here that is /v1/iam — 159 operations, OIDC end to end, and the org is a first-class noun rather than an add-on.
- [Carta](https://docs.hanzo.ai/docs/guides/migrate/carta.md): Carta keeps who owns what in a company. Here that is /v1/captable — 31 operations over stakeholders, share classes, SAFEs, options and rounds, with the summary derived rather than stored.
- [Centaur](https://docs.hanzo.ai/docs/guides/migrate/centaur.md): Centaur gives a Slack thread a Kubernetes pod, a coding harness and a credential proxy. Here that is /v1/channel, /v1/agent, /v1/sandbox and /v1/provider on one origin — with a kernel boundary Centaur leaves off by default.
- [Clerk](https://docs.hanzo.ai/docs/guides/migrate/clerk.md): Clerk is the drop-in auth layer for a React app — components, users, orgs, sessions, JWT. Here that is /v1/iam — 159 operations, OIDC end to end, and the org is the owner half of every address rather than a claim your frontend switches into.
- [Coding agents](https://docs.hanzo.ai/docs/guides/migrate/coding-agents.md): Keep the coding agent you use. Run it with `hanzo --<agent>`: it hands work to Enso and Kai through the Hanzo toolset, and `--cloud` moves its model calls onto your Hanzo plan.
- [Composio](https://docs.hanzo.ai/docs/guides/migrate/composio.md): Composio gives an agent authenticated tools across third-party apps. Here that is /v1/provider for the org's credential, /v1/connection for a user's own, and /v1/tool for the actions they reach.
- [Datadog](https://docs.hanzo.ai/docs/guides/migrate/datadog.md): Datadog collects metrics, traces and logs from one agent and gives each signal its own search API. Here that is /v1/o11y — 381 operations behind one query endpoint — with /v1/event (12) for the browser and /v1/metrics (11) for an in-process store.
- [DocuSign](https://docs.hanzo.ai/docs/guides/migrate/docusign.md): DocuSign collects legally binding signatures on a document. Here that is /v1/esign — 13 operations, a signing link that carries its own token, and an audit trail you can read.
- [Doppler](https://docs.hanzo.ai/docs/guides/migrate/doppler.md): Doppler holds an organisation's secrets and hands them to services. Here that is /v1/kms — five operations, sealed at rest, scoped to the org in your key.
- [E2B](https://docs.hanzo.ai/docs/guides/migrate/e2b.md): E2B leases isolated sandboxes for code an agent wrote. Here that is /v1/sandbox, with /v1/exec for the one-shot snippet case.
- [ElevenLabs](https://docs.hanzo.ai/docs/guides/migrate/elevenlabs.md): ElevenLabs synthesizes speech and transcribes it back. Here that is /v1/audio — five operations, OpenAI-shaped for speech and transcription.
- [Firebase](https://docs.hanzo.ai/docs/guides/migrate/firebase.md): Firebase is six products behind one project id — sign-in is /v1/iam (159 operations), the data is /v1/kv (6) and /v1/provisioning (28), files are /v1/s3 (6), code is /v1/function (11), hosting is /v1/projects (27), and the project id stops being something you carry.
- [Fly.io](https://docs.hanzo.ai/docs/guides/migrate/fly.md): Fly runs Firecracker machines under an app namespace, in regions you name. Here that is /v1/platform (37 operations) for an app that deploys and rolls back, and /v1/compute (34) for a machine placed in a region — with the tenant coming from your key rather than an org_slug field.
- [Google Gemini](https://docs.hanzo.ai/docs/guides/migrate/gemini.md): Gemini models are in the catalogue as google/gemini-*, served on the OpenAI-compatible routes at api.hanzo.ai/v1. Gemini's own generateContent wire is not served.
- [GoDaddy](https://docs.hanzo.ai/docs/guides/migrate/godaddy.md): GoDaddy sells and holds domains. Here that is /v1/domain — seven operations covering availability, search, purchase, renewal and transfer.
- [Grafana](https://docs.hanzo.ai/docs/guides/migrate/grafana.md): Grafana renders dashboards and alerts over Mimir, Loki and Tempo. Here that is /v1/o11y — 381 operations over one store, so a panel that crosses metrics, logs and traces is one query instead of three datasources.
- [Heroku](https://docs.hanzo.ai/docs/guides/migrate/heroku.md): Heroku builds a repo into a slug and runs it as dynos. Here that is /v1/platform — 37 operations from app create through build, promote and rollback — with the add-ons split out into /v1/provisioning (28).
- [Jev](https://docs.hanzo.ai/docs/guides/migrate/jev.md): Jev answers typed questions through OpenRouter's Decisions API. Here that is POST /v1/decisions with model kai: the same request body at a new base URL with a Hanzo key, billed $0.021 per million input tokens against Jev's $0.042.
- [Lago](https://docs.hanzo.ai/docs/guides/migrate/lago.md): Lago meters usage and turns it into invoices. Here /v1/billing raises and collects the invoice, /v1/usage takes the samples, and /v1/pricing is the rate card.
- [LangSmith](https://docs.hanzo.ai/docs/guides/migrate/langsmith.md): LangSmith records what an LLM app did and grades it against datasets. Here that is /v1/o11y (381) for the traces, scores and review queues, /v1/eval (16) for the datasets and runs, and /v1/prompt (6) for the library.
- [LaunchDarkly](https://docs.hanzo.ai/docs/guides/migrate/launchdarkly.md): LaunchDarkly decides which users see which behaviour. Here that is /v1/flag — eight operations, one deterministic decision, and no SDK that has to be kept warm.
- [Modal](https://docs.hanzo.ai/docs/guides/migrate/modal.md): Modal deploys Python functions onto GPUs and calls them from a client. Here that is /v1/function (11 operations) for the function, /v1/sandbox (19) for a sandbox and /v1/compute (34) for the accelerators underneath — with the tenant coming from your key rather than a workspace.
- [NVIDIA NeMo](https://docs.hanzo.ai/docs/guides/migrate/nemo.md): NeMo is a suite of libraries and microservices for the model and agent lifecycle. The served parts map to /v1/ai (272) for Nemotron and NIM, /v1/o11y (381) for Relay's telemetry, /v1/eval (16) and /v1/benchmark (9) for Evaluator, and /v1/agent (37) for the Agent Toolkit; the data and training libraries keep running, pointed at the same host.
- [Netlify](https://docs.hanzo.ai/docs/guides/migrate/netlify.md): Netlify serves a built directory, runs functions beside it, collects form posts and signs visitors in. Here that is /v1/projects (27) for the site, /v1/function (11) for the code and /v1/iam (159) for the people — and a deploy is one call, because the bytes never pass through the API.
- [Okta](https://docs.hanzo.ai/docs/guides/migrate/okta.md): Okta signs a workforce in, provisions it, challenges it and gates it with policy. Here that is /v1/iam — 159 operations covering OIDC, SAML, SCIM and MFA — plus /v1/authz/check for the decision.
- [OpenAI](https://docs.hanzo.ai/docs/guides/migrate/openai.md): OpenAI serves models and the platform grown around them. Here that is /v1/ai (272 operations) for the models, their files and their routing, and /v1/agent (37) for the assistant that runs, with the OpenAI-shaped inference routes at the addresses your client already calls.
- [OpenRouter](https://docs.hanzo.ai/docs/guides/migrate/openrouter.md): OpenRouter's OpenAI-compatible API maps onto api.hanzo.ai/v1 with the same provider/model names: a base URL and a key, and Enso when you want the router to pick.
- [Pinecone](https://docs.hanzo.ai/docs/guides/migrate/pinecone.md): Pinecone is a managed vector database with a control plane, a per-index data host and a namespace on every call; here that is /v1/ai (272) for the vectors and the ingest path, /v1/index (17) for the lexical half, and one hostname with the tenant taken from the key.
- [PlanetScale](https://docs.hanzo.ai/docs/guides/migrate/planetscale.md): PlanetScale runs a managed database with schema branches and deploy requests. Here the database is /v1/provisioning (28) and the branch, the review and the deploy are /v1/git (44), where the migration already lives.
- [PostHog](https://docs.hanzo.ai/docs/guides/migrate/posthog.md): PostHog is product analytics, feature flags, experiments and session replay behind one SDK. Here that is /v1/event (12), /v1/flag (8) and /v1/experiment (7) — the same wire on all three, with the tenant taken from the key rather than an api_key field.
- [Render](https://docs.hanzo.ai/docs/guides/migrate/render.md): Render builds a repo, runs the result, and provisions a database beside it. Here that is /v1/platform (37) for the app, /v1/provisioning (28) for Postgres and Key Value, /v1/projects (27) for a static site and /v1/tasks (5) for cron.
- [Replicate](https://docs.hanzo.ai/docs/guides/migrate/replicate.md): Replicate runs containerised models behind one API and lets you push your own. Here that is /v1/ml (7 operations) — deploy a model under a name, then call it — with /v1/ai (272) for the hosted models and the training that produces them.
- [Sentry](https://docs.hanzo.ai/docs/guides/migrate/sentry.md): Sentry catches an exception off a running application and groups it into an issue. Here that is /v1/o11y (381 operations) to read and /v1/event (12) to ingest, and the ingest speaks Sentry's own wire.
- [Amazon SQS](https://docs.hanzo.ai/docs/guides/migrate/sqs.md): SQS is a queue between services. Here that is /v1/mq for durable streams and consumers, and /v1/pubsub for the publish itself.
- [Stripe](https://docs.hanzo.ai/docs/guides/migrate/stripe.md): Stripe takes payments and bills for them. Here that is /v1/commerce (181 operations) for taking the money and /v1/billing (45) for what is owed and what is left, with the payer resolved from the key instead of carried as a customer id.
- [Supabase](https://docs.hanzo.ai/docs/guides/migrate/supabase.md): Supabase is one Postgres instance with auth, storage, realtime, functions and vectors bolted to it. Here those are separate capabilities behind one host — /v1/iam (159 operations) signs people in, /v1/provisioning (28) mints the database, and /v1/function (11), /v1/s3 (6), /v1/mq (15) and /v1/index (17) do the rest.
- [Tavily](https://docs.hanzo.ai/docs/guides/migrate/tavily.md): Tavily searches the live web and pulls pages back as text for agents. Here that is /v1/websearch for the search and /v1/crawl for the page.
- [Temporal](https://docs.hanzo.ai/docs/guides/migrate/temporal.md): Temporal runs durable workflows as your own code against workers you operate. Here that is /v1/auto — 17 operations covering flows, versions, durable runs, schedules and signals — and there is no worker to deploy.
- [Twilio](https://docs.hanzo.ai/docs/guides/migrate/twilio.md): Twilio holds phone numbers and moves messages over them. Three capabilities answer it — /v1/tel for the carrier, /v1/notify for transactional delivery, /v1/channel for chat.
- [Upstash](https://docs.hanzo.ai/docs/guides/migrate/upstash.md): Upstash sells Redis, Kafka, QStash and Vector as four products behind four hostnames and ten credential values; here that is /v1/kv (6), /v1/mq (15), /v1/webhook (8) and /v1/index (17) on one hostname with one bearer.
- [HashiCorp Vault](https://docs.hanzo.ai/docs/guides/migrate/vault.md): Vault stores secrets, mints credentials and decides who may read them. Here that is three capabilities — /v1/kms (5) holds the secret, /v1/iam (159) and /v1/authz (3) hold the identity and the decision — and none of them has a mount table.
- [Vercel](https://docs.hanzo.ai/docs/guides/migrate/vercel.md): Vercel builds a repo and serves the result. Here that is two capabilities — /v1/platform (37) builds and runs an app, /v1/projects (27) serves a static export — and which one you want depends on whether your output needs a server.
- [WorkOS](https://docs.hanzo.ai/docs/guides/migrate/workos.md): WorkOS sells enterprise readiness as four products — SSO, SCIM, audit logs, an admin portal — wired to one organization. Here they are one capability, /v1/iam (159 operations), addressing one user record.
- [Money](https://docs.hanzo.ai/docs/guides/money.md): Balance, then the usage that moved it.
- [Store](https://docs.hanzo.ai/docs/guides/store.md): KV round-trip — create a store, read it back, delete it.
- [Tools](https://docs.hanzo.ai/docs/guides/tools.md): List the MCP tools this key can reach.

## MCP

- [MCP](https://docs.hanzo.ai/docs/mcp.md): The unified Hanzo MCP — one server that gives Claude Code, Cursor, and any MCP client a single tool surface plus your connected cloud services.

## Models

- [Models](https://docs.hanzo.ai/docs/models.md): Enso routes, Kai decides, Zen reasons, Policy governs — the model families, what each is for, and the live catalogue with every id you can pass.
- [Creative AI](https://docs.hanzo.ai/docs/models/creative.md): Hanzo Creative AI: proprietary generative media checkpoints (Koma, Iro, Mori, Oto, Koe, Uta) built upon open foundations (ZenLM), served via Hanzo Cloud inference and Hanzo Studio.
- [Enso](https://docs.hanzo.ai/docs/models/enso.md): Enso is Hanzo's own model family: a free lane, and three paid tiers that each run a chain of frontier models under one id and one price. Which tier for which job, what it costs, and what answers it.
- [Kai](https://docs.hanzo.ai/docs/models/kai.md): Kai decides: Hanzo's decision model, answering typed questions with calibrated distributions at POST /v1/decisions, composed into Decision Programs that policy governs.
- [Zen](https://docs.hanzo.ai/docs/models/zen.md): Zen is the open-weight model family from Zoo Labs Foundation, for two jobs: agentic coding that runs on your own machine, and marketing work — campaign copy in your brand's voice and the images and speech that go with it.

## The Network

- [The Network](https://docs.hanzo.ai/docs/network.md): The AI cloud you can run yourself. hanzo.network is hanzod nodes that spawn the same unified cloud binary we run in production — OSS AI cloud in one binary, BYO GPU or K8s, mine on any device, free for public and open-source workloads.

## Pricing

- [Pricing](https://docs.hanzo.ai/docs/pricing.md): What a request costs — the Enso tiers, per-token billing for every other model, and the per-call rates for tools, images and audio.

## Proof of AI

- [Proof of AI](https://docs.hanzo.ai/docs/proof-of-ai.md): How Hanzo verifies AI computation on-chain, how node operators get paid, and how the cloud pays the open-source developers it runs on.
- [Node Operator Guide](https://docs.hanzo.ai/docs/proof-of-ai/node-operator.md): Run Hanzo Node, advertise capabilities, receive work, and get paid — plus the trust and TEE attestation requirements, with an honest line between what works today and what is roadmap.
- [Open-Source Payouts](https://docs.hanzo.ai/docs/proof-of-ai/oss-payouts.md): How Hanzo Cloud attributes usage to the open-source packages it runs and pays their authors — the 25% commitment, the attribution pipeline, and how to participate, with an honest line between live and roadmap.

## Quickstart

- [Quickstart](https://docs.hanzo.ai/docs/quickstart.md): Install the CLI, log in, and make your first call — then see that same call as an SDK method, raw HTTP and an MCP tool.

## Referral & Affiliate Program

- [Referral & Affiliate Program](https://docs.hanzo.ai/docs/referrals.md): Earn 15% recurring revenue share for 12 months while giving referred builders $20 in free cloud credits.

## Run your org

- [Run your org](https://docs.hanzo.ai/docs/run-your-org.md): From signup to a running brain, team, and bot for your organization — under ten minutes.

## Self-improvement

- [Self-improvement](https://docs.hanzo.ai/docs/self-improvement.md): How everyday use can improve Hanzo's memory, skills, tools, connectors, apps and agent harness through a continuous, validated feedback loop.

## Startups

- [Startups](https://docs.hanzo.ai/docs/startups.md): Up to $150,000 in Hanzo Cloud credits for venture-backed startups -- plus $5 free for everyone and bring-your-own-compute.

## Hanzo Studio

- [Hanzo Studio](https://docs.hanzo.ai/docs/studio.md): Visual AI engine for building image, video, 3D, and audio workflows. Node-based editor with GPU scaling, multi-tenant isolation, and enterprise billing.
- [Getting Started](https://docs.hanzo.ai/docs/studio/getting-started.md): Run Hanzo Studio locally, submit your first prompt, and scale to GPU.

## Templates

- [Templates](https://docs.hanzo.ai/docs/templates.md): Deploy verified full-stack applications, AI pipelines, and sovereign infrastructure in one click.
- [Template Kickbacks (25% OSS Revshare)](https://docs.hanzo.ai/docs/templates/kickbacks.md): Earn ongoing revenue share on every deployment of your open-source template on Hanzo Cloud.

## Testnet and devnet

- [Testnet and devnet](https://docs.hanzo.ai/docs/testnet.md): Two copies of the Hanzo cloud that take only Square sandbox cards. Testnet runs exactly what production runs; devnet runs what is being built next, with accounts of its own.

## Usage

- [Usage](https://docs.hanzo.ai/docs/usage.md): One usage plane for every AI account you have — rate limits, credits, and spend, across Hanzo and the other providers you already pay for.
- [Console onboarding](https://docs.hanzo.ai/docs/usage/console.md): Connect your AI accounts at platform.hanzo.ai and read the unified usage dashboard.
- [Quickstart](https://docs.hanzo.ai/docs/usage/quickstart.md): Install @hanzo/usage and read unified AI usage in ~15 lines of TypeScript.
- [Smart routing](https://docs.hanzo.ai/docs/usage/routing.md): Send model "auto" to api.hanzo.ai and each prompt is routed to the model that fits the task and your SLO — for up to 90% lower AI spend.
- [Teams & orgs](https://docs.hanzo.ai/docs/usage/teams.md): Share verified logins org-wide, route AI usage through Hanzo, and get per-member analytics.

## Webhooks

- [Webhooks](https://docs.hanzo.ai/docs/webhooks.md): Register an https endpoint, pick events by subject wildcard, and verify the HMAC signature on every delivery.

## Workspace

- [Workspace](https://docs.hanzo.ai/docs/workspace.md): Build sheet for the Hanzo workspace — layout, dimensions, and the Slack part each piece answers to.

## Hanzo ZAP

- [ZAP Protocol](https://docs.hanzo.ai/docs/zap.md): Zero-Copy App Proto — High-performance Cap'n Proto RPC for AI agent communication. 10-100x faster than MCP with post-quantum security.
- [Advanced Topics](https://docs.hanzo.ai/docs/zap/advanced.md): Post-quantum cryptography, consensus, identity, and blockchain integration
- [Agent Consensus](https://docs.hanzo.ai/docs/zap/advanced/agent-consensus.md): Voting-based response aggregation for multi-agent systems
- [Corona Consensus](https://docs.hanzo.ai/docs/zap/advanced/corona.md): Threshold lattice-based signing for distributed agents
- [W3C DID Support](https://docs.hanzo.ai/docs/zap/advanced/did.md): Decentralized identity integration in ZAP
- [Lux Integration](https://docs.hanzo.ai/docs/zap/advanced/lux.md): Blockchain anchoring and staking on Lux Network
- [Post-Quantum Cryptography](https://docs.hanzo.ai/docs/zap/advanced/post-quantum.md): ML-KEM, ML-DSA, and hybrid key exchange in ZAP
- [Language Bindings](https://docs.hanzo.ai/docs/zap/bindings.md): ZAP SDK documentation for all supported languages
- [C](https://docs.hanzo.ai/docs/zap/bindings/c.md): ZAP C SDK - Minimal C API for embedded systems
- [C++](https://docs.hanzo.ai/docs/zap/bindings/cpp.md): ZAP C++ SDK - High-performance native binding
- [C#](https://docs.hanzo.ai/docs/zap/bindings/csharp.md): ZAP C# SDK - .NET binding with async support
- [Erlang](https://docs.hanzo.ai/docs/zap/bindings/erlang.md): ZAP Erlang SDK - OTP-compatible binding
- [Go](https://docs.hanzo.ai/docs/zap/bindings/go.md): ZAP Go SDK - Idiomatic Go binding
- [Haskell](https://docs.hanzo.ai/docs/zap/bindings/haskell.md): ZAP Haskell SDK - Pure functional binding
- [Java](https://docs.hanzo.ai/docs/zap/bindings/java.md): ZAP Java SDK - JVM binding with Netty transport
- [JavaScript](https://docs.hanzo.ai/docs/zap/bindings/javascript.md): ZAP JavaScript SDK - Node.js and browser support
- [OCaml](https://docs.hanzo.ai/docs/zap/bindings/ocaml.md): ZAP OCaml SDK - Functional binding with Lwt
- [Python](https://docs.hanzo.ai/docs/zap/bindings/python.md): ZAP Python SDK - Async/await API
- [Rust](https://docs.hanzo.ai/docs/zap/bindings/rust.md): ZAP Rust SDK - Reference implementation
- [Getting Started](https://docs.hanzo.ai/docs/zap/getting-started.md): Install ZAP and build your first AI agent
- [Overview](https://docs.hanzo.ai/docs/zap/overview.md): Understanding ZAP architecture and core concepts
- [Architecture](https://docs.hanzo.ai/docs/zap/overview/architecture.md): ZAP system architecture and component design
- [ZAP vs MCP](https://docs.hanzo.ai/docs/zap/overview/comparison.md): Detailed comparison between ZAP and Model Context Protocol
- [Protocol Specification](https://docs.hanzo.ai/docs/zap/protocol.md): ZAP wire format, encoding, and RPC semantics
- [The Local Router](https://docs.hanzo.ai/docs/zap/router.md): One ZAP router per user, embedded in every process that speaks ZAP — no daemon
- [Schema Language](https://docs.hanzo.ai/docs/zap/schema.md): Cap'n Proto schema reference for ZAP

## Site

- [Hanzo Docs](https://docs.hanzo.ai/index.md): the front page.
- [API reference](https://docs.hanzo.ai/reference.md): where the OpenAPI document is, and the same reference as pages.
- [Blog](https://docs.hanzo.ai/blog.md)
- [arcalabs: Assembly-Level Securities Engineering](https://docs.hanzo.ai/blog/arcalabs-security-tokens.md)
- [Crowdstart: The Commerce Infrastructure We Needed](https://docs.hanzo.ai/blog/crowdstart-founding.md)
- [Building the First Crypto Hedge Fund Infrastructure](https://docs.hanzo.ai/blog/first-crypto-hedge-fund.md)
- [Hanzo Cloud: Managed Infrastructure for Commerce](https://docs.hanzo.ai/blog/hanzo-cloud.md)
- [Introducing Hanzo Console: Unified LLM Observability](https://docs.hanzo.ai/blog/hanzo-console.md)
- [Original Lattice Cryptography: Our FHE From Scratch](https://docs.hanzo.ai/blog/lattice-crypto.md)
- [The Operating System for Sovereign Apps](https://docs.hanzo.ai/blog/sovereign-apps.md)
- [Techstars '17: What I Actually Learned](https://docs.hanzo.ai/blog/techstars-17.md)
- [First Tokenized US Treasuries: What We Built at Arca](https://docs.hanzo.ai/blog/tokenized-treasuries.md)
- [Welcome to Hanzo Docs](https://docs.hanzo.ai/blog/welcome.md)