# Hanzo

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

- [Capabilities](/docs/openapi): Every Hanzo capability — 124 of them, 2271 operations, generated from the OpenAPI document.
- [Account](/docs/openapi/account): Your own account: API keys you mint and revoke, and org onboarding.
- [Delete keys](/docs/openapi/account/delete-account-keys): Revokes the caller's own API key of the requested class.
- [List appearance](/docs/openapi/account/get-account-appearance): 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…
- [Get avatar](/docs/openapi/account/get-account-avatar-by-org-by-user-by-digest): Streams a profile photo's raw BYTES. This is the address stored on the user's IAM record and rendered directly by an `<img>`, so it takes no credentials —…
- [List csrf](/docs/openapi/account/get-account-csrf): IssueCSRFToken mints the anti-forgery token a browser echoes as X-CSRF-Token on every change it asks for.
- [List embed](/docs/openapi/account/get-account-embed): 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…
- [List keys](/docs/openapi/account/get-account-keys): Returns the caller's own API keys — every type they hold, read AUTHORITATIVELY from IAM rather than from the session claim, which lags a key minted…
- [Create appearance](/docs/openapi/account/post-account-appearance): Stores the caller's appearance preference on their IAM account, preserving every other field of the row.
- [Create avatar](/docs/openapi/account/post-account-avatar): 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…
- [Create keys](/docs/openapi/account/post-account-keys): Creates — or rotates — the caller's API key of the requested type and returns it ONCE. A real IAM failure surfaces as 502, never a fabricated key.
- [Create orgs](/docs/openapi/account/post-account-orgs): Onboard creates the caller's organization.
- [Ad](/docs/openapi/ad): Your paid ad campaigns, launched and paused from one place.
- [Delete campaigns](/docs/openapi/ad/delete-ad-campaigns-by-id): Removes one of the caller org's campaigns and answers 204 with no body.
- [List campaigns](/docs/openapi/ad/get-ad-campaigns): Returns the caller org's ad campaigns, most recently updated first, optionally narrowed to one lifecycle status.
- [Get campaigns](/docs/openapi/ad/get-ad-campaigns-by-id): Returns one of the caller org's campaigns.
- [List summary](/docs/openapi/ad/get-ad-summary): 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…
- [Create campaigns](/docs/openapi/ad/post-ad-campaigns): Registers a new ad campaign for the caller's org and answers 201 with the stored row.
- [Launch campaigns](/docs/openapi/ad/post-ad-campaigns-by-id-launch): 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…
- [Replace campaigns](/docs/openapi/ad/put-ad-campaigns-by-id): Replaces the user-owned fields of one of the caller org's campaigns and answers the stored row.
- [Admin](/docs/openapi/admin): Admin — reached at /v1/admin; not in the public REST contract.
- [Affiliate](/docs/openapi/affiliate): A partner program that pays commission on what your referrals spend.
- [List affiliate](/docs/openapi/affiliate/get-affiliate): 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…
- [List leaderboard](/docs/openapi/affiliate/get-affiliate-leaderboard): 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](/docs/openapi/affiliate/get-affiliate-me): 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…
- [List earnings](/docs/openapi/affiliate/get-affiliate-me-earnings): 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…
- [List links](/docs/openapi/affiliate/get-affiliate-me-links): Answers the caller's share links, each with its URL and its funnel: clicks tracked, signups — orgs attributed with that code — and conversions, meaning…
- [Create apply](/docs/openapi/affiliate/post-affiliate-apply): 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,…
- [Create attribute](/docs/openapi/affiliate/post-affiliate-attribute): 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](/docs/openapi/affiliate/post-affiliate-click): Counts a click on a share link. PUBLIC — it takes no principal, because a visitor clicking a shareable link has no session yet.
- [Create handle](/docs/openapi/affiliate/post-affiliate-me-handle): Sets the caller's public leaderboard display name, or clears it. The handle IS the opt-in.
- [Create links](/docs/openapi/affiliate/post-affiliate-me-links): Mints a new share link for the caller's own affiliate and answers it with its full URL, 201.
- [Agents](/docs/openapi/agents): Autonomous agents for your org: define them, run them, keep every run.
- [Delete agents](/docs/openapi/agents/delete-agents-by-ref): Removes an agent and every run recorded against it.
- [Delete targets](/docs/openapi/agents/delete-agents-targets-by-id): Deregisters one machine. Only its owner, or an org admin, may remove it; an unknown id, a cross-org id and a machine owned by someone else all answer the…
- [List agents](/docs/openapi/agents/get-agents): Returns every agent defined in the caller's org, each with the number of runs recorded against it.
- [List activity](/docs/openapi/agents/get-agents-activity): Serves the org-wide recent-activity feed. Events are REAL: each recorded run is an invoked (ok) or failed (error) event; each agent's own create/update…
- [List builds](/docs/openapi/agents/get-agents-builds): 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](/docs/openapi/agents/get-agents-builds-by-org-by-project): 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 —…
- [Get agents](/docs/openapi/agents/get-agents-by-ref): Returns one agent with its system prompt and its 20 most recent runs.
- [List runs](/docs/openapi/agents/get-agents-by-ref-runs): Returns one agent's execution history, newest first — each run's input, its output or its error, and how long it took.
- [List conversations](/docs/openapi/agents/get-agents-chat-conversations): 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](/docs/openapi/agents/get-agents-chat-conversations-by-id): 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…
- [List presets](/docs/openapi/agents/get-agents-chat-presets): 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…
- [List metrics](/docs/openapi/agents/get-agents-metrics): Serves the invocations-over-time histogram for the org's Agents dashboard.
- [List runs](/docs/openapi/agents/get-agents-runs): 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](/docs/openapi/agents/get-agents-sessions): 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](/docs/openapi/agents/get-agents-sessions-by-id): Returns one session with its direct child sessions and its 50 most recent events, oldest of those first.
- [List control](/docs/openapi/agents/get-agents-sessions-by-id-control): 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…
- [List progress](/docs/openapi/agents/get-agents-sessions-by-id-progress): 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…
- [List tree](/docs/openapi/agents/get-agents-sessions-by-id-tree): Returns the subagent-flow graph rooted at this session: the session, its children, their children, each node carrying its own event count.
- [List stream](/docs/openapi/agents/get-agents-sessions-stream): 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…
- [List targets](/docs/openapi/agents/get-agents-targets): Returns every machine registered to the caller's org, newest first, each with its live session load.
- [Get targets](/docs/openapi/agents/get-agents-targets-by-id): Returns one registered machine, with its live session load.
- [Update agents](/docs/openapi/agents/patch-agents-by-ref): Changes an agent in place. Every field is optional; a field the request omits keeps its stored value.
- [Update sessions](/docs/openapi/agents/patch-agents-sessions-by-id): 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…
- [Update targets](/docs/openapi/agents/patch-agents-targets-by-id): Updates one machine in place. Every field is optional; a field the request omits is left alone.
- [Create agents](/docs/openapi/agents/post-agents): Defines an agent in the caller's org: a model, a system prompt (instructions) and a set of tool names.
- [Run agents](/docs/openapi/agents/post-agents-by-ref-run): 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…
- [Create chat](/docs/openapi/agents/post-agents-chat): 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…
- [Create coding](/docs/openapi/agents/post-agents-coding): 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 sessions](/docs/openapi/agents/post-agents-sessions): 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 events](/docs/openapi/agents/post-agents-sessions-by-id-events): Records one turn of a session's transcript and answers 201 with it.
- [Create message](/docs/openapi/agents/post-agents-sessions-by-id-message): Sends a steering message to a running session — the endpoint a human or another agent interrupts through.
- [Create pause](/docs/openapi/agents/post-agents-sessions-by-id-pause): Asks a running session to pause.
- [Resume sessions](/docs/openapi/agents/post-agents-sessions-by-id-resume): Asks a paused session to continue, on the same terms as a pause.
- [Stop sessions](/docs/openapi/agents/post-agents-sessions-by-id-stop): Ends a running session. `message` is recorded as the cancellation reason, which is what a later reader of the transcript sees.
- [Create targets](/docs/openapi/agents/post-agents-targets): Registers a machine as an agent target, or re-links one that is already registered.
- [Claim targets](/docs/openapi/agents/post-agents-targets-by-id-claim): ClaimRoutedRun is the machine's long poll for work: it authenticates the daemon, stamps the liveness the dispatch gate reads (the poll IS the proof a…
- [Create key](/docs/openapi/agents/post-agents-targets-by-id-key): 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…
- [Create report](/docs/openapi/agents/post-agents-targets-by-id-runs-by-runid-report): Completes a claimed run: it delivers the terminal result to the run's durable owner, which is what lets that workflow finish.
- [AI](/docs/openapi/ai): 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…
- [List tools](/docs/openapi/ai/aimcptools): Tools reports what THIS PROCESS's MCP server carries: how many tools its own registry projects, optionally their names, and which subsystems this process…
- [Delete articles](/docs/openapi/ai/delete-ai-articles-by-owner-by-name): Delete one article.
- [Delete assets](/docs/openapi/ai/delete-ai-assets-by-owner-by-name): Delete one asset.
- [Delete chats](/docs/openapi/ai/delete-ai-chats-by-owner-by-name): Delete one chat.
- [Delete connections](/docs/openapi/ai/delete-ai-connections-by-provider): 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…
- [Delete deployments](/docs/openapi/ai/delete-ai-deployments-by-owner-by-name): Delete one application.
- [Delete files](/docs/openapi/ai/delete-ai-files-by-owner-by-name): Delete one file.
- [Delete forms](/docs/openapi/ai/delete-ai-forms-by-owner-by-name): Delete one form.
- [Delete graphs](/docs/openapi/ai/delete-ai-graphs-by-owner-by-name): Delete one graph.
- [Delete messages](/docs/openapi/ai/delete-ai-messages-by-owner-by-name): Delete one message.
- [Delete welcome](/docs/openapi/ai/delete-ai-messages-welcome): Welcome (message)
- [Delete nodes](/docs/openapi/ai/delete-ai-nodes-by-owner-by-name): Delete one node.
- [Delete settings](/docs/openapi/ai/delete-ai-org-settings): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Delete list](/docs/openapi/ai/delete-ai-org-settings-list): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Delete providers](/docs/openapi/ai/delete-ai-providers-by-owner-by-name): Delete one provider.
- [Delete records](/docs/openapi/ai/delete-ai-records-by-owner-by-name): Delete one record.
- [Delete remote connections](/docs/openapi/ai/delete-ai-remote-connections-by-owner-by-name): Delete one connection.
- [Delete artifact meta](/docs/openapi/ai/delete-ai-router-artifact-meta): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Delete data](/docs/openapi/ai/delete-ai-router-data): Router Data
- [Delete defaults](/docs/openapi/ai/delete-ai-router-defaults): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Delete ledger](/docs/openapi/ai/delete-ai-router-ledger): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Delete policy](/docs/openapi/ai/delete-ai-router-policy): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Delete rewards](/docs/openapi/ai/delete-ai-router-rewards): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Delete routes](/docs/openapi/ai/delete-ai-routes-by-owner-by-name): Delete one model-route.
- [Delete scales](/docs/openapi/ai/delete-ai-scales-by-owner-by-name): Delete one scale.
- [Delete scans](/docs/openapi/ai/delete-ai-scans-by-owner-by-name): Delete one scan.
- [Delete signin sessions](/docs/openapi/ai/delete-ai-signin-sessions-by-owner-by-name): Delete one session.
- [Delete stores](/docs/openapi/ai/delete-ai-stores-by-owner-by-name): Delete one store.
- [Delete tasks](/docs/openapi/ai/delete-ai-tasks-by-owner-by-name): Delete one task.
- [Delete templates](/docs/openapi/ai/delete-ai-templates-by-owner-by-name): Delete one template.
- [Delete tree files](/docs/openapi/ai/delete-ai-tree-files-by-owner-by-name): Delete one tree-file.
- [Delete all](/docs/openapi/ai/delete-ai-vectors-all): All (vector)
- [Delete vectors](/docs/openapi/ai/delete-ai-vectors-by-owner-by-name): Delete one vector.
- [Delete videos](/docs/openapi/ai/delete-ai-videos-by-owner-by-name): Delete one video.
- [Delete workflows](/docs/openapi/ai/delete-ai-workflows-by-owner-by-name): Delete one workflow.
- [List account](/docs/openapi/ai/get-ai-account): Account
- [List activities](/docs/openapi/ai/get-ai-activities): List the caller's activities.
- [List answer](/docs/openapi/ai/get-ai-answer): Answer
- [List articles](/docs/openapi/ai/get-ai-articles): List the caller's articles.
- [Get articles](/docs/openapi/ai/get-ai-articles-by-owner-by-name): Read one article by its (owner, name) key.
- [List global](/docs/openapi/ai/get-ai-articles-global): Cross-tenant listing.
- [List assets](/docs/openapi/ai/get-ai-assets): List the caller's assets.
- [Get assets](/docs/openapi/ai/get-ai-assets-by-owner-by-name): Read one asset by its (owner, name) key.
- [List chats](/docs/openapi/ai/get-ai-chats): List the caller's chats.
- [Get chats](/docs/openapi/ai/get-ai-chats-by-owner-by-name): Read one chat by its (owner, name) key.
- [List global](/docs/openapi/ai/get-ai-chats-global): Cross-tenant listing.
- [List connections](/docs/openapi/ai/get-ai-connections): Lists the org's connectable AI accounts and whether each is currently connected.
- [List authorize](/docs/openapi/ai/get-ai-connections-by-provider-authorize): 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](/docs/openapi/ai/get-ai-connections-by-provider-callback): 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…
- [List usage](/docs/openapi/ai/get-ai-connections-by-provider-usage): Imports the caller org's usage for a connected third-party account.
- [List agents](/docs/openapi/ai/get-ai-dashboards-agents): Dashboards Agents
- [List vm](/docs/openapi/ai/get-ai-dashboards-vm): Dashboards Vm
- [List deployments](/docs/openapi/ai/get-ai-deployments): List the caller's deployments.
- [Get deployments](/docs/openapi/ai/get-ai-deployments-by-owner-by-name): Read one application by its (owner, name) key.
- [List files](/docs/openapi/ai/get-ai-files): List the caller's files.
- [List active](/docs/openapi/ai/get-ai-files-active): Active (file)
- [Get files](/docs/openapi/ai/get-ai-files-by-owner-by-name): Read one file by its (owner, name) key.
- [List global](/docs/openapi/ai/get-ai-files-global): Cross-tenant listing.
- [List datasets](/docs/openapi/ai/get-ai-finetune-hf-datasets): Proxies a HuggingFace dataset search (dataset picker).
- [List models](/docs/openapi/ai/get-ai-finetune-hf-models): Proxies a HuggingFace model search (base-model picker).
- [List repo](/docs/openapi/ai/get-ai-finetune-hf-repo): Returns a repo's detail (files, gated/private state).
- [List job](/docs/openapi/ai/get-ai-finetune-job): Returns one job with refreshed live status.
- [List jobs](/docs/openapi/ai/get-ai-finetune-jobs): Returns the org's jobs, refreshing live status for active ones.
- [List presets](/docs/openapi/ai/get-ai-finetune-presets): Returns the new-job catalog plus, when a selection is passed (?baseModel&method&task&preset[&datasetExamples]), the recommended config so the console can…
- [List forms](/docs/openapi/ai/get-ai-forms): List the caller's forms.
- [Get forms](/docs/openapi/ai/get-ai-forms-by-owner-by-name): Read one form by its (owner, name) key.
- [List data](/docs/openapi/ai/get-ai-forms-data): Data (form)
- [List global](/docs/openapi/ai/get-ai-forms-global): Cross-tenant listing.
- [List graphs](/docs/openapi/ai/get-ai-graphs): List the caller's graphs.
- [Get graphs](/docs/openapi/ai/get-ai-graphs-by-owner-by-name): Read one graph by its (owner, name) key.
- [List global](/docs/openapi/ai/get-ai-graphs-global): Cross-tenant listing.
- [List k8s status](/docs/openapi/ai/get-ai-k8s-status): K8s Status
- [List facts](/docs/openapi/ai/get-ai-memory-facts): List the authenticated user's stored facts
- [List list](/docs/openapi/ai/get-ai-memory-list): List the authenticated user's memories, newest first
- [List recall](/docs/openapi/ai/get-ai-memory-recall): Recall recent/relevant memories for context injection; with q it ranks semantically, without q it returns the most recent
- [Search memory](/docs/openapi/ai/get-ai-memory-search): Search the authenticated user's memories (semantic, text fallback)
- [List messages](/docs/openapi/ai/get-ai-messages): List the caller's messages.
- [Get messages](/docs/openapi/ai/get-ai-messages-by-owner-by-name): Read one message by its (owner, name) key.
- [List answer](/docs/openapi/ai/get-ai-messages-by-owner-by-name-answer): Answer (message)
- [List global](/docs/openapi/ai/get-ai-messages-global): Cross-tenant listing.
- [List nodes](/docs/openapi/ai/get-ai-nodes): List the caller's nodes.
- [Get nodes](/docs/openapi/ai/get-ai-nodes-by-owner-by-name): Read one node by its (owner, name) key.
- [List tunnel](/docs/openapi/ai/get-ai-nodes-by-owner-by-name-tunnel): Tunnel (node)
- [List settings](/docs/openapi/ai/get-ai-org-settings): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [List list](/docs/openapi/ai/get-ai-org-settings-list): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [List prometheus](/docs/openapi/ai/get-ai-prometheus): Prometheus
- [List providers](/docs/openapi/ai/get-ai-providers): List the caller's providers.
- [Get providers](/docs/openapi/ai/get-ai-providers-by-owner-by-name): Read one provider by its (owner, name) key.
- [List global](/docs/openapi/ai/get-ai-providers-global): Cross-tenant listing.
- [List context](/docs/openapi/ai/get-ai-rag-context): Return every stored chunk of one file_id (full document context).
- [List records](/docs/openapi/ai/get-ai-records): List the caller's records.
- [Get records](/docs/openapi/ai/get-ai-records-by-owner-by-name): Read one record by its (owner, name) key.
- [Query records](/docs/openapi/ai/get-ai-records-query): Query (record)
- [List query second](/docs/openapi/ai/get-ai-records-query-second): Query Second (record)
- [List remote connections](/docs/openapi/ai/get-ai-remote-connections): List the caller's remote-connections.
- [Get remote connections](/docs/openapi/ai/get-ai-remote-connections-by-owner-by-name): Read one connection by its (owner, name) key.
- [List artifact meta](/docs/openapi/ai/get-ai-router-artifact-meta): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [List data](/docs/openapi/ai/get-ai-router-data): Router Data
- [List defaults](/docs/openapi/ai/get-ai-router-defaults): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [List history](/docs/openapi/ai/get-ai-router-history): Returns the router-improvement time-series.
- [List judge panel](/docs/openapi/ai/get-ai-router-judge-panel): Returns the LIVE Mean-Field Judge Panel state: the configured panel + dynamic judge posture (enabled/sample) resolved from the "*" GlobalDefaultOwner row,…
- [List ledger](/docs/openapi/ai/get-ai-router-ledger): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [List policy](/docs/openapi/ai/get-ai-router-policy): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [List rewards](/docs/openapi/ai/get-ai-router-rewards): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [List stats](/docs/openapi/ai/get-ai-router-stats): Returns the router observability aggregate. Two scopes, one route: - ?scope=platform — PUBLIC-safe aggregate over ALL orgs, no authentication.
- [List routes](/docs/openapi/ai/get-ai-routes): List the caller's routes.
- [Get routes](/docs/openapi/ai/get-ai-routes-by-owner-by-name): Read one model-route by its (owner, name) key.
- [List scales](/docs/openapi/ai/get-ai-scales): List the caller's scales.
- [Get scales](/docs/openapi/ai/get-ai-scales-by-owner-by-name): Read one scale by its (owner, name) key.
- [List global](/docs/openapi/ai/get-ai-scales-global): Cross-tenant listing.
- [List public](/docs/openapi/ai/get-ai-scales-public): Public (scale)
- [List scans](/docs/openapi/ai/get-ai-scans): List the caller's scans.
- [Get scans](/docs/openapi/ai/get-ai-scans-by-owner-by-name): Read one scan by its (owner, name) key.
- [List signin sessions](/docs/openapi/ai/get-ai-signin-sessions): List the caller's signin-sessions.
- [Get signin sessions](/docs/openapi/ai/get-ai-signin-sessions-by-owner-by-name): Read one session by its (owner, name) key.
- [List duplicated](/docs/openapi/ai/get-ai-signin-sessions-duplicated): Duplicated (session)
- [List stores](/docs/openapi/ai/get-ai-stores): List the caller's stores.
- [Get stores](/docs/openapi/ai/get-ai-stores-by-owner-by-name): Read one store by its (owner, name) key.
- [List global](/docs/openapi/ai/get-ai-stores-global): Cross-tenant listing.
- [List names](/docs/openapi/ai/get-ai-stores-names): Names (store)
- [List providers](/docs/openapi/ai/get-ai-stores-providers): Providers (store)
- [List system](/docs/openapi/ai/get-ai-system): System
- [List tasks](/docs/openapi/ai/get-ai-tasks): List the caller's tasks.
- [Get tasks](/docs/openapi/ai/get-ai-tasks-by-owner-by-name): Read one task by its (owner, name) key.
- [List global](/docs/openapi/ai/get-ai-tasks-global): Cross-tenant listing.
- [List templates](/docs/openapi/ai/get-ai-templates): List the caller's templates.
- [Get templates](/docs/openapi/ai/get-ai-templates-by-owner-by-name): Read one template by its (owner, name) key.
- [List globe](/docs/openapi/ai/get-ai-traffic-globe): 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…
- [List training contribution](/docs/openapi/ai/get-ai-training-contribution): Training Contribution
- [List usages](/docs/openapi/ai/get-ai-usages): List the caller's usages.
- [List by user](/docs/openapi/ai/get-ai-usages-by-user): By User (usage)
- [List cloud](/docs/openapi/ai/get-ai-usages-cloud): Cloud (usage)
- [List range](/docs/openapi/ai/get-ai-usages-range): Range (usage)
- [List user names](/docs/openapi/ai/get-ai-usages-user-names): User Names (usage)
- [List vectors](/docs/openapi/ai/get-ai-vectors): List the caller's vectors.
- [Get vectors](/docs/openapi/ai/get-ai-vectors-by-owner-by-name): Read one vector by its (owner, name) key.
- [List global](/docs/openapi/ai/get-ai-vectors-global): Cross-tenant listing.
- [List version](/docs/openapi/ai/get-ai-version): Version
- [List videos](/docs/openapi/ai/get-ai-videos): List the caller's videos.
- [Get videos](/docs/openapi/ai/get-ai-videos-by-owner-by-name): Read one video by its (owner, name) key.
- [List global](/docs/openapi/ai/get-ai-videos-global): Cross-tenant listing.
- [List workflows](/docs/openapi/ai/get-ai-workflows): List the caller's workflows.
- [Get workflows](/docs/openapi/ai/get-ai-workflows-by-owner-by-name): Read one workflow by its (owner, name) key.
- [List global](/docs/openapi/ai/get-ai-workflows-global): Cross-tenant listing.
- [List models](/docs/openapi/ai/get-models): Returns the list of available models from the routing table.
- [List access](/docs/openapi/ai/get-models-by-model-access): Returns the caller's own standing for a gated model: "granted", "requested", or empty when they have never asked.
- [List providers](/docs/openapi/ai/get-models-providers): Public, secret-free list of the providers serving the models that GET /v1/models lists — the same source, projected.
- [Get videos](/docs/openapi/ai/get-videos-by-id): Implements GET /v1/videos/{id} — poll a job's status.
- [List content](/docs/openapi/ai/get-videos-by-id-content): Implements GET /v1/videos/{id}/content — download the finished MP4.
- [Update articles](/docs/openapi/ai/patch-ai-articles-by-owner-by-name): Update one article.
- [Update assets](/docs/openapi/ai/patch-ai-assets-by-owner-by-name): Update one asset.
- [Update chats](/docs/openapi/ai/patch-ai-chats-by-owner-by-name): Update one chat.
- [Update deployments](/docs/openapi/ai/patch-ai-deployments-by-owner-by-name): Update one application.
- [Update files](/docs/openapi/ai/patch-ai-files-by-owner-by-name): Update one file.
- [Update forms](/docs/openapi/ai/patch-ai-forms-by-owner-by-name): Update one form.
- [Update graphs](/docs/openapi/ai/patch-ai-graphs-by-owner-by-name): Update one graph.
- [Update messages](/docs/openapi/ai/patch-ai-messages-by-owner-by-name): Update one message.
- [Update nodes](/docs/openapi/ai/patch-ai-nodes-by-owner-by-name): Update one node.
- [Update settings](/docs/openapi/ai/patch-ai-org-settings): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Update list](/docs/openapi/ai/patch-ai-org-settings-list): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Update preferences](/docs/openapi/ai/patch-ai-preferences): Preferences
- [Update providers](/docs/openapi/ai/patch-ai-providers-by-owner-by-name): Update one provider.
- [Update records](/docs/openapi/ai/patch-ai-records-by-owner-by-name): Update one record.
- [Update remote connections](/docs/openapi/ai/patch-ai-remote-connections-by-owner-by-name): Update one connection.
- [Update artifact meta](/docs/openapi/ai/patch-ai-router-artifact-meta): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Update defaults](/docs/openapi/ai/patch-ai-router-defaults): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Update ledger](/docs/openapi/ai/patch-ai-router-ledger): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Update policy](/docs/openapi/ai/patch-ai-router-policy): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Update rewards](/docs/openapi/ai/patch-ai-router-rewards): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Update routes](/docs/openapi/ai/patch-ai-routes-by-owner-by-name): Update one model-route.
- [Update scales](/docs/openapi/ai/patch-ai-scales-by-owner-by-name): Update one scale.
- [Update scans](/docs/openapi/ai/patch-ai-scans-by-owner-by-name): Update one scan.
- [Update signin sessions](/docs/openapi/ai/patch-ai-signin-sessions-by-owner-by-name): Update one session.
- [Update stores](/docs/openapi/ai/patch-ai-stores-by-owner-by-name): Update one store.
- [Update tasks](/docs/openapi/ai/patch-ai-tasks-by-owner-by-name): Update one task.
- [Update templates](/docs/openapi/ai/patch-ai-templates-by-owner-by-name): Update one template.
- [Update training contribution](/docs/openapi/ai/patch-ai-training-contribution): Training Contribution
- [Update tree files](/docs/openapi/ai/patch-ai-tree-files-by-owner-by-name): Update one tree-file.
- [Update vectors](/docs/openapi/ai/patch-ai-vectors-by-owner-by-name): Update one vector.
- [Update videos](/docs/openapi/ai/patch-ai-videos-by-owner-by-name): Update one video.
- [Update workflows](/docs/openapi/ai/patch-ai-workflows-by-owner-by-name): Update one workflow.
- [Create articles](/docs/openapi/ai/post-ai-articles): Create one article.
- [Create assets](/docs/openapi/ai/post-ai-assets): Create one asset.
- [Create scan](/docs/openapi/ai/post-ai-assets-by-owner-by-name-scan): Scan (asset)
- [Create scan](/docs/openapi/ai/post-ai-assets-scan): Scan (asset)
- [Create chats](/docs/openapi/ai/post-ai-chats): Create one chat.
- [Create connections](/docs/openapi/ai/post-ai-connections): 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](/docs/openapi/ai/post-ai-connections-by-provider): 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…
- [Create deployments](/docs/openapi/ai/post-ai-deployments): Create one application.
- [Deploy deployments](/docs/openapi/ai/post-ai-deployments-by-owner-by-name-deploy): Deploy (application)
- [Create undeploy](/docs/openapi/ai/post-ai-deployments-by-owner-by-name-undeploy): Undeploy (application)
- [Create feedback](/docs/openapi/ai/post-ai-feedback): Attaches a per-request outcome reward to the routing decision that served request_id — the enso training loop's quality signal.
- [Create files](/docs/openapi/ai/post-ai-files): Create one file.
- [Create activate](/docs/openapi/ai/post-ai-files-activate): Activate (file)
- [Create vectors](/docs/openapi/ai/post-ai-files-by-owner-by-name-vectors): Vectors (file)
- [Create upload](/docs/openapi/ai/post-ai-files-upload): Upload (file)
- [Cancel finetune](/docs/openapi/ai/post-ai-finetune-cancel): Deletes the TrainJob CR, meters the GPU-hours used so far, and marks the job cancelled.
- [Deploy finetune](/docs/openapi/ai/post-ai-finetune-deploy): Serves a completed job's checkpoints and registers the result as a routable model on api.hanzo.ai.
- [Create jobs](/docs/openapi/ai/post-ai-finetune-jobs): Validates the request, resolves efficient defaults, persists the job, and submits a real TrainJob CR. A submit failure (e.g.
- [Create forms](/docs/openapi/ai/post-ai-forms): Create one form.
- [Create graphs](/docs/openapi/ai/post-ai-graphs): Create one graph.
- [Create delete](/docs/openapi/ai/post-ai-memory-delete): Delete one of the authenticated user's memories
- [Create remember](/docs/openapi/ai/post-ai-memory-remember): Store a memory for the authenticated user
- [Create update](/docs/openapi/ai/post-ai-memory-update): Update one of the authenticated user's memories
- [Create messages](/docs/openapi/ai/post-ai-messages): Create one message.
- [Create nodes](/docs/openapi/ai/post-ai-nodes): Create one node.
- [Create tunnel](/docs/openapi/ai/post-ai-nodes-by-owner-by-name-tunnel): Tunnel (node)
- [Create settings](/docs/openapi/ai/post-ai-org-settings): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Create list](/docs/openapi/ai/post-ai-org-settings-list): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Create providers](/docs/openapi/ai/post-ai-providers): Create one provider.
- [Create mcp tools](/docs/openapi/ai/post-ai-providers-mcp-tools): Mcp Tools (provider)
- [Create delete](/docs/openapi/ai/post-ai-rag-delete): Delete all chunks of one or more uploaded files (by file_id) from the owner's Search+Vector index.
- [Create embed](/docs/openapi/ai/post-ai-rag-embed): Parse, chunk, and embed one uploaded file under its file_id into the unified Search+Vector index, scoped to the authenticated owner.
- [Create ingest](/docs/openapi/ai/post-ai-rag-ingest): Unified RAG ingest: parse + chunk + embed documents and pipe them to BOTH Hanzo Vector (semantic) AND Hanzo Search (keyword) under the tenant index…
- [Query rag](/docs/openapi/ai/post-ai-rag-query): Retrieve the top-K chunks relevant to a query, scoped to a single uploaded file (`file_id`). Hybrid keyword+vector retrieval over the same index.
- [Create query multiple](/docs/openapi/ai/post-ai-rag-query-multiple): Retrieve the top-K chunks relevant to a query, scoped to a SET of uploaded files (`file_ids`). Consolidates the retired chat-rag-api POST /query_multiple.
- [Create records](/docs/openapi/ai/post-ai-records): Create one record.
- [Create batch](/docs/openapi/ai/post-ai-records-batch): Batch (record)
- [Create commit](/docs/openapi/ai/post-ai-records-commit): Commit (record)
- [Create commit second](/docs/openapi/ai/post-ai-records-commit-second): Commit Second (record)
- [Create remote connections](/docs/openapi/ai/post-ai-remote-connections): Create one connection.
- [Start remote connections](/docs/openapi/ai/post-ai-remote-connections-by-owner-by-name-start): Start (connection)
- [Stop remote connections](/docs/openapi/ai/post-ai-remote-connections-by-owner-by-name-stop): Stop (connection)
- [Create artifact meta](/docs/openapi/ai/post-ai-router-artifact-meta): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Create defaults](/docs/openapi/ai/post-ai-router-defaults): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Create ledger](/docs/openapi/ai/post-ai-router-ledger): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Create policy](/docs/openapi/ai/post-ai-router-policy): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Create rewards](/docs/openapi/ai/post-ai-router-rewards): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Create routes](/docs/openapi/ai/post-ai-routes): Create one model-route.
- [Create scales](/docs/openapi/ai/post-ai-scales): Create one scale.
- [Create scans](/docs/openapi/ai/post-ai-scans): Create one scan.
- [Signin ai](/docs/openapi/ai/post-ai-signin): Signin
- [Create signin sessions](/docs/openapi/ai/post-ai-signin-sessions): Create one session.
- [Create signout](/docs/openapi/ai/post-ai-signout): Signout
- [Create stores](/docs/openapi/ai/post-ai-stores): Create one store.
- [Create vectors](/docs/openapi/ai/post-ai-stores-by-owner-by-name-vectors): Vectors (store)
- [Create tasks](/docs/openapi/ai/post-ai-tasks): Create one task.
- [Create analyze](/docs/openapi/ai/post-ai-tasks-by-owner-by-name-analyze): Analyze (task)
- [Create document](/docs/openapi/ai/post-ai-tasks-by-owner-by-name-document): Document (task)
- [Create templates](/docs/openapi/ai/post-ai-templates): Create one template.
- [Create tree files](/docs/openapi/ai/post-ai-tree-files): Create one tree-file.
- [Create vectors](/docs/openapi/ai/post-ai-vectors): Create one vector.
- [Create videos](/docs/openapi/ai/post-ai-videos): Create one video.
- [Create upload](/docs/openapi/ai/post-ai-videos-upload): Upload (video)
- [Create workflows](/docs/openapi/ai/post-ai-workflows): Create one workflow.
- [Create foley](/docs/openapi/ai/post-audio-foley): Serves the generative audio verbs — /v1/audio/voice (TTS), /music, /foley — that the Zen family serves natively.
- [Create music](/docs/openapi/ai/post-audio-music): Serves the generative audio verbs — /v1/audio/voice (TTS), /music, /foley — that the Zen family serves natively.
- [Create speech](/docs/openapi/ai/post-audio-speech): The OpenAI-compatible TTS endpoint (POST /v1/audio/speech).
- [Create transcriptions](/docs/openapi/ai/post-audio-transcriptions): The OpenAI-compatible STT endpoint (POST /v1/audio/transcriptions, multipart: file + model [+ language + response_format]).
- [Create voice](/docs/openapi/ai/post-audio-voice): Serves the generative audio verbs — /v1/audio/voice (TTS), /music, /foley — that the Zen family serves natively.
- [Create chat](/docs/openapi/ai/post-chat): Implements the OpenAI-compatible chat completions API
- [Create completions](/docs/openapi/ai/post-chat-completions): Implements the OpenAI-compatible chat completions API
- [Create public](/docs/openapi/ai/post-chat-public): Serves one completion to a caller with no account.
- [Create completions](/docs/openapi/ai/post-completions): Implements the OpenAI-compatible chat completions API
- [Create embeddings](/docs/openapi/ai/post-embeddings): Implements POST /v1/embeddings (OpenAI-compatible).
- [Create generations](/docs/openapi/ai/post-images-generations): Implements POST /v1/images/generations (OpenAI-compatible).
- [Create messages](/docs/openapi/ai/post-messages): Implements the Anthropic Messages API.
- [Create count tokens](/docs/openapi/ai/post-messages-count-tokens): Implements POST /v1/messages/count_tokens.
- [Create access](/docs/openapi/ai/post-models-by-model-access): Records the caller's waitlist request for a gated model and answers their new standing.
- [Create rerank](/docs/openapi/ai/post-rerank): Implements POST /v1/rerank (Cohere/Jina-compatible).
- [Create responses](/docs/openapi/ai/post-responses): Implements POST /v1/responses. The converted request is completed by the chat path, which is handed a sink saying where the answer goes: a stream is…
- [Create generations](/docs/openapi/ai/post-videos-generations): Implements POST /v1/videos/generations — the ASYNC create.
- [Replace articles](/docs/openapi/ai/put-ai-articles-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace assets](/docs/openapi/ai/put-ai-assets-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace chats](/docs/openapi/ai/put-ai-chats-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace deployments](/docs/openapi/ai/put-ai-deployments-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace files](/docs/openapi/ai/put-ai-files-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace forms](/docs/openapi/ai/put-ai-forms-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace graphs](/docs/openapi/ai/put-ai-graphs-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace messages](/docs/openapi/ai/put-ai-messages-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace nodes](/docs/openapi/ai/put-ai-nodes-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace settings](/docs/openapi/ai/put-ai-org-settings): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Replace list](/docs/openapi/ai/put-ai-org-settings-list): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Replace preferences](/docs/openapi/ai/put-ai-preferences): Preferences
- [Replace providers](/docs/openapi/ai/put-ai-providers-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace records](/docs/openapi/ai/put-ai-records-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace remote connections](/docs/openapi/ai/put-ai-remote-connections-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace artifact meta](/docs/openapi/ai/put-ai-router-artifact-meta): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Replace defaults](/docs/openapi/ai/put-ai-router-defaults): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Replace ledger](/docs/openapi/ai/put-ai-router-ledger): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Replace policy](/docs/openapi/ai/put-ai-router-policy): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Replace rewards](/docs/openapi/ai/put-ai-router-rewards): The HTTP transport binding for the RESTful router-config nouns (/v1/ai/router/{policy,defaults,ledger,rewards,artifact-meta} and…
- [Replace routes](/docs/openapi/ai/put-ai-routes-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace scales](/docs/openapi/ai/put-ai-scales-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace scans](/docs/openapi/ai/put-ai-scans-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace signin sessions](/docs/openapi/ai/put-ai-signin-sessions-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace stores](/docs/openapi/ai/put-ai-stores-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace tasks](/docs/openapi/ai/put-ai-tasks-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace templates](/docs/openapi/ai/put-ai-templates-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace training contribution](/docs/openapi/ai/put-ai-training-contribution): Training Contribution
- [Replace tree files](/docs/openapi/ai/put-ai-tree-files-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace vectors](/docs/openapi/ai/put-ai-vectors-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace videos](/docs/openapi/ai/put-ai-videos-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Replace workflows](/docs/openapi/ai/put-ai-workflows-by-owner-by-name): Identical to PATCH — the handler takes a whole object either way.
- [Allowance](/docs/openapi/allowance): How much a plan lets you do without paying, and how much of it you have left today.
- [List allowance](/docs/openapi/allowance/get-allowance): Answers what the CALLER has left of their plan's free-call allowance this period, and the instant the count starts again.
- [AMQP](/docs/openapi/amqp): AMQP — reached at :5672; not in the public REST contract.
- [Ask](/docs/openapi/ask): A plain-language question about your business, answered with real numbers.
- [Create ask](/docs/openapi/ask/post-ask): Answers a natural-language question about the CALLER'S OWN org, from real figures rather than from the model's memory.
- [Create web](/docs/openapi/ask/research-web): Researches a question on the live web and answers it with its sources cited. This is the DEEP one.
- [Audit](/docs/openapi/audit): Your org's tamper-evident audit trail: every security-relevant event, hash-chained and readable.
- [List audit](/docs/openapi/audit/get-audit): List reads the caller's OWN org audit trail, newest first, with the total the filter matched so a console can page it.
- [Author](/docs/openapi/author): A royalty for open-source work: your repo runs, you get paid.
- [List author](/docs/openapi/author/get-author): Returns the caller's author-program dashboard: enrolment status, linked forge login, verified repositories and owner-wide claims, recorded deploys,…
- [List basis](/docs/openapi/author/get-author-basis): 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…
- [Connect author](/docs/openapi/author/post-author-connect): 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](/docs/openapi/author/post-author-deploys-record): 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](/docs/openapi/author/post-author-repos-verify): 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](/docs/openapi/authz): The access decision behind an org-scoped call: who may do what, where, answered allow or deny.
- [List health](/docs/openapi/authz/get-authz-health): Reports that the authz process is up. Unauthenticated by design and never org-scoped: it answers while every tenant's enforcer is still cold, because a…
- [List readyz](/docs/openapi/authz/get-authz-readyz): Reports that the authz process is ready to serve decisions.
- [Create check](/docs/openapi/authz/post-authz-check): 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…
- [Auto](/docs/openapi/auto): Workflows that run themselves, on a schedule or a webhook.
- [Delete flows](/docs/openapi/auto/delete-auto-flows-by-id): Deletes one automation, its versions and its run history.
- [List connectors](/docs/openapi/auto/get-auto-connectors): Connectors returns the connector catalogue.
- [List flows](/docs/openapi/auto/get-auto-flows): Returns the caller org's automations, most-recently-updated first.
- [Get flows](/docs/openapi/auto/get-auto-flows-by-id): Returns one automation and its latest version.
- [List versions](/docs/openapi/auto/get-auto-flows-by-id-versions): Returns one flow's versions, newest first.
- [List runs](/docs/openapi/auto/get-auto-runs): Returns the caller org's run history, newest first.
- [Get runs](/docs/openapi/auto/get-auto-runs-by-id): Returns one run. A run that has not reached a terminal status is refreshed from the durable engine first — scoped to the org's own namespace — so the…
- [Update flows](/docs/openapi/auto/patch-auto-flows-by-id): Updates one automation's metadata in place. Every field is optional; a field the request omits is left alone.
- [Run connectors](/docs/openapi/auto/post-auto-connectors-by-id-run): Run executes one connector action in-process and answers the outcome.
- [Create flows](/docs/openapi/auto/post-auto-flows): Creates an automation and its initial DRAFT version in one call.
- [Disable flows](/docs/openapi/auto/post-auto-flows-by-id-disable): Disarms a flow's trigger and marks it DISABLED.
- [Enable flows](/docs/openapi/auto/post-auto-flows-by-id-enable): Arms a flow's trigger and marks it ENABLED.
- [Create operations](/docs/openapi/auto/post-auto-flows-by-id-operations): Applies ONE flow operation and answers the thing it changed.
- [Run flows](/docs/openapi/auto/post-auto-flows-by-id-run): Starts one durable run of a flow now. It runs the flow's published version if one is pinned, else its latest, and answers the run record it created.
- [Create versions](/docs/openapi/auto/post-auto-flows-by-id-versions): Adds a new DRAFT version to a flow. The version is created invalid unless it carries a trigger, and it does not become the running version until it is…
- [Create hooks](/docs/openapi/auto/post-auto-hooks-by-source-by-event): 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…
- [Resume runs](/docs/openapi/auto/post-auto-runs-by-id-resume): 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](/docs/openapi/base): Managed Hanzo Base: a hosted backend for your app — collections, records, access rules and sign-in.
- [List bases](/docs/openapi/base/get-base-bases): Lists every Base the caller can reach, one per org their token carries.
- [Get bases](/docs/openapi/base/get-base-bases-by-org): Describes ONE org's Base — whether its store exists, and what it occupies.
- [List health](/docs/openapi/base/get-base-health): Reports that the base subsystem is serving.
- [Benchmark](/docs/openapi/benchmark): One honest score for any model, on the tests everyone quotes.
- [List catalog](/docs/openapi/benchmark/get-benchmark-catalog): Is the canonical public benchmarks this arena runs — the id, title, axis, item count and upstream source of each, with native marking the ones the…
- [List claims](/docs/openapi/benchmark/get-benchmark-claims): Lists the effective published claims: what the leaderboard will use for each (benchmark, model) after the seed, the import and any stored correction are…
- [List compare](/docs/openapi/benchmark/get-benchmark-compare): Is 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](/docs/openapi/benchmark/get-benchmark-history): Returns each model's measured score per run over time, oldest first, with the change between runs.
- [List leaderboard](/docs/openapi/benchmark/get-benchmark-leaderboard): 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](/docs/openapi/benchmark/get-benchmark-presets): 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…
- [Create claims](/docs/openapi/benchmark/post-benchmark-claims): Records published claims: one to correct a number, many to import a leaderboard.
- [Create presets](/docs/openapi/benchmark/post-benchmark-presets): 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…
- [Create runs](/docs/openapi/benchmark/post-benchmark-runs): Admits and queues a benchmark run against a model or your own endpoint, and answers 202 with the receipt.
- [Billing](/docs/openapi/billing): Your org's balance, what it has spent, and the cards it pays with.
- [Cancel subscriptions](/docs/openapi/billing/cancelsubscription): Ends a subscription. It cancels at the END OF THE PAID PERIOD by default, because a customer who cancels has already paid for the period they are in and…
- [Create collect](/docs/openapi/billing/collectinvoice): Collects an issued invoice: credit grants first, then prepaid balance, then the card on file — the same waterfall the dunning workflow runs.
- [Delete alerts](/docs/openapi/billing/delete-billing-alerts-by-id): Removes one of the caller's spend caps and answers 204. Removing a cap RAISES what the org may spend, so it takes the same authority setting one does.
- [Delete methods](/docs/openapi/billing/delete-billing-methods-by-id): Removes one card or account the caller has saved.
- [Delete methods](/docs/openapi/billing/delete-billing-portal-methods-by-id): DetachPortalMethod is DetachMethod at the address a hosted checkout addresses it by.
- [List accounts](/docs/openapi/billing/get-billing-accounts): 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](/docs/openapi/billing/get-billing-accounts-by-id-members): Answers one billing account's roster. commerce stores no roster — that is IAM's — so the only member it can name is the caller, and that is what comes…
- [List alerts](/docs/openapi/billing/get-billing-alerts): 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](/docs/openapi/billing/get-billing-alerts-authorize): Answers whether one proposed spend fits inside this org's caps.
- [List balance](/docs/openapi/billing/get-billing-balance): 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,…
- [List credit balance](/docs/openapi/billing/get-billing-credit-balance): Answers what the caller can spend right now, one entry per currency.
- [List breakdown](/docs/openapi/billing/get-billing-credit-balance-breakdown): Answers that same spendable credit split by grant tag, with the earliest expiry under each and the total across all of them.
- [List credits](/docs/openapi/billing/get-billing-credits): Lists the caller's credit grants — every one of them, spent and lapsed and voided included.
- [Get deposit](/docs/openapi/billing/get-billing-crypto-deposit-by-id): Reads one of the caller's own deposit intents back — pending, confirming, or succeeded.
- [List options](/docs/openapi/billing/get-billing-crypto-options): Answers which chains and tokens the crypto rail accepts — what an asset picker renders.
- [List invoices](/docs/openapi/billing/get-billing-invoices): Lists the caller's invoices, newest first, with the count beside them.
- [List pdf](/docs/openapi/billing/get-billing-invoices-by-id-pdf): 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…
- [List ledger](/docs/openapi/billing/get-billing-ledger): Answers the org's own postings inside `range=`, each as a signed entry: a DEPOSIT CREDITS the wallet (positive, account `credits:<org>`) and every other…
- [List methods](/docs/openapi/billing/get-billing-methods): Answers every payment method the caller has saved, newest first.
- [List payouts](/docs/openapi/billing/get-billing-payouts): Answers the org's outbound payouts, newest first — amount, destination, status, and the failure reason where one applies.
- [List plans](/docs/openapi/billing/get-billing-plans): Answers every plan on sale — its price, what it includes, and the limits it carries — optionally narrowed to one `?category=`.
- [List methods](/docs/openapi/billing/get-billing-portal-methods): Answers every payment method the caller has saved, newest first.
- [List settings](/docs/openapi/billing/get-billing-settings): 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](/docs/openapi/billing/get-billing-subscriptions): Lists the plans the caller holds, with the count beside them. It is scoped to the caller's own org, so a query cannot widen it to another customer's.
- [List tier](/docs/openapi/billing/get-billing-tier): Answers which tier the caller is on, what it allows, and what is left to spend. `effectiveAvailable` is the ONLY figure to compare against zero.
- [List transactions](/docs/openapi/billing/get-billing-transactions): Answers one page of the caller's own ledger, newest first: what moved, how much, when, and what it was tagged with.
- [List usage](/docs/openapi/billing/get-billing-usage): Answers one row per BILLED call against the caller's org — transaction id, amount, timestamp and the metered unit.
- [List accounts](/docs/openapi/billing/get-billing-usage-accounts): Answers per-account totals for the linked provider accounts the gateway ROUTED this caller's traffic through — requests, prompt and completion tokens,…
- [List rollup](/docs/openapi/billing/get-billing-usage-rollup): Answers the caller's month: what their plan includes, what has been consumed against it, and the wallet beside it.
- [List wire](/docs/openapi/billing/get-billing-wire): Answers where to send a wire top-up: the receiving bank details, with the caller's own payment reference.
- [Get invoices](/docs/openapi/billing/getinvoice): Reads one invoice out of the caller's org.
- [Create issue](/docs/openapi/billing/issueinvoice): Issues a draft invoice: moves it to OPEN, assigns its number, and makes it collectible. Only a draft can be issued.
- [Update alerts](/docs/openapi/billing/patch-billing-alerts-by-id): Changes one spend cap: raise or lower the ceiling, flip enforcement, retune the rate limit. Only the fields the body carries move.
- [Create alerts](/docs/openapi/billing/post-billing-alerts): Opens a spend cap on the caller's own org.
- [Create deposit](/docs/openapi/billing/post-billing-crypto-deposit): Issues a deposit address the caller can send crypto to, on the asset they ask for.
- [Create methods](/docs/openapi/billing/post-billing-methods): Vaults the instrument at the processor and stores the row.
- [Create mode](/docs/openapi/billing/post-billing-mode): Moves this org between sandbox money and real money.
- [Create methods](/docs/openapi/billing/post-billing-portal-methods): Vaults the instrument at the processor and stores the row.
- [Create run all](/docs/openapi/billing/post-billing-recharge-run-all): Sweeps every org's auto-recharge and answers what it did. PLATFORM AUTHORITY ONLY.
- [Create card](/docs/openapi/billing/post-billing-subscribe-card): 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…
- [Create topup](/docs/openapi/billing/post-billing-topup): Charges a card the caller already saved and credits the balance.
- [Create token](/docs/openapi/billing/post-billing-topup-token): Charges a single-use card token and credits the caller's balance.
- [Create invoices](/docs/openapi/billing/raiseinvoice): Raises a DRAFT invoice against a customer in the caller's own org.
- [Create reactivate](/docs/openapi/billing/reactivatesubscription): Puts a canceled subscription back on its plan.
- [Create void](/docs/openapi/billing/voidinvoice): Voids a draft or issued invoice — the cancel. A paid invoice cannot be voided: money has moved, and the correction for that is a refund, not an erasure.
- [Blueprint](/docs/openapi/blueprint): What a template costs to run, worked out before you deploy.
- [List blueprint](/docs/openapi/blueprint/get-blueprint): Returns every deployable blueprint with its service count and estimated monthly compute cost.
- [List health](/docs/openapi/blueprint/get-blueprint-health): Reports blueprint liveness and echoes the compute rate card in force.
- [List sbom](/docs/openapi/blueprint/get-blueprint-sbom): 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…
- [Books](/docs/openapi/books): Double-entry accounting: chart of accounts, ledger, bank reconciliation, and the reports that prove the books balance.
- [List accounts](/docs/openapi/books/get-books-accounts): Returns the org's chart of accounts — the seeded fixed chart every posting key in the ledger refers to.
- [List transactions](/docs/openapi/books/get-books-bank-transactions): 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…
- [List unreconciled](/docs/openapi/books/get-books-bank-unreconciled): 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…
- [Export books](/docs/openapi/books/get-books-export): 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…
- [List gl](/docs/openapi/books/get-books-gl): ListGL returns the org's most recent GL Entry rows, newest first.
- [List inbox](/docs/openapi/books/get-books-inbox): Returns the org's open document queue — everything uploaded but not yet booked, newest first, each with its extracted summary and the confidence the…
- [List metrics](/docs/openapi/books/get-books-metrics): Metrics returns the org's deterministic SaaS-metrics snapshot over an optional (from, to] window — MRR, ARR, revenue, COGS, burn, gross margin, net…
- [List pnl](/docs/openapi/books/get-books-pnl): 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](/docs/openapi/books/get-books-position): Returns the org's Balance Sheet as of `to` (empty = all time), with the Assets == Liabilities + Equity equation proof.
- [List questions](/docs/openapi/books/get-books-questions): Returns the clarifying questions the caller's own recent GL raises — the unusual postings a founder should look at (outliers, reversals, round-offs,…
- [List rules](/docs/openapi/books/get-books-rules): Returns the org's auto-categorization rules, highest priority first.
- [List transactions](/docs/openapi/books/get-books-transactions): 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…
- [List trial](/docs/openapi/books/get-books-trial): Returns the org's trial balance over an optional [from, to] window of RFC3339 posting times, including the opening/closing columns and the TotalDebit ==…
- [List vendors](/docs/openapi/books/get-books-vendors): 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…
- [Create ask](/docs/openapi/books/post-books-ask): 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…
- [Create exchange](/docs/openapi/books/post-books-bank-exchange): ANSWERS 501 UNCONDITIONALLY. It is the intended second hop of the bank-linking handshake — trade the provider's short-lived public token for the durable…
- [Import bank](/docs/openapi/books/post-books-bank-import): 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…
- [Sync bank](/docs/openapi/books/post-books-bank-sync): 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…
- [Create token](/docs/openapi/books/post-books-bank-token): ANSWERS 501 UNCONDITIONALLY. It is the intended first hop of the bank-linking handshake — mint the short-lived session token a browser hands to the…
- [Create inbox](/docs/openapi/books/post-books-inbox): Takes a document as RAW BYTES and queues it in the caller org's inbox as `unsorted`, answering the queued item.
- [Create rules](/docs/openapi/books/post-books-rules): 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](/docs/openapi/books/post-books-scan): 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…
- [Create book](/docs/openapi/books/post-books-scan-book): Posts a reviewed scanned bill to the ledger.
- [Sync books](/docs/openapi/books/post-books-sync): Sync 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](/docs/openapi/books/post-books-vendors): 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…
- [Bot](/docs/openapi/bot): A bot doing your work on a real desktop, live, while you watch.
- [List runs](/docs/openapi/bot/get-bot-runs): List 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…
- [Create runs](/docs/openapi/bot/post-bot-runs): Answers 501 to every call: launching a bot run is not implemented. The bot runtime exposes no launch operation, so nothing here can start a sandbox.
- [Stop runs](/docs/openapi/bot/post-bot-runs-by-runid-stop): Stop terminates one of the caller org's own bot runs and reports its terminal state.
- [Campaign](/docs/openapi/campaign): One go-to-market push across paid, organic and email at once.
- [Delete campaign](/docs/openapi/campaign/delete-campaign-by-id): Removes one campaign of the caller's org and answers 204 with no body. 404 when the org has no campaign with that id.
- [Delete channels](/docs/openapi/campaign/delete-campaign-by-id-channels-by-kind): Drops one channel from a campaign and returns the updated campaign. 404 when the campaign carries no channel of that kind.
- [List campaign](/docs/openapi/campaign/get-campaign): Returns the org's campaigns, newest first, optionally narrowed to one status.
- [Get campaign](/docs/openapi/campaign/get-campaign-by-id): 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](/docs/openapi/campaign/get-campaign-by-id-metrics): Returns a campaign's results over a window: the analytics funnel (impressions, clicks, conversions, revenue, visitors), the spend each channel's connector…
- [List summary](/docs/openapi/campaign/get-campaign-summary): 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…
- [Create campaign](/docs/openapi/campaign/post-campaign): Creates a campaign as a DRAFT and returns it.
- [Create channels](/docs/openapi/campaign/post-campaign-by-id-channels): Adds a channel to a campaign, or REPLACES the one it already has of that kind, and returns the updated campaign.
- [Launch campaign](/docs/openapi/campaign/post-campaign-by-id-launch): 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…
- [Create pause](/docs/openapi/campaign/post-campaign-by-id-pause): 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](/docs/openapi/campaign/put-campaign-by-id): Rewrites a campaign's core fields — name, audience, creatives, schedule and budget — and returns the updated campaign.
- [Captable](/docs/openapi/captable): Your cap table: stakeholders, share classes, grants, SAFEs, rounds, and who owns what.
- [Delete convertibles](/docs/openapi/captable/delete-captable-convertibles-by-id): Removes one of the caller org's convertible notes, taking its principal out of the cap table's unconverted-instrument totals.
- [Delete options](/docs/openapi/captable/delete-captable-options-by-id): 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](/docs/openapi/captable/delete-captable-safes-by-id): Removes one of the caller org's SAFEs, taking its capital out of the cap table's unconverted-instrument totals.
- [Delete shares](/docs/openapi/captable/delete-captable-shares-by-id): 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](/docs/openapi/captable/delete-captable-stakeholders-by-id): Removes one of the caller org's stakeholders.
- [List classes](/docs/openapi/captable/get-captable-classes): Returns the caller org's share classes, in creation order.
- [List company](/docs/openapi/captable/get-captable-company): Returns the caller org's cap-table company record.
- [List convertibles](/docs/openapi/captable/get-captable-convertibles): Returns the caller org's convertible notes, newest first.
- [List investments](/docs/openapi/captable/get-captable-investments): Returns the caller org's investments, newest first.
- [List options](/docs/openapi/captable/get-captable-options): Returns the caller org's option grants, newest first. Each row is joined to its grantee and its equity plan.
- [List plans](/docs/openapi/captable/get-captable-plans): Returns the caller org's equity plans, newest first.
- [List rounds](/docs/openapi/captable/get-captable-rounds): Returns the caller org's fundraising rounds, newest first.
- [Get rounds](/docs/openapi/captable/get-captable-rounds-by-id): Returns one of the caller org's fundraising rounds together with every investment written into it, oldest first.
- [List safes](/docs/openapi/captable/get-captable-safes): Returns the caller org's SAFEs, newest first.
- [List shares](/docs/openapi/captable/get-captable-shares): Returns the caller org's share certificates, newest first.
- [List stakeholders](/docs/openapi/captable/get-captable-stakeholders): Returns the caller org's stakeholders, newest first. The response is a bare JSON array, not an envelope.
- [List summary](/docs/openapi/captable/get-captable-summary): Computes the caller org's cap table. It answers who owns what on a fully-diluted basis: outstanding shares, granted options, per-stakeholder ownership…
- [Update classes](/docs/openapi/captable/patch-captable-classes-by-id): Replaces one share class's terms. It is a full REPLACE and not a merge, despite the PATCH: every field is written as sent, so a field omitted is written…
- [Update stakeholders](/docs/openapi/captable/patch-captable-stakeholders-by-id): Changes one of the caller org's stakeholders.
- [Create classes](/docs/openapi/captable/post-captable-classes): Defines a new class of shares. Every field but convertsToShareClassId is required — a class is the instrument every later issuance prices against, so a…
- [Create convertibles](/docs/openapi/captable/post-captable-convertibles): Records a convertible note.
- [Create options](/docs/openapi/captable/post-captable-options): Grants options to a stakeholder from an equity plan.
- [Create plans](/docs/openapi/captable/post-captable-plans): Opens an equity plan that options are granted from.
- [Create rounds](/docs/openapi/captable/post-captable-rounds): Opens a priced round that investments can be added to.
- [Create close](/docs/openapi/captable/post-captable-rounds-by-id-close): Closes one of the caller org's fundraising rounds, recording the close date and moving its status to CLOSED.
- [Create investments](/docs/openapi/captable/post-captable-rounds-by-id-investments): Records one investor's money into an open round. The round must be OPEN; investing into a closed one is refused.
- [Create safes](/docs/openapi/captable/post-captable-safes): Records a SAFE — a simple agreement for future equity.
- [Create shares](/docs/openapi/captable/post-captable-shares): Issues a share certificate to a stakeholder.
- [Create transfer](/docs/openapi/captable/post-captable-shares-transfer): Moves shares from one stakeholder to another. Omit `quantity` to transfer the whole certificate, which REASSIGNS it and mints no new share.
- [Create stakeholders](/docs/openapi/captable/post-captable-stakeholders): Records the people and institutions that can hold equity — the rows every share, option, SAFE, note and investment is issued to.
- [Replace company](/docs/openapi/captable/put-captable-company): Sets the caller org's company name and incorporation details.
- [Catalog](/docs/openapi/catalog): One place to browse every project, app and site built here.
- [List catalog](/docs/openapi/catalog/get-catalog): Browse searches AND browses the cross-org catalog: every project, app and site the fleet has built, whichever org built it.
- [Channels](/docs/openapi/channels): One inbox for the chat apps you connect — Discord, Slack, Teams, Telegram.
- [List channels](/docs/openapi/channels/get-channels): Reports every chat channel this org can send through, and whether it can send through it right now.
- [List allowlist](/docs/openapi/channels/get-channels-allowlist): 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…
- [List inbox](/docs/openapi/channels/get-channels-inbox): Returns the messages people have sent to the caller org's connected chat bots, oldest first, in the portable envelope shape every transport normalises…
- [List pairing](/docs/openapi/channels/get-channels-pairing): 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"…
- [Send channels](/docs/openapi/channels/post-channels-by-channel-send): Delivers text, attachments and actions to one room on a connected chat transport — discord, slack, teams, telegram or whatsapp — and answers that…
- [Approve pairing](/docs/openapi/channels/post-channels-pairing-approve): 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 allowlist](/docs/openapi/channels/put-channels-allowlist): Edits the caller org's access policy for one channel and answers the policy as GET would, so both verbs return ONE shape. It requires ORG ADMIN.
- [Cloudflare](/docs/openapi/cloudflare): Your Cloudflare account, managed from Hanzo: zones, Pages, Workers, Workers AI, R2, KV and D1.
- [Delete databases](/docs/openapi/cloudflare/delete-cloudflare-d1-databases-by-database): Deletes a D1 database and everything stored in it.
- [Delete namespaces](/docs/openapi/cloudflare/delete-cloudflare-kv-namespaces-by-namespace): KVNamespaceDelete deletes a Workers KV namespace and every key in it.
- [Delete values](/docs/openapi/cloudflare/delete-cloudflare-kv-namespaces-by-namespace-values-by-key): KVValueDelete removes one key from a Workers KV namespace.
- [Delete projects](/docs/openapi/cloudflare/delete-cloudflare-pages-projects-by-project): Deletes a Cloudflare Pages project, and with it every deployment it has ever made.
- [Delete domains](/docs/openapi/cloudflare/delete-cloudflare-pages-projects-by-project-domains-by-domain): Detaches a custom domain from a Cloudflare Pages project.
- [Delete buckets](/docs/openapi/cloudflare/delete-cloudflare-r2-buckets-by-bucket): Deletes an R2 bucket.
- [Delete scripts](/docs/openapi/cloudflare/delete-cloudflare-workers-scripts-by-script): Removes a Worker script from the org's Cloudflare account.
- [Delete routes](/docs/openapi/cloudflare/delete-cloudflare-workers-zones-by-zone-routes-by-route): Unbinds a Worker route, so its pattern stops dispatching to a script.
- [List databases](/docs/openapi/cloudflare/get-cloudflare-d1-databases): Lists the D1 databases on the org's Cloudflare account.
- [List namespaces](/docs/openapi/cloudflare/get-cloudflare-kv-namespaces): KVNamespaceList lists the Workers KV namespaces on the org's Cloudflare account.
- [Get values](/docs/openapi/cloudflare/get-cloudflare-kv-namespaces-by-namespace-values-by-key): 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,…
- [List projects](/docs/openapi/cloudflare/get-cloudflare-pages-projects): Lists the org's Cloudflare Pages projects.
- [Get projects](/docs/openapi/cloudflare/get-cloudflare-pages-projects-by-project): Reads one Cloudflare Pages project — its build config, deployment configs and latest deployment.
- [List buckets](/docs/openapi/cloudflare/get-cloudflare-r2-buckets): Lists the R2 buckets on the org's Cloudflare account.
- [List scripts](/docs/openapi/cloudflare/get-cloudflare-workers-scripts): Lists the Worker scripts on the org's Cloudflare account.
- [List subdomain](/docs/openapi/cloudflare/get-cloudflare-workers-subdomain): Reads the org account's workers.dev subdomain — the name under which every subdomain-enabled script is served.
- [List routes](/docs/openapi/cloudflare/get-cloudflare-workers-zones-by-zone-routes): Lists the Worker routes bound within one zone — the URL patterns that dispatch to a script. Any org member may read.
- [List zones](/docs/openapi/cloudflare/get-cloudflare-zones): Lists the Cloudflare zones the org's connected API token can see, paged and filtered by the query parameters Cloudflare itself accepts.
- [Get zones](/docs/openapi/cloudflare/get-cloudflare-zones-by-zone): Reads one Cloudflare zone the org's token can see.
- [List analytics](/docs/openapi/cloudflare/get-cloudflare-zones-by-zone-analytics): Reads a zone's Cloudflare traffic dashboard — requests, bandwidth, threats and pageviews over the since/until window. Any org member may read.
- [Create databases](/docs/openapi/cloudflare/post-cloudflare-d1-databases): Creates a D1 database on the org's Cloudflare account.
- [Query databases](/docs/openapi/cloudflare/post-cloudflare-d1-databases-by-database-query): Runs one SQL statement against a D1 database. It executes on the org's OWN Cloudflare account and relays D1's result set.
- [Create namespaces](/docs/openapi/cloudflare/post-cloudflare-kv-namespaces): KVNamespaceCreate creates a Workers KV namespace on the org's Cloudflare account. Requires org admin.
- [Create projects](/docs/openapi/cloudflare/post-cloudflare-pages-projects): Creates a Cloudflare Pages project on the org's account. Requires org admin.
- [Create deployments](/docs/openapi/cloudflare/post-cloudflare-pages-projects-by-project-deployments): 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](/docs/openapi/cloudflare/post-cloudflare-pages-projects-by-project-domains): Attaches a custom domain to a Cloudflare Pages project.
- [Create buckets](/docs/openapi/cloudflare/post-cloudflare-r2-buckets): Creates an R2 bucket on the org's Cloudflare account.
- [Create subdomain](/docs/openapi/cloudflare/post-cloudflare-workers-scripts-by-script-subdomain): Publishes or withdraws one Worker script on the account's workers.dev subdomain.
- [Create routes](/docs/openapi/cloudflare/post-cloudflare-workers-zones-by-zone-routes): Binds a URL pattern in a zone to a Worker script.
- [Create purge](/docs/openapi/cloudflare/post-cloudflare-zones-by-zone-purge): Drops a zone's Cloudflare edge cache — either the whole zone (purge_everything) or exactly the listed file URLs. Requires org admin.
- [Replace values](/docs/openapi/cloudflare/put-cloudflare-kv-namespaces-by-namespace-values-by-key): Stores one KV key on the org's OWN Cloudflare account.
- [Replace scripts](/docs/openapi/cloudflare/put-cloudflare-workers-scripts-by-script): Uploads or replaces a module Worker script.
- [Code](/docs/openapi/code): Search and symbols across your repos, for you and your agents.
- [List ask](/docs/openapi/code/get-code-ask): 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…
- [List file](/docs/openapi/code/get-code-file): 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](/docs/openapi/code/get-code-search): Finds code in the caller org's index across three orthogonal retrieval tiers fused by reciprocal-rank fusion: lexical (FTS5 trigram over code-tokenized…
- [List tree](/docs/openapi/code/get-code-tree): 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](/docs/openapi/code/post-code-ask): Is askGet with the question in the request BODY, for a question too long or too awkward to put in a URL.
- [Create context](/docs/openapi/code/post-code-context): 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](/docs/openapi/code/post-code-index): (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](/docs/openapi/commerce): Selling: checkout, subscriptions, invoices, spend alerts, payment webhooks and the storefront catalog.
- [Delete collection](/docs/openapi/commerce/delete-commerce-collection-by-collectionid): 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,…
- [Delete disclosure](/docs/openapi/commerce/delete-commerce-disclosure-by-disclosureid): A disclosure is a published-document record — a publication body, a content hash, a type and a named receiver.
- [Delete discount](/docs/openapi/commerce/delete-commerce-discount-by-discountid): 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…
- [Delete movie](/docs/openapi/commerce/delete-commerce-movie-by-movieid): 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…
- [Delete note](/docs/openapi/commerce/delete-commerce-note-by-noteid): A note is a timestamped free-text log line — a caller-supplied time, a source, a message and an enabled flag.
- [Delete entries](/docs/openapi/commerce/delete-commerce-plans-entries-by-slug): Deletes the addressed plan and answers 204.
- [Delete product](/docs/openapi/commerce/delete-commerce-product-by-productid): 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 —…
- [Delete entries](/docs/openapi/commerce/delete-commerce-rates-entries-by-product-by-meter): Deletes the row. ARCHIVING is usually what is wanted instead — a deleted rate cannot price a historical charge, so a past invoice that has to re-resolve…
- [Delete return](/docs/openapi/commerce/delete-commerce-return-by-returnid): 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…
- [Delete saleschannel](/docs/openapi/commerce/delete-commerce-saleschannel-by-saleschannelid): A sales channel is a named selling surface — a name, a description, a disabled flag and metadata.
- [Delete stocklocation](/docs/openapi/commerce/delete-commerce-stocklocation-by-stocklocationid): 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](/docs/openapi/commerce/delete-commerce-store-by-storeid): Removes the addressed store and answers 204 with no body.
- [Delete listing](/docs/openapi/commerce/delete-commerce-store-by-storeid-listing-by-key): Drops the key from the store's listing map and re-saves the store, answering 204 with no body.
- [Delete submission](/docs/openapi/commerce/delete-commerce-submission-by-submissionid): 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,…
- [Delete subscriber](/docs/openapi/commerce/delete-commerce-subscriber-by-subscriberid): 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](/docs/openapi/commerce/delete-commerce-tokentransaction-by-tokentransactionid): A token transaction records a transfer between two identified parties — amount and fees, a timestamp, sending and receiving addresses, names, user ids,…
- [Delete transfer](/docs/openapi/commerce/delete-commerce-transfer-by-transferid): A transfer records that a payable WAS PAID — the annotation a human writes after paying out of band.
- [Delete variant](/docs/openapi/commerce/delete-commerce-variant-by-variantid): 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…
- [Delete wallet](/docs/openapi/commerce/delete-commerce-wallet-by-walletid): 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…
- [Delete watchlist](/docs/openapi/commerce/delete-commerce-watchlist-by-watchlistid): A watchlist is a viewer's saved list of movies — a user id, an email, and the movies themselves.
- [Delete webhook](/docs/openapi/commerce/delete-commerce-webhook-by-webhookid): 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,…
- [Create discard](/docs/openapi/commerce/discardcart): Discards a cart the shopper abandoned, and answers it in its final state.
- [List catalog](/docs/openapi/commerce/get-commerce-catalog): 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…
- [List entries](/docs/openapi/commerce/get-commerce-catalog-entries): Returns every catalog row as stored — the admin view, which unlike the public projection includes entries that are not published.
- [List collection](/docs/openapi/commerce/get-commerce-collection): 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,…
- [Get collection](/docs/openapi/commerce/get-commerce-collection-by-collectionid): 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,…
- [List currencies](/docs/openapi/commerce/get-commerce-currencies): 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 deposits](/docs/openapi/commerce/get-commerce-deposits): Reports whether the deposit watcher is running, its poll interval, and one row per armed asset: chain, token, contract, pooled address and the last block…
- [List disclosure](/docs/openapi/commerce/get-commerce-disclosure): A disclosure is a published-document record — a publication body, a content hash, a type and a named receiver.
- [Get disclosure](/docs/openapi/commerce/get-commerce-disclosure-by-disclosureid): A disclosure is a published-document record — a publication body, a content hash, a type and a named receiver.
- [List discount](/docs/openapi/commerce/get-commerce-discount): 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…
- [Get discount](/docs/openapi/commerce/get-commerce-discount-by-discountid): 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…
- [List health](/docs/openapi/commerce/get-commerce-health): Answers ok whenever the commerce subsystem is mounted.
- [List movie](/docs/openapi/commerce/get-commerce-movie): 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…
- [Get movie](/docs/openapi/commerce/get-commerce-movie-by-movieid): 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…
- [List note](/docs/openapi/commerce/get-commerce-note): A note is a timestamped free-text log line — a caller-supplied time, a source, a message and an enabled flag.
- [Get note](/docs/openapi/commerce/get-commerce-note-by-noteid): A note is a timestamped free-text log line — a caller-supplied time, a source, a message and an enabled flag.
- [List org](/docs/openapi/commerce/get-commerce-org): Answers the branding, identity issuer and client id, identity-verification config, enabled payment providers, return-URL allowlist and public payment…
- [List entries](/docs/openapi/commerce/get-commerce-plans-entries): Returns every plan row as stored — the administrative view behind the public plan catalog.
- [List product](/docs/openapi/commerce/get-commerce-product): 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 —…
- [Get product](/docs/openapi/commerce/get-commerce-product-by-productid): 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 —…
- [List entries](/docs/openapi/commerce/get-commerce-rates-entries): Returns the rate authority's rows — the prices every metered charge resolves against.
- [List return](/docs/openapi/commerce/get-commerce-return): 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…
- [Get return](/docs/openapi/commerce/get-commerce-return-by-returnid): 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…
- [List saleschannel](/docs/openapi/commerce/get-commerce-saleschannel): A sales channel is a named selling surface — a name, a description, a disabled flag and metadata.
- [Get saleschannel](/docs/openapi/commerce/get-commerce-saleschannel-by-saleschannelid): A sales channel is a named selling surface — a name, a description, a disabled flag and metadata.
- [List stocklocation](/docs/openapi/commerce/get-commerce-stocklocation): 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](/docs/openapi/commerce/get-commerce-stocklocation-by-stocklocationid): 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](/docs/openapi/commerce/get-commerce-store): 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 access](/docs/openapi/commerce/get-commerce-store-access): Answers allowed, the store id, and a status of trial, active, payment_required, store_required or unavailable — the entitlement check a merchant surface…
- [Get store](/docs/openapi/commerce/get-commerce-store-by-storeid): 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…
- [Get bundle](/docs/openapi/commerce/get-commerce-store-by-storeid-bundle-by-key): 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…
- [List listing](/docs/openapi/commerce/get-commerce-store-by-storeid-listing): Returns every override this store applies to catalog items — name, price, list price, media, availability and the hidden flag — keyed by product or…
- [Get listing](/docs/openapi/commerce/get-commerce-store-by-storeid-listing-by-key): 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…
- [Get product](/docs/openapi/commerce/get-commerce-store-by-storeid-product-by-key): 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…
- [Get variant](/docs/openapi/commerce/get-commerce-store-by-storeid-variant-by-key): 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…
- [List current](/docs/openapi/commerce/get-commerce-store-current): 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…
- [List submission](/docs/openapi/commerce/get-commerce-submission): 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,…
- [Get submission](/docs/openapi/commerce/get-commerce-submission-by-submissionid): 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,…
- [List subscriber](/docs/openapi/commerce/get-commerce-subscriber): 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](/docs/openapi/commerce/get-commerce-subscriber-by-subscriberid): 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](/docs/openapi/commerce/get-commerce-tokentransaction): A token transaction records a transfer between two identified parties — amount and fees, a timestamp, sending and receiving addresses, names, user ids,…
- [Get tokentransaction](/docs/openapi/commerce/get-commerce-tokentransaction-by-tokentransactionid): A token transaction records a transfer between two identified parties — amount and fees, a timestamp, sending and receiving addresses, names, user ids,…
- [List transfer](/docs/openapi/commerce/get-commerce-transfer): A transfer records that a payable WAS PAID — the annotation a human writes after paying out of band.
- [Get transfer](/docs/openapi/commerce/get-commerce-transfer-by-transferid): A transfer records that a payable WAS PAID — the annotation a human writes after paying out of band.
- [List variant](/docs/openapi/commerce/get-commerce-variant): 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…
- [Get variant](/docs/openapi/commerce/get-commerce-variant-by-variantid): 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…
- [List wallet](/docs/openapi/commerce/get-commerce-wallet): 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…
- [Get wallet](/docs/openapi/commerce/get-commerce-wallet-by-walletid): 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…
- [List watchlist](/docs/openapi/commerce/get-commerce-watchlist): A watchlist is a viewer's saved list of movies — a user id, an email, and the movies themselves.
- [Get watchlist](/docs/openapi/commerce/get-commerce-watchlist-by-watchlistid): A watchlist is a viewer's saved list of movies — a user id, an email, and the movies themselves.
- [List webhook](/docs/openapi/commerce/get-commerce-webhook): 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,…
- [Get webhook](/docs/openapi/commerce/get-commerce-webhook-by-webhookid): 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,…
- [Get cart](/docs/openapi/commerce/getcart): Reads one cart: its lines, its status and what it comes to.
- [Get payments](/docs/openapi/commerce/getpayment): Reads one settled payment out of the caller's org ledger.
- [Create cart](/docs/openapi/commerce/opencart): Opens an empty cart for a shopper to fill, and answers it with its new id.
- [Update collection](/docs/openapi/commerce/patch-commerce-collection-by-collectionid): 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,…
- [Update disclosure](/docs/openapi/commerce/patch-commerce-disclosure-by-disclosureid): A disclosure is a published-document record — a publication body, a content hash, a type and a named receiver.
- [Update discount](/docs/openapi/commerce/patch-commerce-discount-by-discountid): 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…
- [Update movie](/docs/openapi/commerce/patch-commerce-movie-by-movieid): 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…
- [Update note](/docs/openapi/commerce/patch-commerce-note-by-noteid): A note is a timestamped free-text log line — a caller-supplied time, a source, a message and an enabled flag.
- [Update product](/docs/openapi/commerce/patch-commerce-product-by-productid): 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 —…
- [Update return](/docs/openapi/commerce/patch-commerce-return-by-returnid): 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…
- [Update saleschannel](/docs/openapi/commerce/patch-commerce-saleschannel-by-saleschannelid): A sales channel is a named selling surface — a name, a description, a disabled flag and metadata.
- [Update stocklocation](/docs/openapi/commerce/patch-commerce-stocklocation-by-stocklocationid): 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](/docs/openapi/commerce/patch-commerce-store-by-storeid): 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…
- [Update listing](/docs/openapi/commerce/patch-commerce-store-by-storeid-listing-by-key): Requires the key to already be present — an absent one is 404 — and answers the store's listing map at 200.
- [Update submission](/docs/openapi/commerce/patch-commerce-submission-by-submissionid): 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,…
- [Update subscriber](/docs/openapi/commerce/patch-commerce-subscriber-by-subscriberid): 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](/docs/openapi/commerce/patch-commerce-tokentransaction-by-tokentransactionid): A token transaction records a transfer between two identified parties — amount and fees, a timestamp, sending and receiving addresses, names, user ids,…
- [Update transfer](/docs/openapi/commerce/patch-commerce-transfer-by-transferid): A transfer records that a payable WAS PAID — the annotation a human writes after paying out of band.
- [Update variant](/docs/openapi/commerce/patch-commerce-variant-by-variantid): 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…
- [Update wallet](/docs/openapi/commerce/patch-commerce-wallet-by-walletid): 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…
- [Update watchlist](/docs/openapi/commerce/patch-commerce-watchlist-by-watchlistid): A watchlist is a viewer's saved list of movies — a user id, an email, and the movies themselves.
- [Update webhook](/docs/openapi/commerce/patch-commerce-webhook-by-webhookid): 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,…
- [Create entries](/docs/openapi/commerce/post-commerce-catalog-entries): Creates a catalog row from the body and answers it at 201.
- [Create models](/docs/openapi/commerce/post-commerce-catalog-models): 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](/docs/openapi/commerce/post-commerce-catalog-models-refresh): 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…
- [Create seed](/docs/openapi/commerce/post-commerce-catalog-seed): Upserts the shipped catalog seed and answers how many entries it created.
- [Create collection](/docs/openapi/commerce/post-commerce-collection): 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,…
- [Create collection](/docs/openapi/commerce/post-commerce-collection-by-collectionid): 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,…
- [Create disclosure](/docs/openapi/commerce/post-commerce-disclosure): A disclosure is a published-document record — a publication body, a content hash, a type and a named receiver.
- [Create disclosure](/docs/openapi/commerce/post-commerce-disclosure-by-disclosureid): A disclosure is a published-document record — a publication body, a content hash, a type and a named receiver.
- [Create discount](/docs/openapi/commerce/post-commerce-discount): 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…
- [Create discount](/docs/openapi/commerce/post-commerce-discount-by-discountid): 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…
- [Create movie](/docs/openapi/commerce/post-commerce-movie): 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…
- [Create movie](/docs/openapi/commerce/post-commerce-movie-by-movieid): 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…
- [Create note](/docs/openapi/commerce/post-commerce-note): A note is a timestamped free-text log line — a caller-supplied time, a source, a message and an enabled flag.
- [Create note](/docs/openapi/commerce/post-commerce-note-by-noteid): A note is a timestamped free-text log line — a caller-supplied time, a source, a message and an enabled flag.
- [Create entries](/docs/openapi/commerce/post-commerce-plans-entries): Creates a plan from the body and answers it at 201.
- [Create seed](/docs/openapi/commerce/post-commerce-plans-seed): Upserts the shipped plan rows and answers how many were created and how many corrected.
- [Create product](/docs/openapi/commerce/post-commerce-product): 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 —…
- [Create product](/docs/openapi/commerce/post-commerce-product-by-productid): 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 —…
- [Create entries](/docs/openapi/commerce/post-commerce-rates-entries): Creates one rate. Product AND meter are both required, because together they are the identity: a rate keyed on the metered thing alone would let one…
- [Import rates](/docs/openapi/commerce/post-commerce-rates-import): Takes an array of rates and seeds the authority from it — the same reconcile the boot catalog runs, driven from admin instead.
- [Create return](/docs/openapi/commerce/post-commerce-return): 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…
- [Create return](/docs/openapi/commerce/post-commerce-return-by-returnid): 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…
- [Create saleschannel](/docs/openapi/commerce/post-commerce-saleschannel): A sales channel is a named selling surface — a name, a description, a disabled flag and metadata.
- [Create saleschannel](/docs/openapi/commerce/post-commerce-saleschannel-by-saleschannelid): A sales channel is a named selling surface — a name, a description, a disabled flag and metadata.
- [Create stocklocation](/docs/openapi/commerce/post-commerce-stocklocation): 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](/docs/openapi/commerce/post-commerce-stocklocation-by-stocklocationid): 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](/docs/openapi/commerce/post-commerce-store): 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…
- [Create store](/docs/openapi/commerce/post-commerce-store-by-storeid): 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…
- [Create authorize](/docs/openapi/commerce/post-commerce-store-by-storeid-authorize): 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…
- [Create authorize](/docs/openapi/commerce/post-commerce-store-by-storeid-authorize-by-orderid): Continues the order named in the path rather than minting a new one, holding funds for it.
- [Create capture](/docs/openapi/commerce/post-commerce-store-by-storeid-capture-by-orderid): 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](/docs/openapi/commerce/post-commerce-store-by-storeid-charge): 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](/docs/openapi/commerce/post-commerce-store-by-storeid-checkout-authorize): Authorizes a new order for the addressed store and holds the funds, answering the saved order with a Location header.
- [Create authorize](/docs/openapi/commerce/post-commerce-store-by-storeid-checkout-authorize-by-orderid): 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](/docs/openapi/commerce/post-commerce-store-by-storeid-checkout-capture-by-orderid): 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…
- [Create charge](/docs/openapi/commerce/post-commerce-store-by-storeid-checkout-charge): Performs authorization and capture back to back against a newly created order for the addressed store, on the same handler as the unprefixed charge…
- [Create cancel](/docs/openapi/commerce/post-commerce-store-by-storeid-checkout-paypal-cancel-by-paykey): 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…
- [Create confirm](/docs/openapi/commerce/post-commerce-store-by-storeid-checkout-paypal-confirm-by-paykey): 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…
- [Create pay](/docs/openapi/commerce/post-commerce-store-by-storeid-checkout-paypal-pay): Begins a PayPal authorization by running the ordinary store authorize flow, since the route binds that exact handler — body, store resolution, tally,…
- [Create listing](/docs/openapi/commerce/post-commerce-store-by-storeid-listing-by-key): 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](/docs/openapi/commerce/post-commerce-store-by-storeid-paypal-cancel-by-paykey): 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…
- [Create confirm](/docs/openapi/commerce/post-commerce-store-by-storeid-paypal-confirm-by-paykey): 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:…
- [Create pay](/docs/openapi/commerce/post-commerce-store-by-storeid-paypal-pay): 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…
- [Create trial](/docs/openapi/commerce/post-commerce-store-by-storeid-trial): 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…
- [Create token](/docs/openapi/commerce/post-commerce-store-token): Answers a freshly minted token carrying ONLY the published-read permission — enough for a logged-out shopper's storefront to read your published catalog…
- [Create submission](/docs/openapi/commerce/post-commerce-submission): 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,…
- [Create submission](/docs/openapi/commerce/post-commerce-submission-by-submissionid): 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,…
- [Create subscriber](/docs/openapi/commerce/post-commerce-subscriber): 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](/docs/openapi/commerce/post-commerce-subscriber-by-subscriberid): 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](/docs/openapi/commerce/post-commerce-tokentransaction): A token transaction records a transfer between two identified parties — amount and fees, a timestamp, sending and receiving addresses, names, user ids,…
- [Create tokentransaction](/docs/openapi/commerce/post-commerce-tokentransaction-by-tokentransactionid): A token transaction records a transfer between two identified parties — amount and fees, a timestamp, sending and receiving addresses, names, user ids,…
- [Create transfer](/docs/openapi/commerce/post-commerce-transfer): A transfer records that a payable WAS PAID — the annotation a human writes after paying out of band.
- [Create transfer](/docs/openapi/commerce/post-commerce-transfer-by-transferid): A transfer records that a payable WAS PAID — the annotation a human writes after paying out of band.
- [Create variant](/docs/openapi/commerce/post-commerce-variant): 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…
- [Create variant](/docs/openapi/commerce/post-commerce-variant-by-variantid): 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…
- [Create wallet](/docs/openapi/commerce/post-commerce-wallet): 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…
- [Create wallet](/docs/openapi/commerce/post-commerce-wallet-by-walletid): 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…
- [Create watchlist](/docs/openapi/commerce/post-commerce-watchlist): A watchlist is a viewer's saved list of movies — a user id, an email, and the movies themselves.
- [Create watchlist](/docs/openapi/commerce/post-commerce-watchlist-by-watchlistid): A watchlist is a viewer's saved list of movies — a user id, an email, and the movies themselves.
- [Create webhook](/docs/openapi/commerce/post-commerce-webhook): 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,…
- [Create webhook](/docs/openapi/commerce/post-commerce-webhook-by-webhookid): 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,…
- [Create webhooks](/docs/openapi/commerce/post-commerce-webhooks-by-provider): Accepts a payment provider's event, verifies it, records it for audit, and applies subscription lifecycle changes to the matching local row.
- [Replace collection](/docs/openapi/commerce/put-commerce-collection-by-collectionid): 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,…
- [Replace disclosure](/docs/openapi/commerce/put-commerce-disclosure-by-disclosureid): A disclosure is a published-document record — a publication body, a content hash, a type and a named receiver.
- [Replace discount](/docs/openapi/commerce/put-commerce-discount-by-discountid): 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…
- [Replace movie](/docs/openapi/commerce/put-commerce-movie-by-movieid): 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…
- [Replace note](/docs/openapi/commerce/put-commerce-note-by-noteid): A note is a timestamped free-text log line — a caller-supplied time, a source, a message and an enabled flag.
- [Replace entries](/docs/openapi/commerce/put-commerce-plans-entries-by-slug): Loads the addressed plan, applies the body over it and answers the stored result, so a partial edit never silently zeroes a price or the contact-sales…
- [Replace product](/docs/openapi/commerce/put-commerce-product-by-productid): 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 —…
- [Replace entries](/docs/openapi/commerce/put-commerce-rates-entries-by-product-by-meter): Edits one rate and MARKS it edited, which is the whole contract with the importer: an operator's price outranks the document it came from, so a later…
- [Replace return](/docs/openapi/commerce/put-commerce-return-by-returnid): 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…
- [Replace saleschannel](/docs/openapi/commerce/put-commerce-saleschannel-by-saleschannelid): A sales channel is a named selling surface — a name, a description, a disabled flag and metadata.
- [Replace stocklocation](/docs/openapi/commerce/put-commerce-stocklocation-by-stocklocationid): 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](/docs/openapi/commerce/put-commerce-store-by-storeid): 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…
- [Replace listing](/docs/openapi/commerce/put-commerce-store-by-storeid-listing-by-key): 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…
- [Replace submission](/docs/openapi/commerce/put-commerce-submission-by-submissionid): 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,…
- [Replace subscriber](/docs/openapi/commerce/put-commerce-subscriber-by-subscriberid): 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](/docs/openapi/commerce/put-commerce-tokentransaction-by-tokentransactionid): A token transaction records a transfer between two identified parties — amount and fees, a timestamp, sending and receiving addresses, names, user ids,…
- [Replace transfer](/docs/openapi/commerce/put-commerce-transfer-by-transferid): A transfer records that a payable WAS PAID — the annotation a human writes after paying out of band.
- [Replace variant](/docs/openapi/commerce/put-commerce-variant-by-variantid): 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…
- [Replace wallet](/docs/openapi/commerce/put-commerce-wallet-by-walletid): 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…
- [Replace watchlist](/docs/openapi/commerce/put-commerce-watchlist-by-watchlistid): A watchlist is a viewer's saved list of movies — a user id, an email, and the movies themselves.
- [Replace webhook](/docs/openapi/commerce/put-commerce-webhook-by-webhookid): 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,…
- [Create item](/docs/openapi/commerce/setcartitem): Sets how many of one item a cart holds, and answers the whole updated cart. This is the ONE way a cart's contents change.
- [Create payments](/docs/openapi/commerce/takepayment): Takes a payment: charges a single-use card token and credits the caller's org balance, exactly once.
- [Company](/docs/openapi/company): Incorporation end to end: pick a structure, add founders, pay, file, and e-sign.
- [List company](/docs/openapi/company/get-company): Get returns the caller org's formation and the stages reachable from it, or 404 when the org has not begun one.
- [List register](/docs/openapi/company/get-company-register): Returns the platform's whole formation register, newest activity first — every org's formation, not the caller's.
- [List summary](/docs/openapi/company/get-company-register-summary): 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…
- [List review](/docs/openapi/company/get-company-review): 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](/docs/openapi/company/post-company): Begin starts the org's one formation and returns it with the stages reachable from it.
- [Create advance](/docs/openapi/company/post-company-advance): Advance runs the ONE guarded transition of the formation machine.
- [Create documents](/docs/openapi/company/post-company-documents): 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…
- [Create ein](/docs/openapi/company/post-company-ein): Opens the EIN application and answers what it owes.
- [Create esign](/docs/openapi/company/post-company-esign): Sends the generated formation documents for signature by every founder and records the provider's reference on the formation.
- [Complete esign](/docs/openapi/company/post-company-esign-complete): Records whether the formation documents have been signed.
- [Create founders](/docs/openapi/company/post-company-founders): Replaces the formation's founders. Each founder needs a name, an email and an equity share in basis points; every founder is (re)set to pending KYC, so a…
- [Create deck](/docs/openapi/company/post-company-fundraise-deck): 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](/docs/openapi/company/post-company-fundraise-round): Records a fundraising round on the org's canonical cap table.
- [Create safe](/docs/openapi/company/post-company-fundraise-safe): 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](/docs/openapi/company/post-company-genesis): Seeds the canonical cap table with the founding allocation (stakeholders, a common share class, issued shares) and anchors the deterministic…
- [Create captable](/docs/openapi/company/post-company-import-captable): Reads an existing company's cap table from a Google Sheet and adds its stakeholders to the canonical cap table.
- [Create documents](/docs/openapi/company/post-company-import-documents): Ingests an existing company's corporate documents from a Google Drive folder into the org's data room.
- [Create kyc](/docs/openapi/company/post-company-kyc): StartKYC opens an identity-verification session for every founder with the wired provider and records each session's reference on the formation.
- [Create decision](/docs/openapi/company/post-company-kyc-decision): DecideKYC records a privileged reviewer's MANUAL decision on a founder's KYC — the human-in-the-loop path, and the ONLY route to a pass when no real…
- [Refresh kyc](/docs/openapi/company/post-company-kyc-refresh): RefreshKYC reconciles each pending founder's KYC with the WIRED provider — the PULL path to a provider-reported terminal status.
- [Create payment](/docs/openapi/company/post-company-payment): Charges the caller's own org the one-time Hanzo Company formation fee.
- [Create skip](/docs/openapi/company/post-company-skip): Skip 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…
- [Create tariff](/docs/openapi/company/post-company-tariff): Itemises what a formation costs before anyone commits to it.
- [Replace structure](/docs/openapi/company/put-company-structure): Records the entity kind, the state of formation and the proposed name.
- [Compliance](/docs/openapi/compliance): Your KYC/KYB onboarding, accreditation records, and the evidence trail behind them.
- [List accreditation](/docs/openapi/compliance/get-compliance-accreditation): Returns the org's tracked accreditation-state records, newest first — evidence entries the org keeps, never a platform certification.
- [Get accreditation](/docs/openapi/compliance/get-compliance-accreditation-by-id): Returns one tracked accreditation record.
- [List audit](/docs/openapi/compliance/get-compliance-audit): AuditRead is the compliance read of the SHARED tamper-evident audit plane — the SOC 2 posture surface (privileged actions: who started/decided what,…
- [List health](/docs/openapi/compliance/get-compliance-health): Health reports subsystem liveness and the wired verification provider.
- [List records](/docs/openapi/compliance/get-compliance-records): ListRecords is the unified compliance-record view for the org: its verifications and accreditation records together, each provider-reported or tracked,…
- [List status](/docs/openapi/compliance/get-compliance-status): Status is the org's honest posture read: the wired provider and the per-status tally of its verifications.
- [List subjects](/docs/openapi/compliance/get-compliance-subjects): Returns the org's subjects as PII-MINIMIZED summaries — no name or email, only whether an email is on file.
- [Get subjects](/docs/openapi/compliance/get-compliance-subjects-by-id): Returns one subject WITH its contact PII — the only surface that returns it, and only to the owning org.
- [List verifications](/docs/openapi/compliance/get-compliance-verifications): Returns the org's KYC/KYB verifications, newest first — opaque subject references and provider-reported statuses only, no subject PII.
- [Get verifications](/docs/openapi/compliance/get-compliance-verifications-by-id): Returns one verification — its opaque subject reference and provider-reported status, no subject PII.
- [Create accreditation](/docs/openapi/compliance/post-compliance-accreditation): Records an ASSERTED accreditation state for a subject — the subject's own assertion, with no verifier.
- [Create decision](/docs/openapi/compliance/post-compliance-accreditation-by-id-decision): Records an org reviewer's decision on an accreditation record — a reviewer confirmation, a provider verification the reviewer has evidence of (a…
- [Create subjects](/docs/openapi/compliance/post-compliance-subjects): Records a party the org is verifying as part of its own onboarding/compliance — a team member, vendor, customer, or counterparty.
- [Create verifications](/docs/openapi/compliance/post-compliance-verifications): 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](/docs/openapi/compliance/post-compliance-verifications-by-id-decision): 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…
- [Refresh verifications](/docs/openapi/compliance/post-compliance-verifications-by-id-refresh): Polls the wired provider for its current decision and records it, ATTRIBUTED to the provider — the internal PULL reconcile.
- [Create webhook](/docs/openapi/compliance/post-compliance-verifications-webhook): The external PUSH reconcile: a verification provider (or a Hanzo relay) signals that a check settled, and the reconciled check comes back.
- [Content](/docs/openapi/content): Marketing content from draft to published, on every channel.
- [List board](/docs/openapi/content/get-content-board): 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 channels](/docs/openapi/content/get-content-channels): Lists the distribution channels the caller's org has connected — the social integrations a publish can target.
- [List lifecycle](/docs/openapi/content/get-content-lifecycle): 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…
- [Create transition](/docs/openapi/content/post-content-by-doctype-by-name-transition): 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](/docs/openapi/content/post-content-generate): Draft a piece of marketing content and file it in the CMS as a draft.
- [Publish content](/docs/openapi/content/post-content-publish): Publish distributes one CMS content item to the channels recorded on it and returns the honest per-channel outcome.
- [Crawl](/docs/openapi/crawl): Any web page turned into clean markdown a model can read.
- [Create crawl](/docs/openapi/crawl/read-page): Reads one URL and answers with the page as markdown.
- [CRM](/docs/openapi/crm): Your sales pipeline: the companies, the people, the deals in play.
- [Delete companies](/docs/openapi/crm/delete-crm-companies-by-id): Removes one of the caller org's companies and answers 204.
- [Delete contacts](/docs/openapi/crm/delete-crm-contacts-by-id): Removes one of the caller org's contacts and answers 204.
- [Delete opportunities](/docs/openapi/crm/delete-crm-opportunities-by-id): Removes one of the caller org's deals and answers 204.
- [List applications](/docs/openapi/crm/get-crm-applications): Returns the org's Startup Program applications, newest first.
- [Get applications](/docs/openapi/crm/get-crm-applications-by-id): Returns one Startup Program application with its AI screen and stage history.
- [List companies](/docs/openapi/crm/get-crm-companies): Returns the caller org's companies, most recently updated first.
- [Get companies](/docs/openapi/crm/get-crm-companies-by-id): Returns one of the caller org's companies.
- [List contacts](/docs/openapi/crm/get-crm-contacts): Returns the caller org's contacts, most recently updated first.
- [Get contacts](/docs/openapi/crm/get-crm-contacts-by-id): Returns one of the caller org's contacts.
- [List opportunities](/docs/openapi/crm/get-crm-opportunities): Returns the caller org's deals, most recently updated first.
- [Get opportunities](/docs/openapi/crm/get-crm-opportunities-by-id): Returns one of the caller org's deals.
- [List summary](/docs/openapi/crm/get-crm-summary): Summary counts the caller org's CRM records: companies, contacts, opportunities.
- [Update applications](/docs/openapi/crm/patch-crm-applications-by-id): Moves one Startup Program application through the pipeline.
- [Create applications](/docs/openapi/crm/post-crm-applications): Files an application to the Startup Program and answers the id and pipeline stage it landed at. This is the ONE unauthenticated route in crm.
- [Create companies](/docs/openapi/crm/post-crm-companies): Adds a company to the caller's org and answers 201 with the stored record.
- [Create contacts](/docs/openapi/crm/post-crm-contacts): Adds a person to the caller's org and answers 201 with the stored record.
- [Create opportunities](/docs/openapi/crm/post-crm-opportunities): Adds a deal to the caller's org and answers 201 with the stored record.
- [Replace companies](/docs/openapi/crm/put-crm-companies-by-id): Replaces one of the caller org's companies.
- [Replace contacts](/docs/openapi/crm/put-crm-contacts-by-id): Replaces one of the caller org's contacts.
- [Replace opportunities](/docs/openapi/crm/put-crm-opportunities-by-id): Replaces one of the caller org's deals. Every writable field is taken from the request, so a field the request omits is CLEARED — send the whole record.
- [Dataroom](/docs/openapi/dataroom): A secure document room you share by link and watch page by page.
- [Get dataroom](/docs/openapi/dataroom/get-dataroom-analytics-dataroom-by-dataroomid): 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](/docs/openapi/dataroom/get-dataroom-analytics-link-by-linkid): 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…
- [List datarooms](/docs/openapi/dataroom/get-dataroom-datarooms): Returns every data room in the caller org's own store, newest first, with its short public id, name, description and timestamps.
- [Get datarooms](/docs/openapi/dataroom/get-dataroom-datarooms-by-id): 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](/docs/openapi/dataroom/get-dataroom-documents): 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](/docs/openapi/dataroom/get-dataroom-documents-by-id): Reads one of the caller org's documents — its name, opaque storage key, content type, page count, size and timestamps.
- [List file](/docs/openapi/dataroom/get-dataroom-documents-by-id-file): 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…
- [List health](/docs/openapi/dataroom/get-dataroom-health): Health reports that the data room subsystem is up.
- [List links](/docs/openapi/dataroom/get-dataroom-links): 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…
- [List trust](/docs/openapi/dataroom/get-dataroom-trust): 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](/docs/openapi/dataroom/get-dataroom-trust-center-by-slug): 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](/docs/openapi/dataroom/get-dataroom-trust-center-by-slug-file-by-item): 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…
- [Get view](/docs/openapi/dataroom/get-dataroom-view-by-linkid): 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…
- [List file](/docs/openapi/dataroom/get-dataroom-view-by-linkid-document-by-documentid-file): 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,…
- [Update artifacts](/docs/openapi/dataroom/patch-dataroom-trust-artifacts-by-id): Amend 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…
- [Create datarooms](/docs/openapi/dataroom/post-dataroom-datarooms): Opens a new data room for the caller org and answers with it, including the short public id it is addressed by.
- [Create documents](/docs/openapi/dataroom/post-dataroom-datarooms-by-id-documents): Puts an already-uploaded document into one of the caller org's data rooms and answers with the new membership id.
- [Create documents](/docs/openapi/dataroom/post-dataroom-documents): 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,…
- [Create links](/docs/openapi/dataroom/post-dataroom-links): 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…
- [Create artifacts](/docs/openapi/dataroom/post-dataroom-trust-artifacts): Publish puts an item on the caller org's trust centre and answers with it.
- [Create requests](/docs/openapi/dataroom/post-dataroom-trust-center-by-slug-requests): Records a request to read what an independent auditor signed, and answers with its id. The org that owns the centre decides.
- [Create grant](/docs/openapi/dataroom/post-dataroom-trust-requests-by-id-grant): Grant 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,…
- [Create refuse](/docs/openapi/dataroom/post-dataroom-trust-requests-by-id-refuse): Refuse answers a request by declining it, recording who declined and why. Nothing is released and no link is minted.
- [Create authenticate](/docs/openapi/dataroom/post-dataroom-view-by-linkid-authenticate): Clears the link's access controls and answers with the viewing session — a `viewId`, whether download is permitted, and the documents behind the link —…
- [Create pageview](/docs/openapi/dataroom/post-dataroom-view-by-linkid-pageview): Appends a single per-page analytics event — {viewId, pageNumber, documentId, versionNumber, duration} — and answers with its id.
- [Replace trust](/docs/openapi/dataroom/put-dataroom-trust): SetCenter opens, publishes or withdraws the caller org's trust centre and answers with the centre as it now stands.
- [Dataset](/docs/openapi/dataset): 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…
- [Create dataset](/docs/openapi/dataset/riskcreatedataset): Declares the next version of a dataset from a bound query over this org's own feature surface.
- [Get dataset](/docs/openapi/dataset/riskdataset): Dataset 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…
- [List lineage](/docs/openapi/dataset/riskdatasetlineage): Shows where a version's rows came from and whether that can still be demonstrated.
- [List dataset](/docs/openapi/dataset/riskdatasets): Datasets lists this org's datasets, each with its newest version.
- [Delete dataset](/docs/openapi/dataset/riskdeletedataset): Disposes of one dataset and every version of it: the rows are dropped and the register is marked with what went. This is the ONLY expiry in this plane.
- [Export dataset](/docs/openapi/dataset/riskexportdataset): Reads a published version's rows back, one bounded page at a time, in the version's own stable row order. Only a published version can be exported.
- [Create materialize](/docs/openapi/dataset/riskmaterializedataset): Builds the declared version into immutable rows and answers 202 as soon as the attempt is on record.
- [Deploy](/docs/openapi/deploy): Hanzo CD: see what each app is running, sync it, and roll back a bad release.
- [List applications](/docs/openapi/deploy/get-deploy-applications): Returns the fleet as an argocd ApplicationList: one projected Application per operator App CR, carrying the image tag the CR DECLARES, the tag actually…
- [Get applications](/docs/openapi/deploy/get-deploy-applications-by-name): Returns ONE projected argocd Application by name, with status.resources filled in from its reconciled resource tree — which is what makes it the detail…
- [List resource tree](/docs/openapi/deploy/get-deploy-applications-by-name-resource-tree): Returns one application's argocd ApplicationTree: the objects the operator reconciled from its App CR, reached by ownerRef — the Deployment and, under it,…
- [List metadata](/docs/openapi/deploy/get-deploy-applications-by-name-revisions-by-revision-metadata): Returns the argocd RevisionMetadata for one revision of one application — what the detail view shows beside a revision.
- [List syncwindows](/docs/openapi/deploy/get-deploy-applications-by-name-syncwindows): Returns one application's argocd ApplicationSyncWindowState — the answer to "is anything blocking a sync of this application right now?".
- [List callback](/docs/openapi/deploy/get-deploy-callback): Completes the redirect from IAM: it validates `state` against the single-use flow cookie in constant time, redeems the authorization code with the PKCE…
- [List clusters](/docs/openapi/deploy/get-deploy-clusters): Returns the argocd ClusterList of the destinations the caller's applications reconcile into: one entry per distinct destination server, carrying the count…
- [List gitops](/docs/openapi/deploy/get-deploy-gitops): Lists every Hanzo CD Application in the cluster: the git source each one polls, the commit it last APPLIED, how its last sync operation ended, and its…
- [List health](/docs/openapi/deploy/get-deploy-health): Health reports whether this deployment can observe the delivery plane.
- [Login deploy](/docs/openapi/deploy/get-deploy-login): 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](/docs/openapi/deploy/get-deploy-projects): Returns the argocd AppProjectList this console groups and filters applications by.
- [List userinfo](/docs/openapi/deploy/get-deploy-session-userinfo): 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…
- [List settings](/docs/openapi/deploy/get-deploy-settings): Returns the argocd AuthSettings object the dashboard SPA awaits before its first render.
- [List applications](/docs/openapi/deploy/get-deploy-stream-applications): Holds the connection open as text/event-stream and pushes one watch event per application change.
- [List resource tree](/docs/openapi/deploy/get-deploy-stream-applications-by-name-resource-tree): 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 —…
- [List version](/docs/openapi/deploy/get-deploy-version): Returns the argocd VersionMessage the dashboard SPA reads at bootstrap.
- [Create rollback](/docs/openapi/deploy/post-deploy-applications-by-name-rollback): Serves the console's rollback control, and today it requests a reconcile and nothing more. The opening verb is not style.
- [Sync applications](/docs/openapi/deploy/post-deploy-applications-by-name-sync): Asks the operator to reconcile ONE application now.
- [Logout deploy](/docs/openapi/deploy/post-deploy-logout): Ends the console session on this host. It clears this console's session cookie and answers the signed-out state with the sign-in URL to start again.
- [Create reconcile](/docs/openapi/deploy/post-deploy-reconcile): Renders the configured git source and applies it to the cluster, once.
- [Destination](/docs/openapi/destination): Your events forwarded to the ad and analytics tools you use.
- [Delete destination](/docs/openapi/destination/delete-destination-by-platform): Forgets a destination for the caller's org: every credential held in KMS, then the stored config.
- [List destination](/docs/openapi/destination/get-destination): Reports every destination this deployment can forward to, each with the caller org's connection state: whether it is connected, whether it is enabled,…
- [Get destination](/docs/openapi/destination/get-destination-by-platform): 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](/docs/openapi/destination/post-destination-by-platform): 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…
- [Test destination](/docs/openapi/destination/post-destination-by-platform-test): Sends ONE synthetic pageview through the connected destination end to end and reports what the platform said.
- [DNS](/docs/openapi/dns): Your DNS records: the zones and records behind every name you point at Hanzo.
- [Delete zones](/docs/openapi/dns/delete-dns-zones-by-zone): Removes one of the calling org's zones, and the records in it, from the DNS control plane.
- [Delete records](/docs/openapi/dns/delete-dns-zones-by-zone-records-by-record): Removes one record from one zone. The plane owns the authoritative zone and record store behind every name pointed at Hanzo; this head keeps none of it.
- [List health](/docs/openapi/dns/get-dns-health): Reports whether the DNS control plane is answering.
- [List zones](/docs/openapi/dns/get-dns-zones): Lists every DNS zone the calling org holds, authoritative and provider-backed alike.
- [Get zones](/docs/openapi/dns/get-dns-zones-by-zone): Reads one of the calling org's zones by name.
- [List records](/docs/openapi/dns/get-dns-zones-by-zone-records): Lists the records in one zone. A provider-backed zone is read from the provider, which is its source of truth.
- [Get records](/docs/openapi/dns/get-dns-zones-by-zone-records-by-record): Reads one record of one zone by its id. The plane owns the authoritative zone and record store behind every name pointed at Hanzo; this head keeps none of…
- [Update records](/docs/openapi/dns/patch-dns-zones-by-zone-records-by-record): Amends one record of one zone. Only the fields the body carries change; the rest keep the values they hold at the plane.
- [Sync dns](/docs/openapi/dns/post-dns-sync): Replaces the calling org's zones and their records in bulk.
- [Create zones](/docs/openapi/dns/post-dns-zones): Creates a zone for the calling org — authoritative, or backed by a DNS provider the org has connected.
- [Create records](/docs/openapi/dns/post-dns-zones-by-zone-records): Creates a record in one zone. A provider-backed zone is written at the provider first, then mirrored locally so the resolver serves it.
- [Replace records](/docs/openapi/dns/put-dns-zones-by-zone-records-by-record): Amends one record of one zone. Only the fields the body carries change; this is the same partial update PATCH performs, not a replacement of the whole…
- [Domain](/docs/openapi/domain): Hanzo Domains: search a name, see the price, buy it from your prepaid wallet.
- [List availability](/docs/openapi/domain/get-domain-availability): Checks exact names rather than searching for them, and answers the same quote shape search does — purchasable, premium, first-term and renewal price in…
- [List domains](/docs/openapi/domain/get-domain-domains): Is 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,…
- [List health](/docs/openapi/domain/get-domain-health): Reports registrar reachability honestly: ok only when the wholesale credentials are present AND name.com accepted them on a live call made while you…
- [Search domain](/docs/openapi/domain/get-domain-search): 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,…
- [Create register](/docs/openapi/domain/post-domain-register): Buys a domain for your org and answers the ownership record together with the quote it was bought at.
- [Create renew](/docs/openapi/domain/post-domain-renew): Extends a domain your org already owns and answers the updated record with its new expiry alongside what was paid.
- [Create transfer](/docs/openapi/domain/post-domain-transfer): 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](/docs/openapi/engine): Hanzo Engine: which models the serving runtime has loaded, and the GPUs under it.
- [List model](/docs/openapi/engine/enginemodel): Model reads one model's load state — loaded, unloading, or not_found, as the engine itself reports it.
- [List models](/docs/openapi/engine/enginemodels): Models lists the models the engine serves, each with its load state — the server's own model table (its standard list envelope, load status included),…
- [List status](/docs/openapi/engine/enginestatus): Status reports whether the engine deployment is reachable and which build revision it runs — an honest lens for "is the serving runtime up", never a…
- [List system](/docs/openapi/engine/enginesystem): System reads the engine host's inventory: OS, CPU, memory, every accelerator device with its VRAM and compute capability, and the build's capabilities…
- [Entitlement](/docs/openapi/entitlement): What your org may run: what the plan grants, and which of those products are switched on.
- [List entitlement](/docs/openapi/entitlement/get-entitlement): Projection reports which console apps the CALLER's org may open, and the plan slug that decides it.
- [Get orgs](/docs/openapi/entitlement/get-entitlement-orgs-by-org): Get 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](/docs/openapi/entitlement/post-entitlement-orgs-by-org): Post turns products on or off for an org and returns the enabled set afterwards.
- [Esign](/docs/openapi/esign): A document out for signature, signed and filed with an audit trail.
- [List documents](/docs/openapi/esign/get-esign-documents): Returns your org's documents, newest first. Each carries its status, recipients and field layout.
- [Get documents](/docs/openapi/esign/get-esign-documents-by-id): Returns one document with its recipients and field layout.
- [List audit](/docs/openapi/esign/get-esign-documents-by-id-audit): Returns the document's full audit trail, oldest first.
- [List download](/docs/openapi/esign/get-esign-documents-by-id-download): Returns the document — the sealed PDF once it is complete. It answers the document's current PDF as base64 with a sealed flag and a filename.
- [List health](/docs/openapi/esign/get-esign-health): Reports whether the e-signature surface is mounted. It answers ok whenever the subsystem is mounted, takes no tenant and needs no principal.
- [Get sign](/docs/openapi/esign/get-esign-o-by-org-sign-by-token): Opens a document you were asked to sign, using your signing link.
- [Create documents](/docs/openapi/esign/post-esign-documents): Uploads a PDF and opens a draft ready for recipients and fields.
- [Create fields](/docs/openapi/esign/post-esign-documents-by-id-fields): Places a field on the page for one recipient to fill.
- [Create recipients](/docs/openapi/esign/post-esign-documents-by-id-recipients): Adds someone to a draft and mints their signing token.
- [Send documents](/docs/openapi/esign/post-esign-documents-by-id-send): Sends the document out and answers each signer's link.
- [Complete sign](/docs/openapi/esign/post-esign-o-by-org-sign-by-token-complete): Finishes your signing — and seals the document if you were the last. It marks this recipient as done and answers whether the DOCUMENT sealed with it.
- [Create fields](/docs/openapi/esign/post-esign-o-by-org-sign-by-token-fields-by-fieldid): Fills in one of your fields. It records a value for one field and marks it inserted.
- [Reject sign](/docs/openapi/esign/post-esign-o-by-org-sign-by-token-reject): Declines to sign, with an optional reason.
- [Eval](/docs/openapi/eval): Scoring a model on your own data, with a judge you choose.
- [Delete datasets](/docs/openapi/eval/delete-eval-datasets-by-name): Removes the named dataset of the caller's org AND all of its examples, in one transaction.
- [List datasets](/docs/openapi/eval/get-eval-datasets): Is the datasets your org has, each with its name, description, metadata and timestamps. It is the only way to enumerate what an org holds.
- [Get datasets](/docs/openapi/eval/get-eval-datasets-by-name): 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](/docs/openapi/eval/get-eval-datasets-by-name-items): Is the examples in one of your datasets — the set is named in the path, because this collection only exists inside one.
- [List evaluators](/docs/openapi/eval/get-eval-evaluators): Is the judges your org has defined, each with its judge model, criteria and the score name it writes under.
- [List metrics](/docs/openapi/eval/get-eval-metrics): Is your org's AI overview board over a window: totals (generations, prompt and completion tokens, cost in cents, errors, success rate, distinct models and…
- [List rubrics](/docs/openapi/eval/get-eval-rubrics): Is the score shapes your org has declared — each name's data type, its numeric bounds and its allowed categories.
- [List runs](/docs/openapi/eval/get-eval-runs): Is 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,…
- [List scores](/docs/openapi/eval/get-eval-scores): Is the score events your org has recorded, narrowed by any of name, runName and traceId.
- [List traces](/docs/openapi/eval/get-eval-traces): Is the traces behind your evaluations — one per model call an evaluation made, carrying its input, output, model and timing — narrowed by any of…
- [Create datasets](/docs/openapi/eval/post-eval-datasets): 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](/docs/openapi/eval/post-eval-datasets-by-name-items): 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](/docs/openapi/eval/post-eval-evaluators): 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](/docs/openapi/eval/post-eval-rubrics): Defines the shape of one score name for the caller's org and answers 201 with it.
- [Create runs](/docs/openapi/eval/post-eval-runs): Runs a real evaluation and answers the summary when it is finished — this is synchronous work, not a job id.
- [Create scores](/docs/openapi/eval/post-eval-scores): Files one score event for the caller's org and answers 201 with it.
- [Event](/docs/openapi/event): Product analytics: send an event, read back who did what.
- [List errors](/docs/openapi/event/get-event-errors): Errors returns the caller org's most recently captured errors, newest first.
- [List health](/docs/openapi/event/get-event-health): Health reports whether the event plane can take a write and the warehouse can answer a read.
- [List events](/docs/openapi/event/get-event-insights-events): Returns the caller org's most recent product events, newest first.
- [List health](/docs/openapi/event/get-event-insights-health): Reports that the unified insights surface is serving.
- [List overview](/docs/openapi/event/get-event-overview): Overview returns the caller org's analytics KPIs for one time window.
- [List tag.js](/docs/openapi/event/get-event-tagjs): Serves the browser tag that autocaptures pageviews (initial and SPA) and uncaught errors onto the canonical wire at POST /v1/event.
- [List timeseries](/docs/openapi/event/get-event-timeseries): Timeseries returns the caller org's LLM usage over time as an evenly-spaced series.
- [List top](/docs/openapi/event/get-event-top): Top returns the caller org's ranked lenses for one window, five of them at once.
- [Create event](/docs/openapi/event/post-event): Stores pageviews, browser errors, identifies and custom commerce events as rows in the caller's own tenant, and answers a receipt {accepted, dropped} that…
- [Create envelope](/docs/openapi/event/post-event-by-project-envelope): Accepts the CURRENT Sentry wire — the framed envelope a modern SDK posts, carrying its items in one request — so an application already instrumented with…
- [Create store](/docs/openapi/event/post-event-by-project-store): Accepts the LEGACY Sentry wire: one event per request, what an SDK predating envelopes sends.
- [Create replay](/docs/openapi/event/post-event-replay): 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…
- [Exec](/docs/openapi/exec): The code interpreter: run a snippet in a sandbox, and move files in and out of the session that sandbox IS.
- [Get files](/docs/openapi/exec/get-exec-files-by-sid): Lists the files in an execution session. Everything the session's sandbox holds — the uploads a run can read and the artifacts it produced — each then…
- [Create exec](/docs/openapi/exec/post-exec): Executes a program in a throwaway sandbox and answers with what it printed and what it left behind.
- [Create programmatic](/docs/openapi/exec/post-exec-programmatic): Answers 501 — this deployment does not serve programmatic tool calling.
- [Create upload](/docs/openapi/exec/post-exec-upload): Takes a multipart upload and writes the file into the session's sandbox, so a later run can read it.
- [Experiment](/docs/openapi/experiment): A/B testing anything: a flag, an ad, a subject line, a model.
- [List experiment](/docs/openapi/experiment/get-experiment): Is every experiment in the caller's org, with its variants, status and decision, ordered by project then id.
- [Get experiment](/docs/openapi/experiment/get-experiment-by-id): Is one experiment's definition and lifecycle: variants, weights, control arm, status and winner.
- [List assign](/docs/openapi/experiment/get-experiment-by-id-assign): Is the variant one subject is bucketed into, and the payload that variant carries.
- [List health](/docs/openapi/experiment/get-experiment-health): Is whether the experiments subsystem is mounted and serving in this process. It answers unconditionally.
- [Create experiment](/docs/openapi/experiment/post-experiment): 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…
- [Create analyze](/docs/openapi/experiment/post-experiment-by-id-analyze): Is per-variant conversion, lift and statistical significance against the control arm.
- [Create decide](/docs/openapi/experiment/post-experiment-by-id-decide): Promotes one variant to the whole rollout and records who decided.
- [Explorer](/docs/openapi/explorer): Chain data: your block indexers and how far each has caught up, plus the on-chain price feeds.
- [List indexers](/docs/openapi/explorer/get-explorer-indexers): Reports the deployment's chain indexer(s) and how far each has indexed.
- [List oracles](/docs/openapi/explorer/get-explorer-oracles): Reports the on-chain price/data oracles from the graph's O-Chain PriceFeed registry.
- [Flags](/docs/openapi/flags): Feature flags: ship it dark, then turn it on for who you pick.
- [Delete defs](/docs/openapi/flags/delete-flags-defs-by-key): Removes one flag definition by key and records the deletion in the change log.
- [List activity](/docs/openapi/flags/get-flags-activity): Returns the caller's flag change log newest-first: every create, update and delete, with the actor and the time.
- [List defs](/docs/openapi/flags/get-flags-defs): Returns every flag definition in the caller's (org, project) store, by key, with its version and who last changed it.
- [Get defs](/docs/openapi/flags/get-flags-defs-by-key): Returns one flag definition by key, or 404 when the caller's store has none under that key.
- [List health](/docs/openapi/flags/get-flags-health): Health reports that the flag engine is serving.
- [Create flags](/docs/openapi/flags/post-flags): Evaluate runs the caller's flag definitions for one identity and returns the flag verdict: which flags are on (or which variant), their payloads, and…
- [Create decide](/docs/openapi/flags/post-flags-decide): Evaluate runs the caller's flag definitions for one identity and returns the flag verdict: which flags are on (or which variant), their payloads, and…
- [Replace defs](/docs/openapi/flags/put-flags-defs-by-key): Creates or replaces the flag definition at the path's key and returns the stored row.
- [Flow](/docs/openapi/flow): Hanzo Flow: build an agent workflow on a visual canvas, run it, and read every run.
- [Delete workflows](/docs/openapi/flow/delete-flow-workflows-by-workflow): Deletes one of the caller's workflows and its runs.
- [List runs](/docs/openapi/flow/get-flow-runs): Runs reads one workflow's recorded runs: every component build with its result, keyed by component.
- [List status](/docs/openapi/flow/get-flow-status): Status reports whether the flow service is reachable and which version it runs.
- [List workflows](/docs/openapi/flow/get-flow-workflows): Workflows lists the caller's workflows, paged.
- [Get workflows](/docs/openapi/flow/get-flow-workflows-by-workflow): Workflow reads one of the caller's workflows — the full record, graph included.
- [Update workflows](/docs/openapi/flow/patch-flow-workflows-by-workflow): Patches one of the caller's workflows: name, description, graph, or the locked flag — only the stated fields move.
- [Create runs](/docs/openapi/flow/post-flow-runs): Run 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](/docs/openapi/flow/post-flow-workflows): Creates a workflow in the caller's org. The org's project id is pinned server-side from the validated principal — there is no field by which a caller…
- [Framework](/docs/openapi/framework): Document types you define: describe a record once, then create, list, submit and cancel documents against it.
- [Delete framework](/docs/openapi/framework/delete-framework-by-doctype-by-name): Removes one document, after its on_trash hooks agree.
- [Delete doctypes](/docs/openapi/framework/delete-framework-doctypes-by-name): Removes a DocType and every document stored under it.
- [Delete roles](/docs/openapi/framework/delete-framework-roles-by-user-by-role): Removes one (user, role) grant in the caller's org.
- [Get framework](/docs/openapi/framework/get-framework-by-doctype): Returns the caller org's documents of one DocType, filtered, ordered and projected by the query.
- [Get framework](/docs/openapi/framework/get-framework-by-doctype-by-name): Returns one document by name, with Password fields redacted.
- [List doctypes](/docs/openapi/framework/get-framework-doctypes): Returns every DocType defined in the caller's org.
- [Get doctypes](/docs/openapi/framework/get-framework-doctypes-by-name): Returns one DocType definition — its fields, naming rule, permissions and lifecycle flags.
- [List modules](/docs/openapi/framework/get-framework-modules): Returns every app lane compiled into this deployment and the DocTypes each one installs.
- [Get modules](/docs/openapi/framework/get-framework-modules-by-module): 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 roles](/docs/openapi/framework/get-framework-roles): Returns every (user, role) assignment in the caller's org.
- [List summary](/docs/openapi/framework/get-framework-summary): 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](/docs/openapi/framework/post-framework-by-doctype): 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](/docs/openapi/framework/post-framework-by-doctype-by-name-cancel): Moves a submitted document to cancelled (docstatus 1 → 2) after its on_cancel hooks agree.
- [Create submit](/docs/openapi/framework/post-framework-by-doctype-by-name-submit): Moves a draft to submitted (docstatus 0 → 1) after its on_submit hooks agree.
- [Create doctypes](/docs/openapi/framework/post-framework-doctypes): 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,…
- [Create install](/docs/openapi/framework/post-framework-modules-by-module-install): Creates an app lane's DocTypes in the caller's org.
- [Create roles](/docs/openapi/framework/post-framework-roles): Grants one user one role in the caller's org — how a member gains rights on a DocType, since permissions name roles and never users. Manager-only.
- [Replace framework](/docs/openapi/framework/put-framework-by-doctype-by-name): PUT semantics: the stored field data BECOMES the body, so a field the body omits is not left at its previous value.
- [Replace doctypes](/docs/openapi/framework/put-framework-doctypes-by-name): Replaces a DocType definition wholesale (PUT semantics): the stored definition becomes the body.
- [Functions](/docs/openapi/functions): Your serverless code: publish it, call it over HTTP, watch every run and what it cost.
- [Delete functions](/docs/openapi/functions/delete-functions-by-name): Removes one of the caller org's functions and answers 204.
- [List functions](/docs/openapi/functions/get-functions): Is every serverless function the caller's org has published, each with its real 7-day rollup.
- [Get functions](/docs/openapi/functions/get-functions-by-name): Is 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…
- [List invocations](/docs/openapi/functions/get-functions-by-name-invocations): Is one function's past runs, newest first — each with its status, HTTP code, method, time and duration.
- [List logs](/docs/openapi/functions/get-functions-by-name-logs): Is the output of a function's most recent run — its error text when that run failed, else what it printed.
- [List deployments](/docs/openapi/functions/get-functions-deployments): Is what is live right now — each function's current record IS its live deployment, so this is the deployment inventory.
- [List metrics](/docs/openapi/functions/get-functions-metrics): Is the org's serverless dashboard over a window: a per-function invocation costLine and how those invocations ended.
- [List secrets](/docs/openapi/functions/get-functions-secrets): Is the NAMES of the secrets the caller org's functions mount.
- [List triggers](/docs/openapi/functions/get-functions-triggers): Is what calls the caller org's functions — one row per function.
- [Create functions](/docs/openapi/functions/post-functions): Publishes a serverless function under the caller's org and answers 201 with it.
- [Invoke functions](/docs/openapi/functions/post-functions-by-name-invoke): Runs a function and records a REAL invocation.
- [Gateway](/docs/openapi/gateway): 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](/docs/openapi/gateway/gatewaytraffic): Traffic 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…
- [List config](/docs/openapi/gateway/get-gateway-config): Read 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…
- [Replace config](/docs/openapi/gateway/put-gateway-config): Write updates one policy scope and returns the policy in force after the write.
- [Git](/docs/openapi/git): Git hosting for your org: create repos, clone, push, and see what they cost.
- [Delete keys](/docs/openapi/git/delete-git-keys-by-id): 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](/docs/openapi/git/delete-git-repos-by-name): Removes a repo's metadata and purges its storage. Answers 204 with no body.
- [Delete mirrors](/docs/openapi/git/delete-git-repos-by-name-mirrors-by-id): Removes one outbound mirror target; later pushes stop being forwarded to it. Answers 204 with no body.
- [Delete subscriptions](/docs/openapi/git/delete-git-repos-by-name-subscriptions-by-id): Removes one Slack subscription from a repo; the notifier stops posting that repo's events to that channel. Answers 204 with no body.
- [List git](/docs/openapi/git/get-git): The repository list for the signed-in caller's org — each repo with its description, default branch, size and last update.
- [List refs](/docs/openapi/git/get-git-by-org-by-project-by-repo-info-refs): The ref-advertisement phase of git's smart-HTTP protocol — the first request a clone, a fetch and a push all make.
- [Get git](/docs/openapi/git/get-git-by-org-by-repo): 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](/docs/openapi/git/get-git-by-org-by-repo-commits): The hundred most recent commits on one ref, each with its author, message and date.
- [List refs](/docs/openapi/git/get-git-by-org-by-repo-info-refs): The ref-advertisement phase of git's smart-HTTP protocol — the first request a clone, a fetch and a push all make.
- [List explore](/docs/openapi/git/get-git-explore): 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…
- [List keys](/docs/openapi/git/get-git-keys): Returns the SSH public keys registered to the caller's org — the keys that authenticate `git clone git@<host>:<org>/<repo>.git`.
- [List repos](/docs/openapi/git/get-git-repos): Returns the repos in the caller's scope, most recently updated first.
- [Get repos](/docs/openapi/git/get-git-repos-by-name): Returns one repo with its live ref state: every branch name and the resolved HEAD commit.
- [List blob](/docs/openapi/git/get-git-repos-by-name-blob): Returns one file's bytes at one revision. Text comes back verbatim, binary comes back base64, and a file past the 1 MiB view cap comes back marked…
- [List commits](/docs/openapi/git/get-git-repos-by-name-commits): Walks a ref's history newest first, or one path's history when a path is given.
- [List files](/docs/openapi/git/get-git-repos-by-name-files): Returns every file a glob selects at one revision, WITH its bytes and the revision they came from.
- [List mirrors](/docs/openapi/git/get-git-repos-by-name-mirrors): Returns a repo's outbound mirror targets — the downstream remotes the mirror reactor pushes to whenever a push lands here.
- [List pulls](/docs/openapi/git/get-git-repos-by-name-pulls): Returns a repo's pull requests, newest number first — what is waiting to be reviewed, and what has already landed.
- [Get pulls](/docs/openapi/git/get-git-repos-by-name-pulls-by-number): Returns one pull request by its per-repo number.
- [List readme](/docs/openapi/git/get-git-repos-by-name-readme): Returns the README at the tree root as plain text — unrendered, so the caller decides how to present it.
- [List refs](/docs/openapi/git/get-git-repos-by-name-refs): Lists a repo's branches, tags and default branch — what a branch picker needs in one call.
- [List subscriptions](/docs/openapi/git/get-git-repos-by-name-subscriptions): Returns a repo's Slack subscriptions — which channels the lifecycle notifier posts this repo's push and deploy events to.
- [List tree](/docs/openapi/git/get-git-repos-by-name-tree): Lists the immediate children of one directory at one revision, directories before files.
- [List usage](/docs/openapi/git/get-git-usage): Returns per-repo and total storage bytes for the caller's org — the queryable, per-tenant number commerce and o11y meter on.
- [Update repos](/docs/openapi/git/patch-git-repos-by-name): Flips a repo's public bit, the one mutable repo setting today. Public grants ANONYMOUS fetch only; push and the whole control plane stay org-authed.
- [Create git receive pack](/docs/openapi/git/post-git-by-org-by-project-by-repo-git-receive-pack): The pack-transfer phase of a push, and the point at which a push becomes an EVENT.
- [Create git upload pack](/docs/openapi/git/post-git-by-org-by-project-by-repo-git-upload-pack): 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…
- [Create git receive pack](/docs/openapi/git/post-git-by-org-by-repo-git-receive-pack): The pack-transfer phase of a push, and the point at which a push becomes an EVENT.
- [Create git upload pack](/docs/openapi/git/post-git-by-org-by-repo-git-upload-pack): 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…
- [Create keys](/docs/openapi/git/post-git-keys): Registers an SSH public key so it can authenticate `git clone git@<host>:<org>/<repo>.git` for the caller's org.
- [Create repos](/docs/openapi/git/post-git-repos): Provisions an empty bare repository in the caller's scope and returns it with its clone URLs. Answers 201.
- [Create gc](/docs/openapi/git/post-git-repos-by-name-gc): 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](/docs/openapi/git/post-git-repos-by-name-mirror): Imports an external git repository into the caller's repo, provisioning it on first use.
- [Create mirrors](/docs/openapi/git/post-git-repos-by-name-mirrors): Registers a downstream remote the repo's advanced refs are pushed to whenever a push lands here. Answers 201.
- [Create pulls](/docs/openapi/git/post-git-repos-by-name-pulls): Proposes a branch for merging and returns it with its number. Answers 201.
- [Create merge](/docs/openapi/git/post-git-repos-by-name-pulls-by-number-merge): 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](/docs/openapi/git/post-git-repos-by-name-push): Lands a set of files as one commit without a git client — the hanzo.app builder's push.
- [Create subscriptions](/docs/openapi/git/post-git-repos-by-name-subscriptions): Binds a Slack channel to a repo, so the lifecycle notifier posts that repo's push and deploy events there. Answers 201.
- [Create webhook](/docs/openapi/git/post-git-webhook): GONE (410). Push-to-deploy belongs to POST https://platform.hanzo.ai/v1/git-webhook, which owns the build system-of-record and dispatches BuildKit Jobs.
- [Create createRepo](/docs/openapi/git/post-git-zap-createrepo): Creates a repository in the caller's org and project scope and answers with its record.
- [Create deleteRepo](/docs/openapi/git/post-git-zap-deleterepo): Deletes the repository named by `name` and answers with the deleted name.
- [Create getRepo](/docs/openapi/git/post-git-zap-getrepo): Answers a single repository's record, named by `name`.
- [Create listRepos](/docs/openapi/git/post-git-zap-listrepos): Answers every repository in the caller's org and project scope.
- [Create usage](/docs/openapi/git/post-git-zap-usage): Answers every repository in the caller's org with its size in bytes, plus the org's total — what git storage is actually being used, and by which…
- [Graph](/docs/openapi/graph): 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 graph](/docs/openapi/graph/graphassert): Assert what is true of an entity
- [Create neighbors](/docs/openapi/graph/graphneighbors): Walk the edges from a seed set, bounded
- [List graph](/docs/openapi/graph/graphread): Read the assertions this organization has recorded
- [Resolve graph](/docs/openapi/graph/graphresolve): What is in force about an entity as of an instant, and what disagreed
- [Search graph](/docs/openapi/graph/graphsearch): Finds assertions by their text where read finds them by their keys.
- [List vocabulary](/docs/openapi/graph/graphvocabulary): The relations in use, and the rule that resolves a conflict
- [Create graphql](/docs/openapi/graph/post-graph-graphql): Runs a GraphQL query against this organization's assertions.
- [Guide](/docs/openapi/guide): The AI that builds an agentic company with you, one measured step at a time.
- [Delete curriculum](/docs/openapi/guide/delete-guide-curriculum): Clears the caller org's curriculum override and returns the journey it falls back to — the brand blueprint, else the embedded fixture.
- [List guide](/docs/openapi/guide/get-guide): Overview returns the caller org's launch journey: the active curriculum's version and title, every step with its state, whether it is available, what…
- [List actions](/docs/openapi/guide/get-guide-actions): 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…
- [List analytics](/docs/openapi/guide/get-guide-analytics): Analytics returns the caller org's funnel from the analytics lens plus the GTM recommendations derived from it.
- [List blueprint](/docs/openapi/guide/get-guide-blueprint): Returns the FULL authored brand blueprint — every principle, section, step, strategy and template WITH its enabled flag made explicit, including the…
- [List versions](/docs/openapi/guide/get-guide-blueprint-versions): Returns the brand blueprint's version history — every stored version's number and edit time, newest first — which is the point-in-time-recovery and audit…
- [List curriculum](/docs/openapi/guide/get-guide-curriculum): 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…
- [List profile](/docs/openapi/guide/get-guide-profile): Profile returns the caller org's OBSERVED growth profile — the signal set, the classified growth stage, and the org's own key metrics.
- [List strategies](/docs/openapi/guide/get-guide-strategies): Strategies returns the ENABLED tactics corpus for the caller's org: the tactics library narrowed by the explicit category/workload filters AND by the…
- [List suggest](/docs/openapi/guide/get-guide-suggest): Suggest 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…
- [Update blueprint](/docs/openapi/guide/patch-guide-blueprint-by-collection-by-id): Edits a single item of the brand blueprint by id and saves it as a NEW VERSION, answering the whole blueprint after the edit.
- [Create chat](/docs/openapi/guide/post-guide-chat): Chat 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…
- [Create do](/docs/openapi/guide/post-guide-steps-by-id-do): 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…
- [Create done](/docs/openapi/guide/post-guide-steps-by-id-done): Marks one step of the caller org's journey complete and returns the refreshed journey.
- [Create reset](/docs/openapi/guide/post-guide-steps-by-id-reset): 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](/docs/openapi/guide/post-guide-steps-by-id-skip): Marks one step of the caller org's journey skipped and returns the refreshed journey.
- [Start steps](/docs/openapi/guide/post-guide-steps-by-id-start): Marks one step of the caller org's journey in progress and returns the refreshed journey.
- [Replace blueprint](/docs/openapi/guide/put-guide-blueprint): Replaces the deployment's brand blueprint — the shared journey, sections, strategies and templates every org starts from — as a NEW VERSION, and answers…
- [Replace curriculum](/docs/openapi/guide/put-guide-curriculum): Sets the caller org's OWN curriculum — the per-customer override — and answers the journey now in force with `custom: true`.
- [Help](/docs/openapi/help): A support desk: customers file tickets, your team answers them.
- [List articles](/docs/openapi/help/get-help-articles): Returns the public knowledge base: the help center's Published, publicly-visible articles as cards.
- [Get articles](/docs/openapi/help/get-help-articles-by-slug): Returns one public article by slug, with its body.
- [List categories](/docs/openapi/help/get-help-categories): 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…
- [Create tickets](/docs/openapi/help/post-help-tickets): Files a customer support ticket into the public help center.
- [IAM](/docs/openapi/iam): Hanzo's identity provider: users, organizations, applications, and the OIDC/OAuth2 endpoints every Hanzo service authenticates against.
- [Create providers](/docs/openapi/iam/addprovider): 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…
- [Create tokens](/docs/openapi/iam/addtoken): Records an access token — the credential an application or integration presents on a caller's behalf.
- [Create webauthn credentials](/docs/openapi/iam/addwebauthncredential): Registers a passkey or security key for a person, so they can sign in with their device instead of a password.
- [Create organizations](/docs/openapi/iam/createorganization): Makes a new organization — the account your users, applications, roles, projects and workspaces are all named inside.
- [Create sessions](/docs/openapi/iam/createsession): Records a sign-in. Signing in again from another browser adds to the session rather than replacing it, so one person can be signed in from a laptop and a…
- [Delete applications](/docs/openapi/iam/delete-iam-applications-by-owner-by-name): Removes an application.
- [Delete audit logs](/docs/openapi/iam/delete-iam-audit-logs-by-owner-by-name): Removes an audit entry.
- [Delete certs](/docs/openapi/iam/delete-iam-certs-by-owner-by-name): Removes a signing certificate.
- [Delete invitations](/docs/openapi/iam/delete-iam-invitations-by-owner-by-name): Withdraws an invitation.
- [Delete keys](/docs/openapi/iam/delete-iam-keys-by-owner-by-name): Revokes an API key.
- [Delete mfa](/docs/openapi/iam/delete-iam-mfa): Turns a factor off, so sign-in stops asking for it. Naming no factor turns off ALL of them — the reset path.
- [Delete permissions](/docs/openapi/iam/delete-iam-permissions-by-owner-by-name): Revokes a permission.
- [Delete projects](/docs/openapi/iam/delete-iam-projects-by-owner-by-name): Removes a project.
- [Delete roles](/docs/openapi/iam/delete-iam-roles-by-owner-by-name): Removes a role.
- [Delete Users](/docs/openapi/iam/delete-iam-scim-v2-users-by-owner-by-name): Deprovisions a person — how removing someone in your identity provider removes their access here. Their sessions stop working immediately.
- [Delete service accounts](/docs/openapi/iam/delete-iam-service-accounts-by-name): Serves DELETE /v1/iam/service-accounts/:name.
- [Delete users](/docs/openapi/iam/delete-iam-users-by-owner-by-name): Removes a person from your organization. Their sessions stop working immediately and the account is gone rather than suspended — to keep the record and…
- [Delete keys](/docs/openapi/iam/delete-iam-users-by-owner-by-name-keys): Clears the target user's key of the requested TYPE (immediate revoke).
- [Delete workspaces](/docs/openapi/iam/delete-iam-workspaces-by-owner-by-name): Removes a workspace.
- [Delete organizations](/docs/openapi/iam/deleteorganization): Removes an organization and everything named inside it. There is no undo, and every session issued under it stops working.
- [Delete providers](/docs/openapi/iam/deleteprovider): Removes a provider. Sign-in through it stops for every application that used it, so give those applications another method first.
- [Delete sessions](/docs/openapi/iam/deletesession): Signs a person out of one application — the session ends and every browser carrying it stops being authenticated.
- [Delete tokens](/docs/openapi/iam/deletetoken): Revokes an access token. Whatever was using it stops being authorized at once.
- [Delete webauthn credentials](/docs/openapi/iam/deletewebauthncredential): Removes a passkey or security key — what you call when a device is lost. Make sure the person has another way to sign in first.
- [List account](/docs/openapi/iam/get-iam-account): Returns the signed-in person's own account and the organization they belong to — what a console reads to draw the account menu.
- [List applications](/docs/openapi/iam/get-iam-applications): 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…
- [Get applications](/docs/openapi/iam/get-iam-applications-by-owner-by-name): Returns one application: its sign-in methods, its allowed redirect URIs and the client credentials your integration authenticates with.
- [List audit logs](/docs/openapi/iam/get-iam-audit-logs): Returns your organization's audit trail, newest first — who did what, when, and from where.
- [Get audit logs](/docs/openapi/iam/get-iam-audit-logs-by-owner-by-name): Returns one audit entry in full: the action, the person or key behind it, and the request it came in on.
- [List application](/docs/openapi/iam/get-iam-auth-application): 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…
- [List methods](/docs/openapi/iam/get-iam-auth-methods): 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…
- [List certs](/docs/openapi/iam/get-iam-certs): Returns your organization's signing certificates, newest first — the keys the tokens your applications verify are signed with.
- [Get certs](/docs/openapi/iam/get-iam-certs-by-owner-by-name): Returns one signing certificate — its algorithm, its validity window and its public half.
- [List consent](/docs/openapi/iam/get-iam-consent): Returns the calling person's own privacy and communication choices.
- [List invitations](/docs/openapi/iam/get-iam-invitations): 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](/docs/openapi/iam/get-iam-invitations-by-owner-by-name): Returns one invitation: who it is for, what it grants on acceptance, and when it expires.
- [List keys](/docs/openapi/iam/get-iam-keys): Returns your organization's API keys, newest first — what each is called, what it may reach, and its publishable half.
- [Get keys](/docs/openapi/iam/get-iam-keys-by-owner-by-name): Returns one API key: what it is called, what it may reach, and when it was issued.
- [List org](/docs/openapi/iam/get-iam-keys-org): 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](/docs/openapi/iam/get-iam-keys-principal): 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](/docs/openapi/iam/get-iam-linked-accounts): Returns the sign-in identities linked to the calling person's account — every provider they can currently sign in with.
- [List memberships](/docs/openapi/iam/get-iam-memberships): Answers either question about who belongs where: which organizations one person can act in, or who can act in one organization.
- [List authorize](/docs/openapi/iam/get-iam-oauth-authorize): Starts a sign-in — the address you send a browser to, and the beginning of every OAuth and OpenID Connect flow.
- [List callback](/docs/openapi/iam/get-iam-oauth-callback): Completes the round-trip: it resolves and burns the single-use transaction (checking expiry + browser binding), exchanges and verifies the IdP response,…
- [Logout oauth](/docs/openapi/iam/get-iam-oauth-logout): Ends a sign-in and sends the browser somewhere sensible. Accepts GET or POST, so it works as a plain link.
- [List userinfo](/docs/openapi/iam/get-iam-oauth-userinfo): 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…
- [List permissions](/docs/openapi/iam/get-iam-permissions): 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](/docs/openapi/iam/get-iam-permissions-by-owner-by-name): Returns one permission: who it grants to, what it allows, and the resources it covers.
- [List projects](/docs/openapi/iam/get-iam-projects): 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](/docs/openapi/iam/get-iam-projects-by-owner-by-name): Returns one project: what it is called and how it is set up.
- [List jwks](/docs/openapi/iam/get-iam-registry-jwks): 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…
- [List token](/docs/openapi/iam/get-iam-registry-token): Signs a container client in to your registry.
- [List roles](/docs/openapi/iam/get-iam-roles): Returns your organization's roles, newest first — each a named group of people that permissions are granted to.
- [Get roles](/docs/openapi/iam/get-iam-roles-by-owner-by-name): Returns one role: who is in it, and the roles it includes.
- [List ResourceTypes](/docs/openapi/iam/get-iam-scim-v2-resourcetypes): Returns the kinds of record this directory provisions and the address of each, so your identity provider discovers them rather than having them configured…
- [Get ResourceTypes](/docs/openapi/iam/get-iam-scim-v2-resourcetypes-by-name): Returns one provisionable record kind in full.
- [List Schemas](/docs/openapi/iam/get-iam-scim-v2-schemas): Returns the attribute definitions this directory understands, so your identity provider knows which fields it may send and what they mean before it sends…
- [Get Schemas](/docs/openapi/iam/get-iam-scim-v2-schemas-by-id): Returns one attribute definition in full.
- [List ServiceProviderConfig](/docs/openapi/iam/get-iam-scim-v2-serviceproviderconfig): Tells your identity provider which parts of SCIM this directory supports, so it configures itself instead of you filling in a form.
- [List Users](/docs/openapi/iam/get-iam-scim-v2-users): 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](/docs/openapi/iam/get-iam-scim-v2-users-by-owner-by-name): Returns one person in the standard SCIM shape.
- [List service accounts](/docs/openapi/iam/get-iam-service-accounts): Returns your organization's service accounts — what each is called and when it was created.
- [List users](/docs/openapi/iam/get-iam-users): Returns a page of the people in your organization, with the total so you can page through the rest.
- [Get users](/docs/openapi/iam/get-iam-users-by-owner-by-name): Returns one person in your organization, addressed by their username or by their email address.
- [List nonce](/docs/openapi/iam/get-iam-web3-nonce): Starts a wallet sign-in: it returns a one-time challenge for the wallet to sign.
- [List begin](/docs/openapi/iam/get-iam-webauthn-signin-begin): Starts a passkey sign-in: it returns the challenge the person's authenticator signs.
- [List begin](/docs/openapi/iam/get-iam-webauthn-signup-begin): Starts enrolling a passkey for the signed-in person: it returns the options their browser hands to the authenticator.
- [List jwks](/docs/openapi/iam/get-iam-well-known-jwks): 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…
- [List oauth authorization server](/docs/openapi/iam/get-iam-well-known-oauth-authorization-server): 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,…
- [List openid configuration](/docs/openapi/iam/get-iam-well-known-openid-configuration): 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,…
- [List whoami](/docs/openapi/iam/get-iam-whoami): 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](/docs/openapi/iam/get-iam-workspaces): Returns your organization's workspaces, newest first — the scope a team works in, alongside projects rather than instead of them.
- [Get workspaces](/docs/openapi/iam/get-iam-workspaces-by-owner-by-name): Returns one workspace: what it is called and how it is set up.
- [Get organizations](/docs/openapi/iam/getorganization): Returns one organization: its display, its defaults and the sign-in rules everyone in it inherits.
- [Get providers](/docs/openapi/iam/getprovider): Returns one provider: what it connects to and how it is configured.
- [Get sessions](/docs/openapi/iam/getsession): Returns one person's session in one application — when it began and which browsers or devices are still carrying it.
- [Get tokens](/docs/openapi/iam/gettoken): Returns one access token: who and what it was issued to, and when it expires.
- [Get webauthn credentials](/docs/openapi/iam/getwebauthncredential): Returns one passkey or security key: whose it is, what device it lives on, and when it was registered.
- [List organizations](/docs/openapi/iam/listorganizations): 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…
- [List providers](/docs/openapi/iam/listproviders): Returns your organization's providers, newest first — the identity providers your people sign in with, and the senders and connectors your applications go…
- [List sessions](/docs/openapi/iam/listsessions): Returns who is currently signed in to your organization, newest first, and can be narrowed to one person or one application.
- [List tokens](/docs/openapi/iam/listtokens): Returns the access tokens issued in your organization, newest first, and can be narrowed to one organization.
- [List webauthn credentials](/docs/openapi/iam/listwebauthncredentials): Returns the passkeys and security keys registered to one person, newest first — which device each lives on and when it was registered. Yours by default.
- [Update Users](/docs/openapi/iam/patch-iam-scim-v2-users-by-owner-by-name): Applies a partial change from your identity provider — one attribute moved, not the whole record resent.
- [Create provision](/docs/openapi/iam/post-iam-admin-provision): 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](/docs/openapi/iam/post-iam-applications): 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…
- [Create assume](/docs/openapi/iam/post-iam-assume): Steps a platform operator into an organization: it returns their own access token re-scoped to that tenant, so they see what the tenant sees.
- [Create audit logs](/docs/openapi/iam/post-iam-audit-logs): Records an audit entry, so activity from your own systems lands in the same trail as everything the Hanzo Cloud records for you.
- [Create certs](/docs/openapi/iam/post-iam-certs): 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](/docs/openapi/iam/post-iam-delete-membership): Takes away a person's or an application's right to act in an organization. Their account survives; what ends is their access to that organization.
- [Create invitations](/docs/openapi/iam/post-iam-invitations): 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 keys](/docs/openapi/iam/post-iam-keys): Issues an API key. A standard key comes back as a publishable half you may ship in client code and a secret half you must not — the secret is shown once,…
- [Create link](/docs/openapi/iam/post-iam-link): Starts connecting another sign-in identity to the account you are already signed in as.
- [Login iam](/docs/openapi/iam/post-iam-login): 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](/docs/openapi/iam/post-iam-memberships): Lets a person or an application act in an organization.
- [Create preferred](/docs/openapi/iam/post-iam-mfa-preferred): Picks which second factor an account is asked for first when it has more than one.
- [Enable setup](/docs/openapi/iam/post-iam-mfa-setup-enable): Finishes the enrolment: from here the account's sign-ins ask for this factor.
- [Create initiate](/docs/openapi/iam/post-iam-mfa-setup-initiate): Starts enrolling a factor and hands over whatever the person needs to prove they hold it: app a fresh secret and the otpauth:// URL to render as a QR code…
- [Create authorize](/docs/openapi/iam/post-iam-oauth-authorize): Starts a sign-in — the address you send a browser to, and the beginning of every OAuth and OpenID Connect flow.
- [Create device](/docs/openapi/iam/post-iam-oauth-device): Starts a sign-in on a device with no browser and no keyboard — a TV, a CLI, a headless box.
- [Create info](/docs/openapi/iam/post-iam-oauth-device-info): Answers "what am I approving?" for a pending device code.
- [Create mfa](/docs/openapi/iam/post-iam-oauth-federation-mfa): Completes a sign-in that came in through another identity provider and still owes a second factor.
- [Create introspect](/docs/openapi/iam/post-iam-oauth-introspect): 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…
- [Logout oauth](/docs/openapi/iam/post-iam-oauth-logout): Ends a sign-in and sends the browser somewhere sensible. Accepts GET or POST, so it works as a plain link.
- [Revoke oauth](/docs/openapi/iam/post-iam-oauth-revoke): Retires a token before it expires — what you call when someone signs out or a credential may have leaked. Revoking an access token kills that token.
- [Create token](/docs/openapi/iam/post-iam-oauth-token): 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…
- [Create userinfo](/docs/openapi/iam/post-iam-oauth-userinfo): 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…
- [Create onboard](/docs/openapi/iam/post-iam-onboard): 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…
- [Create permissions](/docs/openapi/iam/post-iam-permissions): Grants a permission — the call that gives a person or a role the ability to do something.
- [Create preferences](/docs/openapi/iam/post-iam-preferences): Saves the calling person's own settings and returns the full set afterwards.
- [Create projects](/docs/openapi/iam/post-iam-projects): 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](/docs/openapi/iam/post-iam-registry-token): Signs a container client in to your registry.
- [Create release](/docs/openapi/iam/post-iam-release): Steps a platform operator back out: it returns their own access token with no organization assumed, which is the credential they had before they stepped…
- [Create roles](/docs/openapi/iam/post-iam-roles): Makes a role — a named group of people that permissions are granted to.
- [Create Users](/docs/openapi/iam/post-iam-scim-v2-users): 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](/docs/openapi/iam/post-iam-service-accounts): 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](/docs/openapi/iam/post-iam-service-accounts-by-name-keys): 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](/docs/openapi/iam/post-iam-signin): 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…
- [Signup iam](/docs/openapi/iam/post-iam-signup): 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…
- [Create issue](/docs/openapi/iam/post-iam-tokens-issue): Mints an access token for the `?id=<owner>/<name>` target user (optional `?aud=` resource, RFC 8707), issued by the authenticated + allow-listed…
- [Create unlink](/docs/openapi/iam/post-iam-unlink): Disconnects one sign-in identity from an account, so that provider can no longer be used to sign in as that person.
- [Create users](/docs/openapi/iam/post-iam-users): Adds a person to your organization. Send a password and it becomes the one they sign in with; it is hashed before it is stored and never comes back in any…
- [Create keys](/docs/openapi/iam/post-iam-users-by-owner-by-name-keys): (re)generates the target user's key of the requested TYPE and returns it once, over the shared authorizeMinter + mintTarget seam.
- [Create verification codes](/docs/openapi/iam/post-iam-verification-codes): Validates the request and asks otp to get a code to the person.
- [Verify web3](/docs/openapi/iam/post-iam-web3-verify): Completes a wallet sign-in: it verifies the signed challenge and, if it holds, signs the wallet's owner in.
- [Create finish](/docs/openapi/iam/post-iam-webauthn-signin-finish): Verifies the signed challenge and signs the person in.
- [Create finish](/docs/openapi/iam/post-iam-webauthn-signup-finish): Verifies the newly created passkey and stores it, so the person can sign in with their device from then on.
- [Create workspaces](/docs/openapi/iam/post-iam-workspaces): Makes a workspace inside your organization — the scope a team works in, alongside projects rather than instead of them.
- [Replace account](/docs/openapi/iam/put-iam-account): Saves the calling person's own profile — the name they are shown by, their picture, a line about themselves and a link.
- [Replace applications](/docs/openapi/iam/put-iam-applications-by-owner-by-name): 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](/docs/openapi/iam/put-iam-audit-logs-by-owner-by-name): Corrects an audit entry. The trail is append-only in normal operation and nothing in the Hanzo Cloud rewrites it — this exists for an administrator to…
- [Replace certs](/docs/openapi/iam/put-iam-certs-by-owner-by-name): Changes a signing certificate's settings. What it is called does not change, and neither does when it was added.
- [Replace consent](/docs/openapi/iam/put-iam-consent): Records the calling person's privacy and communication choices. Only their own — there is no way to set consent for somebody else.
- [Replace invitations](/docs/openapi/iam/put-iam-invitations-by-owner-by-name): Changes an invitation's terms — the role it grants, how many may redeem it, or when it expires.
- [Replace keys](/docs/openapi/iam/put-iam-keys-by-owner-by-name): Changes what a key is called or what it may reach.
- [Replace password](/docs/openapi/iam/put-iam-password): Replaces the calling person's password. Only their own — there is no shape of this request that writes somebody else's.
- [Replace permissions](/docs/openapi/iam/put-iam-permissions-by-owner-by-name): Changes who a permission grants to, what it allows, or the resources it covers. Access changes as soon as the write lands.
- [Replace projects](/docs/openapi/iam/put-iam-projects-by-owner-by-name): Changes a project's settings.
- [Replace roles](/docs/openapi/iam/put-iam-roles-by-owner-by-name): Changes who is in a role, or which roles it includes. Access changes for everyone in it as soon as the write lands.
- [Replace Users](/docs/openapi/iam/put-iam-scim-v2-users-by-owner-by-name): Overwrites a person's SCIM attributes with what your identity provider sends — how a change made there lands here.
- [Replace users](/docs/openapi/iam/put-iam-users-by-owner-by-name): Changes a person's profile, their roles, or the credentials they sign in with.
- [Replace workspaces](/docs/openapi/iam/put-iam-workspaces-by-owner-by-name): Changes a workspace's settings.
- [Create avatar](/docs/openapi/iam/setorganizationavatar): Changes how an organization appears across Hanzo: the square mark beside its name, as an uploaded image or as a single emoji.
- [Replace organizations](/docs/openapi/iam/updateorganization): Changes an organization's display, its defaults and the sign-in rules everyone in it inherits.
- [Replace providers](/docs/openapi/iam/updateprovider): Changes a provider's settings or rotates the credentials it holds.
- [Replace sessions](/docs/openapi/iam/updatesession): Replaces the set of browsers a session covers — signing out the ones you leave off while the session itself stays live.
- [Replace tokens](/docs/openapi/iam/updatetoken): Changes an access token's scope or expiry.
- [Replace webauthn credentials](/docs/openapi/iam/updatewebauthncredential): Renames a registered passkey or security key, so a person can tell their devices apart.
- [Upsert applications](/docs/openapi/iam/upsertapplication): 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…
- [Upsert users](/docs/openapi/iam/upsertuser): Creates a person or updates them in place, so a deployment can declare the accounts it needs and re-run that declaration safely.
- [Index](/docs/openapi/index): Fast full-text search over your own data, typos forgiven.
- [Delete indexes](/docs/openapi/index/delete-index-indexes-by-uid): Deletes an index and everything in it. Drops the index and every document in it from the caller's own org, and answers the dialect's EnqueuedTask.
- [Delete documents](/docs/openapi/index/delete-index-indexes-by-uid-documents-by-id): Deletes one document by its primary key. Removes the document from the caller's own org and answers the dialect's EnqueuedTask.
- [List health](/docs/openapi/index/get-index-health): Reports whether the search plane can serve. Answers the dialect's `{"status":"available"}` when the index store is readable.
- [List indexes](/docs/openapi/index/get-index-indexes): Lists the indexes your org holds. Answers every index in the caller's own org with its primary key and timestamps.
- [Get indexes](/docs/openapi/index/get-index-indexes-by-uid): Reads one index's definition. Answers the index's uid, primary key and timestamps.
- [List documents](/docs/openapi/index/get-index-indexes-by-uid-documents): Pages through the documents in an index. Answers the org's stored documents in insertion order, whole, with the page's bounds and the index's total.
- [Get documents](/docs/openapi/index/get-index-indexes-by-uid-documents-by-id): Reads one document by its primary key. Answers the stored document exactly as it was written — this surface keeps documents whole rather than projecting…
- [List settings](/docs/openapi/index/get-index-indexes-by-uid-settings): Reads an index's filterable attributes. Answers the settings subset this surface implements: the attributes a search `filter` may constrain.
- [List stats](/docs/openapi/index/get-index-stats): Counts the documents in each of your indexes. Reports every index the caller's own org holds with its document count, plus the org's total.
- [Get tasks](/docs/openapi/index/get-index-tasks-by-uid): Checks a write task, which has already finished. Always reports `succeeded`.
- [List version](/docs/openapi/index/get-index-version): Identifies the search implementation answering.
- [Update settings](/docs/openapi/index/patch-index-indexes-by-uid-settings): Sets which attributes an index can be filtered on. Replaces the whole filterable set.
- [Create indexes](/docs/openapi/index/post-index-indexes): Creates an index. Registers a named index in the caller's own org and answers the dialect's EnqueuedTask.
- [Create documents](/docs/openapi/index/post-index-indexes-by-uid-documents): 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](/docs/openapi/index/post-index-indexes-by-uid-documents-delete-batch): Removes every named document from the caller's own index. The body is the dialect's own: a bare array of primary keys, which may be strings or numbers.
- [Search indexes](/docs/openapi/index/post-index-indexes-by-uid-search): Searches an index, forgiving typos. Ranks the org's documents in one index against `q` and answers the matching documents whole, most relevant first.
- [Replace documents](/docs/openapi/index/put-index-indexes-by-uid-documents): The dialect's update spelling of the write above, and the same act: an upsert keyed by the index's primary key.
- [Ingress](/docs/openapi/ingress): Your edge: automatic TLS certificates and hostname routing to any backend, changed live.
- [Delete middlewares](/docs/openapi/ingress/delete-ingress-middlewares-by-id): Removes one of the caller org's edge transforms and hot-applies the change.
- [Delete routes](/docs/openapi/ingress/delete-ingress-routes-by-id): Removes one of the caller org's routing rules and hot-applies the shrunken table, freeing its host for another claim.
- [Delete services](/docs/openapi/ingress/delete-ingress-services-by-id): Removes one of the caller org's backend pools and hot-applies the change.
- [List middlewares](/docs/openapi/ingress/get-ingress-middlewares): Returns every edge transform the caller's org has configured, ordered by id.
- [Get middlewares](/docs/openapi/ingress/get-ingress-middlewares-by-id): Returns one of the caller org's edge transforms by id.
- [List routes](/docs/openapi/ingress/get-ingress-routes): Returns every routing rule the caller's org has configured, ordered by id.
- [Get routes](/docs/openapi/ingress/get-ingress-routes-by-id): Returns one of the caller org's routing rules by id.
- [List services](/docs/openapi/ingress/get-ingress-services): Returns every backend pool the caller's org has configured, ordered by id.
- [Get services](/docs/openapi/ingress/get-ingress-services-by-id): Returns one of the caller org's backend pools by id.
- [List status](/docs/openapi/ingress/get-ingress-status): Status 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…
- [List tls](/docs/openapi/ingress/get-ingress-tls): GetTLS 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…
- [Create middlewares](/docs/openapi/ingress/post-ingress-middlewares): Creates or replaces one edge transform and hot-applies it.
- [Create routes](/docs/openapi/ingress/post-ingress-routes): Creates or replaces one routing rule and hot-applies the new table — there is no config file and no restart.
- [Create services](/docs/openapi/ingress/post-ingress-services): Creates or replaces one backend pool and hot-applies it.
- [Replace middlewares](/docs/openapi/ingress/put-ingress-middlewares-by-id): Creates or replaces one edge transform and hot-applies it.
- [Replace routes](/docs/openapi/ingress/put-ingress-routes-by-id): Creates or replaces one routing rule and hot-applies the new table — there is no config file and no restart.
- [Replace services](/docs/openapi/ingress/put-ingress-services-by-id): Creates or replaces one backend pool and hot-applies it.
- [Replace tls](/docs/openapi/ingress/put-ingress-tls): PutTLS replaces the caller org's ACME intent and hot-applies what can be hot-applied.
- [Integrations](/docs/openapi/integrations): How your org connects third-party accounts like Slack, and revokes them.
- [Delete connectors](/docs/openapi/integrations/delete-integrations-connectors-by-id): Forgets a connector: every custodied secret, then the row.
- [Delete pages](/docs/openapi/integrations/delete-integrations-github-repos-by-repo-pages): Deletes the repo's Pages site.
- [List integrations](/docs/openapi/integrations/get-integrations): Returns every registered integration provider together with THIS org's connection status for it — the catalog the console's Integrations page renders.
- [Get integrations](/docs/openapi/integrations/get-integrations-by-provider): Returns ONE provider with this org's connection status — the same view list carries, for a single id.
- [List callback](/docs/openapi/integrations/get-integrations-by-provider-callback): The single address every connector's OAuth flow returns to.
- [List connectors](/docs/openapi/integrations/get-integrations-connectors): Lists the caller's OWN connectors across every provider — the set `hanzo connector ls` prints.
- [List token](/docs/openapi/integrations/get-integrations-connectors-by-id-token): Hands the custodied access token to its owner — the ONE place custody exits.
- [List providers](/docs/openapi/integrations/get-integrations-connectors-providers): Lists the user-scoped provider cards — the catalog of what a user can connect, and how.
- [List link](/docs/openapi/integrations/get-integrations-discord-link): The entry point behind the connect prompt Hanzo shows in a Discord server.
- [List callback](/docs/openapi/integrations/get-integrations-discord-link-callback): 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…
- [List discord](/docs/openapi/integrations/get-integrations-discord-link-discord): Where Discord returns the user after the identify consent.
- [List installations](/docs/openapi/integrations/get-integrations-github-installations): 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](/docs/openapi/integrations/get-integrations-github-repos): Lists the org's granted GitHub repositories, each annotated with its native import + sync status from the git object plane.
- [List pages](/docs/openapi/integrations/get-integrations-github-repos-by-repo-pages): Returns the repo's Pages status, live URL, custom domain and build source.
- [List projects](/docs/openapi/integrations/get-integrations-gitlab-projects): Lists the projects the org's GitLab connection can reach — membership projects, most recently active first.
- [List install](/docs/openapi/integrations/get-integrations-slack-install): The address behind Slack's "Add to Slack" and Marketplace Install buttons.
- [List link](/docs/openapi/integrations/get-integrations-slack-link): The entry point behind the connect prompt Hanzo posts in Slack.
- [List callback](/docs/openapi/integrations/get-integrations-slack-link-callback): 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](/docs/openapi/integrations/get-integrations-slack-link-slack): Where Slack returns the user after they sign in.
- [List link](/docs/openapi/integrations/get-integrations-teams-link): The entry point behind the connect prompt Hanzo shows in Teams.
- [List aad](/docs/openapi/integrations/get-integrations-teams-link-aad): Where Microsoft returns the user after sign-in.
- [List callback](/docs/openapi/integrations/get-integrations-teams-link-callback): 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…
- [List link](/docs/openapi/integrations/get-integrations-telegram-link): The entry point behind the connect prompt Hanzo sends in Telegram.
- [List auth](/docs/openapi/integrations/get-integrations-telegram-link-auth): Where Telegram's Login Widget sends the user with its signed authentication data.
- [List callback](/docs/openapi/integrations/get-integrations-telegram-link-callback): 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…
- [List webhook](/docs/openapi/integrations/get-integrations-whatsapp-webhook): Meta calls this once when the webhook is subscribed, carrying the verify token this deployment was configured with and a challenge to echo.
- [Connect integrations](/docs/openapi/integrations/post-integrations-by-provider-connect): Acquires the org's credential for one provider.
- [Disconnect integrations](/docs/openapi/integrations/post-integrations-by-provider-disconnect): Revokes (best-effort) and forgets an org's connection: it deletes every custodied KMS secret and the connection row.
- [Verify integrations](/docs/openapi/integrations/post-integrations-by-provider-verify): Re-checks a CONNECTED apikey connector's stored credential against the provider, live (`hanzo connector verify`).
- [Refresh connectors](/docs/openapi/integrations/post-integrations-connectors-by-id-refresh): Forces a token rotation for a connected connector, ahead of the automatic rotation a token read would do inside the expiry window.
- [Create credential](/docs/openapi/integrations/post-integrations-connectors-by-provider-credential): Is 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](/docs/openapi/integrations/post-integrations-connectors-by-provider-device): Begins a device sign-in and returns the code to show the user plus how to poll for completion.
- [Create poll](/docs/openapi/integrations/post-integrations-connectors-by-provider-device-by-flow-poll): Advances a device sign-in. Terminal outcomes are DATA, not errors (verifyConn {active:false} discipline) — the status set is closed:…
- [Create interactions](/docs/openapi/integrations/post-integrations-discord-interactions): The Interactions Endpoint URL for the Discord app.
- [Claim github](/docs/openapi/integrations/post-integrations-github-claim): Binds installations the App ALREADY holds to the org the caller is acting in — the reconciliation for a grant that happened outside our connect flow.
- [Create fork](/docs/openapi/integrations/post-integrations-github-fork): Forks a granted repository. GitHub's fork is ASYNCHRONOUS: it answers 202 with the target repo and populates it in the background, and it answers the same…
- [Create backfill](/docs/openapi/integrations/post-integrations-github-issues-backfill): 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](/docs/openapi/integrations/post-integrations-github-repos-by-repo-pages): Creates the repo's Pages site and answers 201 Created with it.
- [Create builds](/docs/openapi/integrations/post-integrations-github-repos-by-repo-pages-builds): Requests a Pages rebuild and returns the queued build's status.
- [Import repos](/docs/openapi/integrations/post-integrations-github-repos-import): Imports the selected (or all) granted repos into git.hanzo.ai.
- [Search github](/docs/openapi/integrations/post-integrations-github-search): Finds repositories on GitHub. This reads the PUBLIC index and returns nothing an installation unlocks: it is how you find a repository to fork, not a way…
- [Create webhook](/docs/openapi/integrations/post-integrations-github-webhook): The address the GitHub App delivers events to.
- [Create webhook](/docs/openapi/integrations/post-integrations-openrouter-webhook): 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](/docs/openapi/integrations/post-integrations-slack-commands): The address Slack posts a slash command to, form-encoded.
- [Create events](/docs/openapi/integrations/post-integrations-slack-events): The address a Slack app posts workspace events to.
- [Create events](/docs/openapi/integrations/post-integrations-teams-events): The messaging endpoint for the Teams bot. A message activity is routed to an agent turn and answered proactively through the Bot Connection; anything that…
- [Connect telegram](/docs/openapi/integrations/post-integrations-telegram-connect): 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](/docs/openapi/integrations/post-integrations-telegram-webhook): The update webhook for the Telegram bot. It does two jobs: `/start <code>` or `/connect <code>` binds the chat it was sent from to an org, idempotently;…
- [Create webhook](/docs/openapi/integrations/post-integrations-whatsapp-webhook): One delivery from Meta. Authenticity is the X-Hub-Signature-256 HMAC over the raw body, and it is the whole of it: a message accepted here creates the…
- [Replace pages](/docs/openapi/integrations/put-integrations-github-repos-by-repo-pages): Sets or clears the custom domain (cname) and updates HTTPS enforcement, build type, or source.
- [Kafka](/docs/openapi/kafka): Kafka — reached at :9092; not in the public REST contract.
- [KMS](/docs/openapi/kms): Secret custody: your org's secrets sealed at rest, plus threshold signing.
- [List config](/docs/openapi/kms/get-kms-config): Returns the runtime configuration for the KMS console.
- [List health](/docs/openapi/kms/get-kms-health): Reports whether this broker can actually serve secrets.
- [List secrets](/docs/openapi/kms/get-kms-secrets): Lists the secrets your org holds, without their values.
- [Login auth](/docs/openapi/kms/post-kms-auth-login): Exchanges a machine credential for an IAM bearer token.
- [Create secrets](/docs/openapi/kms/post-kms-secrets): Stores or replaces one secret in your org. Upserts one secret under the caller's own org.
- [Knowledge](/docs/openapi/knowledge): Your team's wiki and your agents' memory, searchable by meaning.
- [Delete connectors](/docs/openapi/knowledge/delete-knowledge-connectors-by-provider): Revokes a connection: it tombstones the stored credential so a later sync cannot reuse it, purges this provider's points from the org's vector namespace,…
- [List connectors](/docs/openapi/knowledge/get-knowledge-connectors): 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](/docs/openapi/knowledge/get-knowledge-connectors-by-provider-callback): CompleteConnectorOAuth finishes an OAuth connection: it exchanges the provider's code for a token, seals that token in KMS, and records the connection.
- [Connect connectors](/docs/openapi/knowledge/get-knowledge-connectors-by-provider-connect): StartConnectorOAuth returns the provider authorize URL the console opens to connect this org's account.
- [List catalog](/docs/openapi/knowledge/get-knowledge-connectors-catalog): 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 graph](/docs/openapi/knowledge/get-knowledge-graph): 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…
- [Sync connectors](/docs/openapi/knowledge/post-knowledge-connectors-by-provider-sync): 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…
- [Import knowledge](/docs/openapi/knowledge/post-knowledge-import): Ingests an uploaded export as a tree of kb-page documents with its link structure intact.
- [Search knowledge](/docs/openapi/knowledge/post-knowledge-search): Runs a semantic search over the caller org's own knowledge — its wiki pages, its agent memories and everything its connectors have synced — and returns…
- [KV](/docs/openapi/kv): Your key-value store: buckets of versioned values your apps read and write by key.
- [Delete kv](/docs/openapi/kv/delete-kv-by-bucket): Removes one bucket of the caller's org — every key and every revision with it — and answers 204 with no body.
- [Delete kv](/docs/openapi/kv/delete-kv-by-bucket-by-key): Delete 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](/docs/openapi/kv/get-kv-by-bucket-by-key): Get returns one key's current value and revision.
- [List history](/docs/openapi/kv/get-kv-by-bucket-by-key-history): History returns one key's retained revisions, oldest first — every put and every delete marker up to the bucket's History depth.
- [Create kv](/docs/openapi/kv/post-kv-by-bucket): Creates a KV bucket and returns it. A bucket is keyed state on the same durable plane as the streams: each key holds up to History revisions, entries can…
- [Replace kv](/docs/openapi/kv/put-kv-by-bucket-by-key): Put sets one key to one value and returns the revision the write created.
- [Label](/docs/openapi/label): The ground-truth plane: what actually turned out to be fraud, who said so, and when they could first have said it.
- [Create dispose](/docs/openapi/label/riskdisposelabels): Applies this tenant's retention, and only this tenant's. It is bounded three ways, each a compliance property rather than a convenience.
- [Create hold](/docs/openapi/label/riskholdlabels): Places or releases a litigation hold on named records.
- [Create label](/docs/openapi/label/risklabel): Records a batch of ground truth against the entities it judges.
- [List coverage](/docs/openapi/label/risklabelcoverage): Reports how much of a window has matured and how much of that is judged, per source. It is the gate on training.
- [List label](/docs/openapi/label/risklabels): Reads the assertions this tenant has recorded, newest event first.
- [List vocabulary](/docs/openapi/label/risklabelvocabulary): Publishes the closed vocabularies and the precedence rule that resolves a conflict between two sources.
- [Resolve label](/docs/openapi/label/riskresolvelabels): Answers, for each named event, which assertion was in force AS OF that event's own horizon — and what disagreed with it.
- [Leaderboard](/docs/openapi/leaderboard): The ranking of who uses AI most, in your org and globally.
- [List leaderboard](/docs/openapi/leaderboard/get-leaderboard): Leaderboard 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…
- [List activity](/docs/openapi/leaderboard/get-leaderboard-activity): Activity returns the per-day usage series for ONE authorized subject — the points a contribution heatmap and a timeline are drawn from, gap-filled so…
- [List optin](/docs/openapi/leaderboard/get-leaderboard-optin): Returns the caller's own public-listing preference and their org's, each with whether the caller may change it.
- [Replace optin](/docs/openapi/leaderboard/put-leaderboard-optin): Sets the CALLER's own public-listing preference on the leaderboard.
- [Replace org](/docs/openapi/leaderboard/put-leaderboard-optin-org): Sets the ORG's listing on the cross-org global board.
- [Legal](/docs/openapi/legal): The paperwork your company needs, drafted, signed and filed.
- [List documents](/docs/openapi/legal/get-legal-documents): Returns the org's generated documents, newest first, WITHOUT their rendered content — fetch one document to read its body.
- [Get documents](/docs/openapi/legal/get-legal-documents-by-id): Returns one of the org's documents WITH its rendered body. 404 when the org has no document with that id — a document is never readable across orgs.
- [List filings](/docs/openapi/legal/get-legal-filings): 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](/docs/openapi/legal/get-legal-health): Reports that the legal subsystem is serving and how many built-in templates its catalog carries.
- [List templates](/docs/openapi/legal/get-legal-templates): 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](/docs/openapi/legal/get-legal-templates-by-id): 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…
- [Create documents](/docs/openapi/legal/post-legal-documents): 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](/docs/openapi/legal/post-legal-documents-by-id-sign): 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](/docs/openapi/legal/post-legal-documents-by-id-sign-complete): Records completion of the signature request opened over a generated document and answers the document with a `signed` flag.
- [Create filings](/docs/openapi/legal/post-legal-filings): Records a filing of one or more of the org's documents with a state or agency, and returns the tracking record.
- [Replace templates](/docs/openapi/legal/put-legal-templates-by-id): Saves the org's own version of a template — a custom NDA, a house MSA — and returns it with its new version number.
- [Licensing](/docs/openapi/licensing): What an org has bought and may run: signed licenses to issue, verify and revoke, and the releases they unlock.
- [Get download](/docs/openapi/licensing/get-licensing-download-by-release): Download resolves a release to its artifact, gated on a valid license.
- [List healthz](/docs/openapi/licensing/get-licensing-healthz): Health reports which signer this deployment mints with, and in which env.
- [List jwks](/docs/openapi/licensing/get-licensing-jwks): Pubkey publishes the Ed25519 PUBLIC verification key, at both /pubkey and /jwks.
- [List pubkey](/docs/openapi/licensing/get-licensing-pubkey): Pubkey publishes the Ed25519 PUBLIC verification key, at both /pubkey and /jwks.
- [List releases](/docs/openapi/licensing/get-licensing-releases): Lists the signed binary releases this deployment can serve.
- [Get releases](/docs/openapi/licensing/get-licensing-releases-by-release): Reads one release's metadata: its product, version, platform and the cosign material a client verifies the binary against. An unknown id is 404.
- [Create fingerprint](/docs/openapi/licensing/post-licensing-fingerprint): Fingerprint turns raw device signals into the opaque value that binds a license to one machine.
- [Create issue](/docs/openapi/licensing/post-licensing-issue): Issue mints a signed license token for a product the caller's org already pays for.
- [Create releases](/docs/openapi/licensing/post-licensing-releases): Publishes a signed binary release, answering 201 Created.
- [Revoke licensing](/docs/openapi/licensing/post-licensing-revoke): Revoke turns off tokens that have already been issued.
- [Verify licensing](/docs/openapi/licensing/post-licensing-verify): Verify checks a license token online: signature, schema, expiry, app_id and the revocation list.
- [Link](/docs/openapi/link): 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…
- [Delete link](/docs/openapi/link/delete-link-by-id): Logs out one account and stops the sessions it was running.
- [List link](/docs/openapi/link/get-link): Lists your linked accounts and the devices they sit on.
- [Get link](/docs/openapi/link/get-link-by-id): Reads one linked account. It answers a single link — its device, provider, account, plan, how it bills, its status and its latest usage snapshot.
- [Get devices](/docs/openapi/link/get-link-devices-by-machine): Shows one machine: its accounts, usage and live sessions.
- [List route](/docs/openapi/link/get-link-route): Gets the failover order across your linked accounts.
- [List usage](/docs/openapi/link/get-link-usage): Shows one provider account's own usage dashboard.
- [List accounts](/docs/openapi/link/get-link-usage-accounts): Breaks down what the gateway routed through each of your accounts.
- [List summary](/docs/openapi/link/get-link-usage-summary): Shows plan consumption and Hanzo spend side by side.
- [Create link](/docs/openapi/link/post-link): Registers a signed-in AI provider account on a machine.
- [Revoke devices](/docs/openapi/link/post-link-devices-by-machine-revoke): Logs out every account on one machine and stops its sessions.
- [Create usage](/docs/openapi/link/post-link-usage): Reports usage samples from the device collector.
- [LSP](/docs/openapi/lsp): 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](/docs/openapi/lsp/post-lsp-complete): 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](/docs/openapi/lsp/post-lsp-diagnostics): 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…
- [Create hover](/docs/openapi/lsp/post-lsp-hover): Renders the type and documentation of the symbol at a position, as the language server itself renders it.
- [Create locate](/docs/openapi/lsp/post-lsp-locate): Finds where a symbol lives: its definition, its references, its type or its implementations, chosen by relation (definition, reference, type,…
- [Create symbols](/docs/openapi/lsp/post-lsp-symbols): Outlines one file: every declaration in it, with its kind and its span.
- [Marketing](/docs/openapi/marketing): Lifecycle email: drip sequences that reach the right people.
- [Delete audiences](/docs/openapi/marketing/delete-marketing-audiences-by-id): Removes one of the caller org's audiences and answers 204.
- [Delete calendar](/docs/openapi/marketing/delete-marketing-calendar-by-id): Removes one of the caller org's posts and answers 204.
- [Delete campaigns](/docs/openapi/marketing/delete-marketing-campaigns-by-id): Removes one of the caller org's campaigns and answers 204.
- [Delete suppressions](/docs/openapi/marketing/delete-marketing-suppressions): Re-subscribes an address on one channel and answers 204.
- [List audiences](/docs/openapi/marketing/get-marketing-audiences): Returns the org's saved audiences, most recently updated first.
- [Get audiences](/docs/openapi/marketing/get-marketing-audiences-by-id): Returns one of the caller org's saved audiences.
- [Preview audiences](/docs/openapi/marketing/get-marketing-audiences-by-id-preview): 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](/docs/openapi/marketing/get-marketing-calendar): Returns the org's calendar, latest scheduled first, optionally narrowed to one status.
- [Get calendar](/docs/openapi/marketing/get-marketing-calendar-by-id): Returns one of the caller org's posts, including the exact error behind a failed publish.
- [List campaigns](/docs/openapi/marketing/get-marketing-campaigns): Returns the org's campaigns, most recently updated first, optionally narrowed to one lifecycle status.
- [Get campaigns](/docs/openapi/marketing/get-marketing-campaigns-by-id): Returns one of the caller org's campaigns.
- [List promos](/docs/openapi/marketing/get-marketing-promos): 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](/docs/openapi/marketing/get-marketing-promos-by-code-eligibility): Prices a promo against a plan and seat count.
- [List redemption](/docs/openapi/marketing/get-marketing-promos-by-code-redemption): Returns the caller org's OWN redemption of a promo — an org-scoped read, so it can never surface another tenant's.
- [List sequences](/docs/openapi/marketing/get-marketing-sequences): Returns the org's drip sequences, most recently updated first.
- [Get sequences](/docs/openapi/marketing/get-marketing-sequences-by-id): Returns one of the caller org's sequences together with its steps in send order.
- [List enrollments](/docs/openapi/marketing/get-marketing-sequences-by-id-enrollments): Returns who is walking one sequence, most recently enrolled first, with each walk's current step and next due time.
- [List steps](/docs/openapi/marketing/get-marketing-sequences-by-id-steps): Returns one sequence's steps in send order.
- [List summary](/docs/openapi/marketing/get-marketing-summary): 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](/docs/openapi/marketing/get-marketing-suppressions): Returns the org's opt-out list, newest first — everyone the send gate will refuse to deliver to.
- [List unsubscribe](/docs/openapi/marketing/get-marketing-unsubscribe): Is the PUBLIC one-click endpoint (no principal): a recipient clicks the signed link in an email footer.
- [Create audiences](/docs/openapi/marketing/post-marketing-audiences): Saves a cohort filter for the caller's org. Name is required.
- [Create calendar](/docs/openapi/marketing/post-marketing-calendar): Adds a post to the content calendar. Channel and body are required.
- [Publish calendar](/docs/openapi/marketing/post-marketing-calendar-by-id-publish): Publishes a post NOW, synchronously, whatever its schedule.
- [Create campaigns](/docs/openapi/marketing/post-marketing-campaigns): Registers a campaign in the caller's org. Name is required; channel defaults to email and status to draft, and a future scheduledAt with no explicit…
- [Create schedule](/docs/openapi/marketing/post-marketing-campaigns-by-id-schedule): Sets a campaign's send time and moves it to "scheduled".
- [Redeem promos](/docs/openapi/marketing/post-marketing-promos-by-code-redeem): Records the caller org's claim on a promo.
- [Create sequences](/docs/openapi/marketing/post-marketing-sequences): Registers a drip sequence in the caller's org.
- [Create enroll](/docs/openapi/marketing/post-marketing-sequences-by-id-enroll): Adds one contact or a whole audience to a sequence and schedules the first step for each.
- [Cancel enrollments](/docs/openapi/marketing/post-marketing-sequences-by-id-enrollments-by-eid-cancel): Stops one walk mid-sequence and answers 204: no further step is sent, and steps already delivered are not recalled.
- [Create status](/docs/openapi/marketing/post-marketing-sequences-by-id-status): Flips draft/active/archived — the activation gate for sending, since only an active sequence accepts enrollments.
- [Create steps](/docs/openapi/marketing/post-marketing-sequences-by-id-steps): 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](/docs/openapi/marketing/post-marketing-suppressions): Records an opt-out for the org (admin / self-service management). Address is required; channel defaults to email.
- [Replace calendar](/docs/openapi/marketing/put-marketing-calendar-by-id): Replaces a post's editable fields. It is a full write, not a patch, and it RESETS the lifecycle from the schedule: a scheduledAt makes the post…
- [Replace campaigns](/docs/openapi/marketing/put-marketing-campaigns-by-id): Replaces a campaign's editable fields. It is a full write, not a patch: every field takes the value in the body, and an omitted one is cleared.
- [Marketplace](/docs/openapi/marketplace): The shop for tools and agents: browse, install into your project, publish your own free or priced.
- [Delete listings](/docs/openapi/marketplace/delete-marketplace-listings-by-id): Unpublish withdraws one of the caller org's listings from the marketplace and answers 204.
- [List marketplace](/docs/openapi/marketplace/get-marketplace): Discover 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…
- [List listings](/docs/openapi/marketplace/get-marketplace-listings): Returns the listings the caller's own org has published — what this org is offering, not what it can buy.
- [Create install](/docs/openapi/marketplace/post-marketplace-install): Install activates one tool for the caller's own org and project.
- [Create listings](/docs/openapi/marketplace/post-marketplace-listings): Publish offers one tool on the marketplace, optionally monetized.
- [Create uninstall](/docs/openapi/marketplace/post-marketplace-uninstall): Uninstall deactivates one tool for the caller's own org and project, so it stops being dispatchable there.
- [Meet](/docs/openapi/meet): The virtual office: it decides who may join a room and mints the short-lived token that lets them in.
- [List health](/docs/openapi/meet/get-meet-health): Health reports whether the office can mint join tokens.
- [List session](/docs/openapi/meet/get-meet-session): 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…
- [List call](/docs/openapi/meet/meetcall): Answers where a room's call happens, for a caller who may join it.
- [List record](/docs/openapi/meet/meetrecordread): Answers what is being recorded in a room, and where the file went.
- [Create record](/docs/openapi/meet/meetrecordstart): Begins recording a room, or hands back the recording already running.
- [Delete record](/docs/openapi/meet/meetrecordstop): Ends a room's recording — EVERY one of them.
- [Create getToken](/docs/openapi/meet/post-meet-gettoken): Answers with a LiveKit join token for exactly the room named in the body.
- [Metrics](/docs/openapi/metrics): Metrics — 11 operations on https://api.hanzo.ai.
- [List health](/docs/openapi/metrics/get-metrics-health): Reports the native metrics store's live state for the calling tenant: the subsystem version, the resolved `org`, and `series` — the number of distinct…
- [List health](/docs/openapi/metrics/get-metrics-logs-health): 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…
- [Query logs](/docs/openapi/metrics/get-metrics-logs-query): Answers `{count, records}`, newest first. `match` is the same `k=v,k2=v2` superset label matcher the metrics query uses; `contains` is a case-insensitive…
- [Query metrics](/docs/openapi/metrics/get-metrics-query): Answers `{count, series}`, where `count` is the number of matching SERIES and each series carries the samples that fall inside the window.
- [List health](/docs/openapi/metrics/get-metrics-traces-health): 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](/docs/openapi/metrics/get-metrics-traces-query): Answers `{count, spans}`, newest first, filtered on each span's START time.
- [List trace](/docs/openapi/metrics/get-metrics-traces-trace): 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](/docs/openapi/metrics/post-metrics-batch): 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…
- [Create write](/docs/openapi/metrics/post-metrics-logs-write): Takes `{records:[{t, level, body, labels}]}`, appends each one, and answers `{written}`.
- [Create write](/docs/openapi/metrics/post-metrics-traces-write): Takes `{spans:[{traceId, spanId, parentId, name, startNs, endNs, attrs}]}`, appends each, and answers `{written}` — the number of spans sent.
- [Create write](/docs/openapi/metrics/post-metrics-write): Takes `{series:[{name, labels, samples:[{t, v}]}]}`, appends every sample, creating each series on first write, and answers `{written}` — again counting…
- [ML](/docs/openapi/ml): Model serving: deploy a model behind an endpoint and call it.
- [Delete models](/docs/openapi/ml/delete-ml-models-by-name): Deletes a deployed inference model. kserve owns the teardown: the InferenceService goes away and the serving deployment behind it follows, so the model…
- [List health](/docs/openapi/ml/get-ml-health): Reports whether the model-serving plane is genuinely usable: that the Kubernetes API answers, that the InferenceService CRD is actually served by this…
- [List models](/docs/openapi/ml/get-ml-models): Lists the inference models deployed in the caller's org.
- [Get models](/docs/openapi/ml/get-ml-models-by-name): Returns one deployed inference model. Its spec comes with it, and kserve's live status, which is where readiness and the serving address appear.
- [Update models](/docs/openapi/ml/patch-ml-models-by-name): 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…
- [Create models](/docs/openapi/ml/post-ml-models): Deploys one inference model for the caller's org, and answers 201 with the model as Kubernetes admitted it.
- [Create predict](/docs/openapi/ml/post-ml-models-by-name-predict): 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…
- [MQ](/docs/openapi/mq): Queue and stream admin for your org: create them, watch them drain, ack what you pulled.
- [Delete stream](/docs/openapi/mq/delete-mq-stream-by-name): Removes a stream with all its messages and consumers.
- [Delete message](/docs/openapi/mq/delete-mq-stream-by-name-message-by-seq): Erases one message by sequence; the sequence gap remains.
- [Delete consumer](/docs/openapi/mq/delete-mq-stream-by-stream-consumer-by-name): Removes a consumer and its delivery state; unacknowledged messages stay in the stream.
- [List health](/docs/openapi/mq/get-mq-health): Reports whether the message plane behind this surface answers.
- [List info](/docs/openapi/mq/get-mq-info): Returns the broker's identity and the org's stream count.
- [List stream](/docs/openapi/mq/get-mq-stream): Returns the org's streams, name-ordered, with their live state.
- [Get stream](/docs/openapi/mq/get-mq-stream-by-name): Returns one stream's configuration and live state.
- [List message](/docs/openapi/mq/get-mq-stream-by-name-message): Reads stored messages without a consumer: by sequence, by newest on a subject, or walking a subject forward from a sequence.
- [List consumer](/docs/openapi/mq/get-mq-stream-by-stream-consumer): Returns a stream's consumers, name-ordered, with delivery state.
- [Get consumer](/docs/openapi/mq/get-mq-stream-by-stream-consumer-by-name): Returns one consumer's configuration and delivery state.
- [Create stream](/docs/openapi/mq/post-mq-stream): Creates a durable stream in the org's namespace and returns it.
- [Create purge](/docs/openapi/mq/post-mq-stream-by-name-purge): Removes messages from a stream, leaving its consumers in place.
- [Create consumer](/docs/openapi/mq/post-mq-stream-by-stream-consumer): Creates a durable pull consumer on a stream and returns it.
- [Create next](/docs/openapi/mq/post-mq-stream-by-stream-consumer-by-name-next): Pulls the consumer's next batch. Delivered messages are acknowledged on delivery — the broker will not redeliver what this call returns; an empty wait…
- [Replace stream](/docs/openapi/mq/put-mq-stream-by-name): Reconfigures an existing stream; the path names the stream, and the immutable fields (storage, retention) must restate what they are.
- [Network](/docs/openapi/network): 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…
- [List network](/docs/openapi/network/get-network): Returns the caller's org overlay network on the Zero Trust fabric.
- [Get network](/docs/openapi/network/get-network-by-id): Returns one overlay network by id, scoped to the caller's org.
- [List routers](/docs/openapi/network/get-network-routers): Returns the Zero Trust routers the caller's org owns.
- [List services](/docs/openapi/network/get-network-services): Returns the Zero Trust edge services the caller's org owns.
- [Node](/docs/openapi/node): Your machines: the ones you own, connected and ready to take a command.
- [List node](/docs/openapi/node/get-node): 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…
- [Connect node](/docs/openapi/node/get-node-connect): Upgrades to a WebSocket and keeps it for the life of the node.
- [Invoke node](/docs/openapi/node/post-node-by-id-invoke): Sends {command, params, timeoutMs, idempotencyKey} to the named node and answers with what the node returned: {ok, payload, code, message}, where payload…
- [Invoke peer](/docs/openapi/node/post-node-peer-invoke): A machine hop, not a caller-facing route. A node's socket lands on one replica while invocations land on any, so the replica that took the request…
- [Notify](/docs/openapi/notify): Transactional email and SMS, sent through your org's own provider credential.
- [List health](/docs/openapi/notify/get-notify-health): Reports that the notify send surface is mounted.
- [Send notify](/docs/openapi/notify/post-notify-send): Delivers one transactional message by email or SMS through the caller org's own provider credential.
- [Create email](/docs/openapi/notify/post-notify-send-email): Delivers one transactional email through the caller org's own provider credential.
- [Create sms](/docs/openapi/notify/post-notify-send-sms): Delivers one transactional SMS through the caller org's own provider credential.
- [O11y](/docs/openapi/o11y): Your logs, metrics and traces: ship them in, query them, chart them.
- [Create check in](/docs/openapi/o11y/agentcheckin): Is 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…
- [Create agent check in](/docs/openapi/o11y/agentcheckindeprecated): Is the deployed agent's check-in on its original hyphenated path, kept for backward compatibility with agents already running.
- [Create check](/docs/openapi/o11y/authzcheck): Evaluates a batch of transactions — relation plus object — for the authenticated caller and answers each with its authorization verdict, in the order they…
- [Create clone](/docs/openapi/o11y/clonedashboardv2): Clones an existing v2-shape dashboard. User and integration dashboards can be cloned; system dashboards are rejected.
- [Create accounts](/docs/openapi/o11y/createaccount): Connects a new cloud-integration account for the given provider from its posted config and credentials, answering with the account and the artifact the…
- [Create domains](/docs/openapi/o11y/createauthdomain): Claims an email domain for the org and configures how its users sign in; the answer is the new domain's id.
- [Create bulk](/docs/openapi/o11y/createbulkinvite): Invites several people to the caller's org in one call, refusing the whole batch when any email repeats.
- [Create channels](/docs/openapi/o11y/createchannel): Creates a notification channel, answering with the stored channel.
- [Create dashboards](/docs/openapi/o11y/createdashboardv2): Creates a dashboard in the v2 format that follows the Perses spec and answers with the stored dashboard.
- [Create dashboard views](/docs/openapi/o11y/createdashboardview): Persists the calling user's dashboard-listing state (query, sort, order) as a named, reusable view shared across the org.
- [Create downtime schedules](/docs/openapi/o11y/createdowntimeschedule): Creates a planned maintenance window, answering with the stored schedule.
- [Create ingestion keys](/docs/openapi/o11y/createingestionkey): Mints an ingestion key for the workspace, answering with the created key.
- [Create limits](/docs/openapi/o11y/createingestionkeylimit): Sets a signal limit on an ingestion key, by key id, answering with the created limit.
- [Create invite](/docs/openapi/o11y/createinvite): Invites one person to the caller's org by email, with the role they will hold when they accept.
- [Create annotation](/docs/openapi/o11y/createllmannotation): Adds a human annotation to a trace or observation, optionally in a review queue.
- [Create scores](/docs/openapi/o11y/createllmscore): Attaches an eval score or human-feedback signal to a trace or a single observation.
- [Create metric reduction rules](/docs/openapi/o11y/createmetricreductionrule): 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](/docs/openapi/o11y/createorupdatellmpricingrules): Writes the pricing-rule batch — the single write endpoint used by both the user and the Zeus sync job.
- [Create public](/docs/openapi/o11y/createpublicdashboard): Creates the public-sharing config for a dashboard and enables public sharing, answering with the new share's id.
- [Replace reset password tokens](/docs/openapi/o11y/createresetpasswordtoken): Creates or regenerates a user's reset-password token: a live token is returned as it is, an expired one is replaced.
- [Create roles](/docs/openapi/o11y/createrole): 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](/docs/openapi/o11y/createroutepolicy): Creates a route policy, answering with the stored policy.
- [Create rules](/docs/openapi/o11y/createrule): Creates a new alert rule and answers with the stored rule.
- [Create service accounts](/docs/openapi/o11y/createserviceaccount): Creates a service account in the caller's org, answering its id.
- [Create keys](/docs/openapi/o11y/createserviceaccountkey): 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](/docs/openapi/o11y/createserviceaccountrole): Assigns a role, named by its id, to a service account.
- [Create email password](/docs/openapi/o11y/createsessionbyemailpassword): Signs a user in with email and password and answers with the session's token pair.
- [Create span mappers](/docs/openapi/o11y/createspanmapper): 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](/docs/openapi/o11y/createspanmappergroup): 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](/docs/openapi/o11y/createtracefunnel): Creates an empty funnel with a name, answering the funnel it created. Steps are added afterwards with the steps update.
- [Create users](/docs/openapi/o11y/createuser): Creates a member of the caller's org in the pending-invite state and mails them their invitation; the answer is the new user's id.
- [Delete views](/docs/openapi/o11y/delete-o11y-explorer-views-by-viewid): Deletes one saved explorer view by id.
- [Delete reviews](/docs/openapi/o11y/delete-o11y-reviews-by-id): Removes one review queue and every item in it.
- [Delete projects](/docs/openapi/o11y/delete-o11y-sentinel-projects-by-id): Deletes one Sentry project of the caller's org.
- [Delete domains](/docs/openapi/o11y/deleteauthdomain): Releases an email domain and discards its SSO configuration, by id.
- [Delete channels](/docs/openapi/o11y/deletechannelbyid): Removes a notification channel, by id.
- [Delete dashboards](/docs/openapi/o11y/deletedashboardv2): Deletes a v2-shape dashboard along with its tag relations. Locked dashboards are rejected.
- [Delete dashboard views](/docs/openapi/o11y/deletedashboardview): Removes a saved view. Saved views are shared org-wide. Deleting a non-existent view refuses with the runtime's not-found.
- [Delete downtime schedules](/docs/openapi/o11y/deletedowntimeschedulebyid): Removes a planned maintenance window, by id.
- [Delete ingestion keys](/docs/openapi/o11y/deleteingestionkey): Removes an ingestion key, by id.
- [Delete limits](/docs/openapi/o11y/deleteingestionkeylimit): Removes an ingestion key limit, by limit id.
- [Delete llm pricing rules](/docs/openapi/o11y/deletellmpricingrule): Hard-deletes a pricing rule by id. If the rule was auto-synced, the next sync cycle recreates it.
- [Delete score](/docs/openapi/o11y/deletellmscore): Hard-deletes a score by id.
- [Delete metric reduction rules](/docs/openapi/o11y/deletemetricreductionrulebyid): Deletes a volume-control rule by its id.
- [Delete public](/docs/openapi/o11y/deletepublicdashboard): Deletes the public-sharing config and disables public sharing of a dashboard.
- [Delete roles](/docs/openapi/o11y/deleterole): Deletes a custom role.
- [Delete route policies](/docs/openapi/o11y/deleteroutepolicybyid): Removes a route policy, by id.
- [Delete rules](/docs/openapi/o11y/deleterulebyid): Removes an alert rule, by id.
- [Delete service accounts](/docs/openapi/o11y/deleteserviceaccount): Deletes a service account and revokes every key it holds.
- [Delete roles](/docs/openapi/o11y/deleteserviceaccountrole): Removes a role from a service account.
- [Delete sessions](/docs/openapi/o11y/deletesession): Signs the calling session out, invalidating its tokens.
- [Delete span mappers](/docs/openapi/o11y/deletespanmapper): Deletes one mapper from a group.
- [Delete span mapper groups](/docs/openapi/o11y/deletespanmappergroup): Deletes a mapping group and every mapper under it.
- [Delete trace funnels](/docs/openapi/o11y/deletetracefunnel): Deletes a funnel. The answer carries no data — the runtime acknowledges with the success envelope alone, which is what this Out says.
- [Delete users](/docs/openapi/o11y/deleteuser): Removes one org member, by user id.
- [Delete user](/docs/openapi/o11y/deleteuserdeprecated): Removes one org member, by user id.
- [Delete accounts](/docs/openapi/o11y/disconnectaccount): Tears down a connected account for the given provider, by id.
- [Create forgot](/docs/openapi/o11y/forgotpassword): Starts the forgotten-password flow: the named user is mailed a reset link.
- [List last](/docs/openapi/o11y/get-o11y-alerts-last): Answers the most recent Alertmanager deliveries THIS process received, as plain text — one greppable `ALERT-RECEIVED` line per alert, followed by the…
- [List aggregate attributes](/docs/openapi/o11y/get-o11y-autocomplete-aggregate-attributes): 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](/docs/openapi/o11y/get-o11y-autocomplete-attribute-keys): 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](/docs/openapi/o11y/get-o11y-autocomplete-attribute-values): Lists the values one attribute key has taken — string, number and bool values in their own lists — for completing a filter.
- [List availability](/docs/openapi/o11y/get-o11y-availability): Reports how much of the Hanzo fleet is up — the current per-service inventory plus an up-versus-reporting trend across the window.
- [List attribute keys](/docs/openapi/o11y/get-o11y-clusters-attribute-keys): Lists the metric attribute keys Kubernetes clusters report, for building cluster filters.
- [List attribute values](/docs/openapi/o11y/get-o11y-clusters-attribute-values): Lists the values one cluster attribute key has taken, for building cluster filters.
- [List google](/docs/openapi/o11y/get-o11y-complete-google): The callback Google redirects a user back to after they approve the sign-in.
- [List oidc](/docs/openapi/o11y/get-o11y-complete-oidc): The callback any configured OIDC provider redirects back to.
- [List attribute keys](/docs/openapi/o11y/get-o11y-daemonsets-attribute-keys): Lists the metric attribute keys Kubernetes daemonsets report, for building daemonset filters.
- [List attribute values](/docs/openapi/o11y/get-o11y-daemonsets-attribute-values): Lists the values one daemonset attribute key has taken, for building daemonset filters.
- [List attribute keys](/docs/openapi/o11y/get-o11y-deployments-attribute-keys): Lists the metric attribute keys Kubernetes deployments report, for building deployment filters.
- [List attribute values](/docs/openapi/o11y/get-o11y-deployments-attribute-values): Lists the values one deployment attribute key has taken, for building deployment filters.
- [List disks](/docs/openapi/o11y/get-o11y-disks): Lists the storage disks the datastore reports, with their names and types.
- [List errorFromErrorID](/docs/openapi/o11y/get-o11y-errorfromerrorid): Returns one exception instance and the span it happened on, by its error id within a group at a timestamp.
- [List errorFromGroupID](/docs/openapi/o11y/get-o11y-errorfromgroupid): Returns the representative exception instance of a group at a timestamp, and the span it happened on.
- [List issues](/docs/openapi/o11y/get-o11y-errortracking-issues): Lists the caller's org's grouped error issues (by fingerprint) with status, level, counts and first/last-seen.
- [Get issues](/docs/openapi/o11y/get-o11y-errortracking-issues-by-id): Returns one grouped issue with its latest occurrence sample.
- [List views](/docs/openapi/o11y/get-o11y-explorer-views): Lists the caller's org's saved explorer views, optionally narrowed to one source page, name or category.
- [Get views](/docs/openapi/o11y/get-o11y-explorer-views-by-viewid): Returns one saved explorer view by id.
- [List features](/docs/openapi/o11y/get-o11y-features): Returns the supported feature flags and their resolved values for the caller's org.
- [List keys](/docs/openapi/o11y/get-o11y-fields-keys): Returns the telemetry field keys matching the selector — the signal's fields grouped by name, and whether the catalog is complete.
- [List values](/docs/openapi/o11y/get-o11y-fields-values): Returns the values one telemetry field has taken — string, bool, number and related values — and whether the value list is complete.
- [List filter suggestions](/docs/openapi/o11y/get-o11y-filter-suggestions): Suggests attribute keys and example filter queries for the query builder, seeded by what the org's own telemetry carries.
- [List config](/docs/openapi/o11y/get-o11y-global-config): Returns the deployment's global configuration: its public endpoints and which identity providers are enabled.
- [List health](/docs/openapi/o11y/get-o11y-health): Reports service health. With live set, the datastore connection is checked too and an unhealthy store refuses with 503.
- [List healthz](/docs/openapi/o11y/get-o11y-healthz): 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…
- [List attribute keys](/docs/openapi/o11y/get-o11y-hosts-attribute-keys): 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](/docs/openapi/o11y/get-o11y-hosts-attribute-values): Lists the values one host attribute key has taken, for building host filters — string, number and bool values in their own lists.
- [List checks](/docs/openapi/o11y/get-o11y-infra-monitoring-checks): Reports whether the metrics and attributes an infra-monitoring section needs are being received — for each collector receiver or processor involved, what…
- [List status](/docs/openapi/o11y/get-o11y-infra-onboarding-k8s-status): 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](/docs/openapi/o11y/get-o11y-jobs-attribute-keys): Lists the metric attribute keys Kubernetes jobs report, for building job filters.
- [List attribute values](/docs/openapi/o11y/get-o11y-jobs-attribute-values): Lists the values one job attribute key has taken, for building job filters.
- [List licenses](/docs/openapi/o11y/get-o11y-licenses): Lists the org's licenses. This build has no enterprise edition, so the list is intentionally empty.
- [List active](/docs/openapi/o11y/get-o11y-licenses-active): Activates the enterprise license. This build has no enterprise edition, so the licensing provider refuses it as unsupported.
- [List livez](/docs/openapi/o11y/get-o11y-livez): Answers 200 unconditionally while the process is running, and asserts NOTHING about the telemetry stores behind it.
- [Login o11y](/docs/openapi/o11y/get-o11y-login): Where a failed sign-in callback lands. The module builds that redirect with a path and no host, so it can only be same-origin, and its assumption is that…
- [List logs](/docs/openapi/o11y/get-o11y-logs): Returns the most recent log records in the query window, newest first — each record an open object carrying its nanosecond timestamp and whatever fields…
- [List aggregate](/docs/openapi/o11y/get-o11y-logs-aggregate): Returns the logs aggregate buckets for the query window. The runtime currently answers the empty set; the shape is the contract.
- [List fields](/docs/openapi/o11y/get-o11y-logs-fields): 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](/docs/openapi/o11y/get-o11y-logs-livetail): 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](/docs/openapi/o11y/get-o11y-logs-pipelines-by-version): 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…
- [List promote paths](/docs/openapi/o11y/get-o11y-logs-promote-paths): Lists the log body paths already promoted or indexed, with the indexes each carries.
- [List metric metadata](/docs/openapi/o11y/get-o11y-metric-metric-metadata): Serves the OLDER /metric/metric_metadata route.
- [List attribute keys](/docs/openapi/o11y/get-o11y-namespaces-attribute-keys): Lists the metric attribute keys Kubernetes namespaces report, for building namespace filters.
- [List attribute values](/docs/openapi/o11y/get-o11y-namespaces-attribute-values): Lists the values one namespace attribute key has taken, for building namespace filters.
- [List nextPrevErrorIDs](/docs/openapi/o11y/get-o11y-nextpreverrorids): 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](/docs/openapi/o11y/get-o11y-nodes-attribute-keys): Lists the metric attribute keys Kubernetes nodes report, for building node filters.
- [List attribute values](/docs/openapi/o11y/get-o11y-nodes-attribute-values): Lists the values one node attribute key has taken, for building node filters.
- [List attribute keys](/docs/openapi/o11y/get-o11y-pods-attribute-keys): Lists the metric attribute keys Kubernetes pods report, for building pod filters.
- [List attribute values](/docs/openapi/o11y/get-o11y-pods-attribute-values): Lists the values one pod attribute key has taken, for building pod filters.
- [List attribute keys](/docs/openapi/o11y/get-o11y-processes-attribute-keys): Lists the metric attribute keys processes report, for building process filters.
- [List attribute values](/docs/openapi/o11y/get-o11y-processes-attribute-values): Lists the values one process attribute key has taken, for building process filters.
- [List metrics](/docs/openapi/o11y/get-o11y-product-metrics): 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…
- [List attribute keys](/docs/openapi/o11y/get-o11y-pvcs-attribute-keys): Lists the metric attribute keys persistent volume claims report, for building volume filters.
- [List attribute values](/docs/openapi/o11y/get-o11y-pvcs-attribute-values): Lists the values one persistent-volume-claim attribute key has taken, for building volume filters.
- [Query o11y](/docs/openapi/o11y/get-o11y-query): Evaluates one instant PromQL query against the org's metrics and returns the result at a single point in time.
- [List query progress](/docs/openapi/o11y/get-o11y-query-progress): Reports how far a submitted query has got — rows scanned, bytes read, elapsed — and HOLDS the connection until the next update rather than answering…
- [List query range](/docs/openapi/o11y/get-o11y-query-range): 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…
- [List readyz](/docs/openapi/o11y/get-o11y-readyz): 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…
- [List reviews](/docs/openapi/o11y/get-o11y-reviews): Returns a page of the caller org's human-review queues, newest first, narrowed to the caller's project.
- [Get reviews](/docs/openapi/o11y/get-o11y-reviews-by-id): Returns one review queue with its pending and completed counts and its first page of items.
- [List items](/docs/openapi/o11y/get-o11y-reviews-by-id-items): Returns a page of one review queue's items, newest first, optionally filtered to PENDING or COMPLETED.
- [Get events](/docs/openapi/o11y/get-o11y-sentinel-events-by-id): Returns one captured error event of a project, by its id.
- [List issues](/docs/openapi/o11y/get-o11y-sentinel-issues): Lists the caller's org's grouped error issues, optionally narrowed to one project and one time window, and filtered by status, level, environment,…
- [Get issues](/docs/openapi/o11y/get-o11y-sentinel-issues-by-id): Returns one grouped issue of the caller's org with its latest occurrence sample.
- [List events](/docs/openapi/o11y/get-o11y-sentinel-issues-by-id-events): 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](/docs/openapi/o11y/get-o11y-sentinel-logs): Lists a project's captured error events, newest first, optionally narrowed to those whose message or exception text contains a search string.
- [List projects](/docs/openapi/o11y/get-o11y-sentinel-projects): Lists the caller's org's Sentry projects, each with its freshly-derived DSN.
- [Get projects](/docs/openapi/o11y/get-o11y-sentinel-projects-by-id): Returns one Sentry project of the caller's org, DSN included.
- [List stats](/docs/openapi/o11y/get-o11y-sentinel-stats): Returns a project's event-rate timeseries: one bucket per interval over the requested period, counting the events in it.
- [List traces](/docs/openapi/o11y/get-o11y-sentinel-traces): 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…
- [Get traces](/docs/openapi/o11y/get-o11y-sentinel-traces-by-id): 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 list](/docs/openapi/o11y/get-o11y-services-list): Lists the name of every service the trace store holds, with no window applied — the complete catalog, for pickers and autocomplete.
- [List sessions](/docs/openapi/o11y/get-o11y-sessions): 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…
- [List apdex](/docs/openapi/o11y/get-o11y-settings-apdex): Returns apdex settings for the named services.
- [List ttl](/docs/openapi/o11y/get-o11y-settings-ttl): Returns the org's current retention policy: default TTL, custom per-label rules, and cold-storage settings where configured.
- [List attribute keys](/docs/openapi/o11y/get-o11y-statefulsets-attribute-keys): Lists the metric attribute keys Kubernetes statefulsets report, for building statefulset filters.
- [List attribute values](/docs/openapi/o11y/get-o11y-statefulsets-attribute-values): Lists the values one statefulset attribute key has taken, for building statefulset filters.
- [List stats](/docs/openapi/o11y/get-o11y-stats): 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…
- [List status](/docs/openapi/o11y/get-o11y-status): 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](/docs/openapi/o11y/get-o11y-summary): Reports whether the platform is up. It returns the public status document: the incidents currently open against Hanzo's own services, derived from the…
- [List traces](/docs/openapi/o11y/get-o11y-traces): 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](/docs/openapi/o11y/get-o11y-usage): Returns ingestion usage counts bucketed over the requested window, optionally narrowed to one service.
- [List version](/docs/openapi/o11y/get-o11y-version): 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](/docs/openapi/o11y/getaccount): Returns one connected account for the given provider, by id.
- [Get services](/docs/openapi/o11y/getaccountservice): Returns one service and its configuration for a connected account of the given provider, by account id and service id.
- [List alerts](/docs/openapi/o11y/getalerts): Returns the org's current alerts.
- [List route policies](/docs/openapi/o11y/getallroutepolicies): Lists the org's route policies.
- [Get domains](/docs/openapi/o11y/getauthdomain): Returns one auth domain with its SSO configuration, by id.
- [Get channels](/docs/openapi/o11y/getchannelbyid): Returns one notification channel, by id.
- [List credentials](/docs/openapi/o11y/getconnectioncredentials): Returns the credentials the connecting agent needs to establish the cloud integration, for the given cloud provider.
- [Get dashboards](/docs/openapi/o11y/getdashboardv2): Returns a v2-shape dashboard.
- [Get downtime schedules](/docs/openapi/o11y/getdowntimeschedulebyid): Returns one planned maintenance window, by id.
- [Create error traces](/docs/openapi/o11y/getdraftfunnelerrortraces): Returns the errored traces through a step transition of a funnel described inline.
- [Create overview](/docs/openapi/o11y/getdraftfunneloverview): Returns the conversion overview of a funnel described inline.
- [Create slow traces](/docs/openapi/o11y/getdraftfunnelslowtraces): Returns the slowest traces through a step transition of a funnel described inline.
- [Create steps](/docs/openapi/o11y/getdraftfunnelstepmetrics): Returns the per-step metrics of a funnel described inline.
- [Create overview](/docs/openapi/o11y/getdraftfunnelstepoverview): Returns the conversion between two steps of a funnel described inline.
- [Create flamegraph](/docs/openapi/o11y/getflamegraph): Returns a trace's flamegraph: spans bucketed by depth level, each level ordered as it is drawn, around the selected span.
- [List hosts](/docs/openapi/o11y/gethosts): Returns the deployment's host info from Zeus.
- [List ingestion keys](/docs/openapi/o11y/getingestionkeys): Lists the workspace's ingestion keys, paginated.
- [Get integrations](/docs/openapi/o11y/getintegration): Returns one integration's full detail — its overview, configuration steps, collected data and assets — together with its installation record when the org…
- [List connection status](/docs/openapi/o11y/getintegrationconnectionstatus): 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](/docs/openapi/o11y/getllmpricingrule): Returns a single LLM pricing rule by id.
- [Get score](/docs/openapi/o11y/getllmscore): Returns a single score by id.
- [List alerts](/docs/openapi/o11y/getmetricalerts): Lists the alert rules that reference a metric.
- [List attributes](/docs/openapi/o11y/getmetricattributes): Returns one metric's attribute keys, each with its unique values and their count.
- [List dashboards](/docs/openapi/o11y/getmetricdashboardsv2): Lists the dashboard panels that reference a metric.
- [List highlights](/docs/openapi/o11y/getmetrichighlights): Returns one metric's headline numbers: data points, total and active time series, and when it was last received.
- [List metadata](/docs/openapi/o11y/getmetricmetadata): Returns one metric's metadata: description, type, unit, temporality and monotonicity.
- [Get metric reduction rules](/docs/openapi/o11y/getmetricreductionrulebyid): Returns one volume-control rule by its id.
- [List stats](/docs/openapi/o11y/getmetricreductionrulestats): Returns total ingested vs retained series and samples and the estimated monthly savings across all volume-control rules.
- [List timeseries](/docs/openapi/o11y/getmetricreductionruletimeseries): 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](/docs/openapi/o11y/getmetricsonboardingstatus): Reports whether any non-O11y metrics have been ingested — the lightweight check onboarding polls.
- [Create stats](/docs/openapi/o11y/getmetricsstats): 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](/docs/openapi/o11y/getmetricstreemap): Returns the proportional distribution of metrics by sample count or time-series count, as the entries of a treemap.
- [List me](/docs/openapi/o11y/getmyorganization): Returns the caller's own organization.
- [List me](/docs/openapi/o11y/getmyserviceaccount): Returns the calling service account itself, with the roles it holds — the self-inspection read for a key-authenticated caller.
- [List me](/docs/openapi/o11y/getmyuser): Returns the calling user together with every role they hold.
- [List me](/docs/openapi/o11y/getmyuserdeprecated): Returns the calling user with their single legacy role.
- [Get preferences](/docs/openapi/o11y/getorgpreference): Returns one org-scoped preference, by name.
- [Create overall status](/docs/openapi/o11y/getoverallstatetransitions): Returns the overall firing/inactive windows for a rule, for the posted query range.
- [List public](/docs/openapi/o11y/getpublicdashboard): Returns the public-sharing config for a dashboard.
- [Get dashboards](/docs/openapi/o11y/getpublicdashboarddata): Returns the sanitized dashboard data for public access — the read a shared dashboard's public page makes.
- [List query range](/docs/openapi/o11y/getpublicdashboardwidgetqueryrange): Returns the query-range result for one widget of a public dashboard.
- [List filters](/docs/openapi/o11y/getquickfilters): Returns the org's quick filters for every signal — the attribute shortlists its explorers offer as one-click filters.
- [List reset password tokens](/docs/openapi/o11y/getresetpasswordtoken): Returns the reset-password token a user already has; absent one, the answer is a not-found rather than a fresh token.
- [Get getResetPasswordToken](/docs/openapi/o11y/getresetpasswordtokendeprecated): Returns a user's password-reset token, creating one if none is live.
- [Get roles](/docs/openapi/o11y/getrole): Returns one role with the transaction groups it grants.
- [List roles](/docs/openapi/o11y/getrolesbyuserid): Returns every role one org member holds, by user id.
- [Get route policies](/docs/openapi/o11y/getroutepolicybyid): Returns one route policy, by id.
- [Get rules](/docs/openapi/o11y/getrulebyid): Returns one alert rule with its evaluation state, by id.
- [List filter keys](/docs/openapi/o11y/getrulehistoryfilterkeys): Returns the distinct label keys present in a rule's history entries over the selected range, for building history filters.
- [List filter values](/docs/openapi/o11y/getrulehistoryfiltervalues): Returns the distinct values a given label key has taken across a rule's history entries.
- [List overall status](/docs/openapi/o11y/getrulehistoryoverallstatus): Returns the overall firing/inactive intervals for a rule over the selected range.
- [List stats](/docs/openapi/o11y/getrulehistorystats): Returns trigger and resolution statistics for a rule over the selected time range, current window against the prior one.
- [List timeline](/docs/openapi/o11y/getrulehistorytimeline): Returns paginated timeline entries for a rule's state transitions, filterable by state and a label expression, cursor-paginated.
- [List top contributors](/docs/openapi/o11y/getrulehistorytopcontributors): Returns the label combinations that contributed most to a rule firing over the selected range.
- [Create timeline](/docs/openapi/o11y/getrulestatehistory): 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](/docs/openapi/o11y/getrulestatehistorytopcontributors): Returns the label combinations that contributed most to a rule firing, for the posted query range.
- [Create stats](/docs/openapi/o11y/getrulestats): Returns trigger and resolution statistics for a rule, current window against the prior one, for the posted query range.
- [Get services](/docs/openapi/o11y/getservice): Returns one service the given provider can collect from, by service id, optionally scoped to one cloud integration.
- [Get service accounts](/docs/openapi/o11y/getserviceaccount): Returns one service account with the roles it holds.
- [List roles](/docs/openapi/o11y/getserviceaccountroles): Lists the roles a service account holds.
- [List context](/docs/openapi/o11y/getsessioncontext): Tells a sign-in page what an email address can do: which orgs the address belongs to and, per org, which password and SSO routes are open to it.
- [Get filters](/docs/openapi/o11y/getsignalfilters): Returns the org's quick filters for one signal — traces, logs, metrics, exceptions or api_monitoring.
- [Create aggregations](/docs/openapi/o11y/gettraceaggregations): Computes span aggregations over one trace — span count, duration or share of execution time — grouped by the resource field each aggregation names.
- [List fields](/docs/openapi/o11y/gettracefields): 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](/docs/openapi/o11y/gettracefunnel): Returns one funnel with its steps.
- [Create error traces](/docs/openapi/o11y/gettracefunnelerrortraces): Returns the errored traces through a step transition of a saved funnel — the entry point for "why is this step failing".
- [Create overview](/docs/openapi/o11y/gettracefunneloverview): Returns a saved funnel's conversion overview over a window: how many entered, how many converted, the rate and the latency.
- [Create slow traces](/docs/openapi/o11y/gettracefunnelslowtraces): Returns the slowest traces through a step transition of a saved funnel — the entry point for "why is this step slow".
- [Create steps](/docs/openapi/o11y/gettracefunnelstepmetrics): Returns a saved funnel's per-step metrics over a window — the counts and latencies at each step, in step order.
- [Create overview](/docs/openapi/o11y/gettracefunnelstepoverview): Returns the conversion between two named steps of a saved funnel — the step-to-step drill-down behind the overview.
- [Get users](/docs/openapi/o11y/getuser): Returns one org member together with every role they hold, by user id.
- [Get user](/docs/openapi/o11y/getuserdeprecated): Returns one org member with their single legacy role, by user id.
- [Get preferences](/docs/openapi/o11y/getuserpreference): Returns one preference of the calling user, by name.
- [List users](/docs/openapi/o11y/getusersbyroleid): Returns every org member holding a role, by role id.
- [Create waterfall](/docs/openapi/o11y/getwaterfallv4): 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…
- [Create inspect](/docs/openapi/o11y/inspectmetrics): 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](/docs/openapi/o11y/installintegration): Installs an integration into the caller's org from its id and configuration, answering with the installed catalog item.
- [List accounts](/docs/openapi/o11y/listaccounts): Lists the cloud-integration accounts connected for the given provider.
- [List services](/docs/openapi/o11y/listaccountservicesmetadata): Lists the services metadata for one connected account of the given provider, by account id.
- [List domains](/docs/openapi/o11y/listauthdomains): Lists the org's auth domains — the email domains whose SSO configuration this org owns.
- [List channels](/docs/openapi/o11y/listchannels): Lists the org's notification channels.
- [List dashboards](/docs/openapi/o11y/listdashboardsforuserv2): Is dashboardListV2 personalized for the calling user: each dashboard carries the caller's pinned state, and pinned dashboards float to the top of the…
- [List dashboards](/docs/openapi/o11y/listdashboardsv2): Returns a page of v2-shape dashboards for the org.
- [List dashboard views](/docs/openapi/o11y/listdashboardviews): Returns every saved view in the calling user's org.
- [List downtime schedules](/docs/openapi/o11y/listdowntimeschedules): Lists all planned maintenance windows, optionally narrowed to the active ones or the recurring ones.
- [List integrations](/docs/openapi/o11y/listintegrations): Lists the available integrations and whether each is installed in the caller's org, optionally narrowed to installed or not-installed.
- [List annotation](/docs/openapi/o11y/listllmannotations): Lists human annotations on traces and observations, optionally scoped to one review queue.
- [List observations](/docs/openapi/o11y/listllmobservations): 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,…
- [List llm pricing rules](/docs/openapi/o11y/listllmpricingrules): Returns the LLM pricing rules for the caller's org, with pagination and an optional search and override filter.
- [List scores](/docs/openapi/o11y/listllmscores): Lists eval scores and human-feedback signals attached to traces and observations, newest first.
- [List sessions](/docs/openapi/o11y/listllmsessions): Lists conversations — gen_ai spans grouped by session.id, with their trace and observation counts, tokens and cost.
- [List traces](/docs/openapi/o11y/listllmtraces): Lists LLM traces — gen_ai spans grouped by trace_id, with cost, tokens and latency rolled up across each trace.
- [List users](/docs/openapi/o11y/listllmusers): Lists end users — gen_ai spans grouped by user.id, with their session, trace and observation counts, tokens and cost.
- [List metric reduction rules](/docs/openapi/o11y/listmetricreductionrules): Lists the org's metric volume-control (label reduction) rules, pageable and sortable by name, volume or recency.
- [List metrics](/docs/openapi/o11y/listmetrics): Lists the distinct metric names seen in a time range, each with its description, type, unit, temporality and monotonicity.
- [List preferences](/docs/openapi/o11y/listorgpreferences): Lists every org-scoped preference, each with its current and default value.
- [List roles](/docs/openapi/o11y/listroles): Lists every role in the caller's org — the managed ones the platform seeds and the custom ones its admins created.
- [List rules](/docs/openapi/o11y/listrules): Lists all alert rules with their current evaluation state.
- [List keys](/docs/openapi/o11y/listserviceaccountkeys): Lists a service account's API keys — metadata only, never the secrets.
- [List service accounts](/docs/openapi/o11y/listserviceaccounts): Lists the caller's org's service accounts.
- [List services](/docs/openapi/o11y/listservicesmetadata): Lists the services the given provider can collect from, optionally scoped to one cloud integration.
- [List span mapper groups](/docs/openapi/o11y/listspanmappergroups): Lists the caller's org's mapping groups, optionally only the enabled ones.
- [List span mappers](/docs/openapi/o11y/listspanmappers): Lists the mappers belonging to one group, in the order they are applied.
- [List list](/docs/openapi/o11y/listtracefunnels): Lists the caller's org's funnels, each with its steps and who last touched it.
- [List preferences](/docs/openapi/o11y/listuserpreferences): Lists every preference of the calling user, each with its current and default value.
- [List users](/docs/openapi/o11y/listusers): Lists the caller's org members.
- [List user](/docs/openapi/o11y/listusersdeprecated): Lists the org's members with their single legacy role.
- [Replace lock](/docs/openapi/o11y/lockdashboardv2): Locks a v2-shape dashboard. Only the dashboard's creator or an org admin may lock or unlock.
- [Update reviews](/docs/openapi/o11y/patch-o11y-reviews-by-id): Changes a review queue's name, description or score-config set. A field the request omits is left alone.
- [Update items](/docs/openapi/o11y/patch-o11y-reviews-by-id-items-by-itemid): Moves one queue item between PENDING and COMPLETED and sets its assignee. Completing an item stamps its completedAt.
- [Update dashboards](/docs/openapi/o11y/patchdashboardv2): Applies an RFC 6902 JSON Patch to a v2-shape dashboard.
- [Update rules](/docs/openapi/o11y/patchrulebyid): 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](/docs/openapi/o11y/pindashboardv2): Pins a dashboard for the calling user. A user can pin at most ten dashboards; pinning at the limit refuses with the runtime's conflict.
- [Create alerts](/docs/openapi/o11y/post-o11y-alerts-by-receiver): Records one Alertmanager webhook delivery and pages the on-call.
- [Create envelope](/docs/openapi/o11y/post-o11y-api-by-project-id-envelope): Accepts an application/x-sentry-envelope frame from a Sentry SDK — the batched wire format carrying events, sessions and attachments — and ingests it…
- [Create store](/docs/openapi/o11y/post-o11y-api-by-project-id-store): The legacy single-event form of the envelope ingest: one JSON event rather than a framed batch, kept because SDKs in the field still send it.
- [Create attribute values](/docs/openapi/o11y/post-o11y-auto-complete-attribute-values): 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…
- [Create list](/docs/openapi/o11y/post-o11y-clusters-list): Lists Kubernetes clusters over a time range, each with its CPU and memory usage against allocatable capacity and its attributes; filterable, groupable and…
- [Create saml](/docs/openapi/o11y/post-o11y-complete-saml): The assertion consumer service: the identity provider POSTs its signed assertion here, and a valid one establishes the session and answers 303 to the…
- [Create countErrors](/docs/openapi/o11y/post-o11y-counterrors): Counts the grouped exceptions in the query window for the caller's org.
- [Create list](/docs/openapi/o11y/post-o11y-daemonsets-list): 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,…
- [Create dependency graph](/docs/openapi/o11y/post-o11y-dependency-graph): Returns the service dependency graph over the requested window: every parent→child edge observed, with call and error rates and latency percentiles per…
- [Create list](/docs/openapi/o11y/post-o11y-deployments-list): Lists Kubernetes deployments over a time range, each with the CPU and memory its pods used against request and limit, desired and available replica…
- [Create issues](/docs/openapi/o11y/post-o11y-errortracking-issues-by-id): Changes an issue's lifecycle — resolve, ignore, reopen or assign — and returns the updated issue. Fields left unset are left unchanged.
- [Create event](/docs/openapi/o11y/post-o11y-event): Records one product-analytics event for the signed-in user — a track event with a name and free-form attributes.
- [Create views](/docs/openapi/o11y/post-o11y-explorer-views): Saves a new explorer view for the caller's org and returns its id.
- [Create export raw data](/docs/openapi/o11y/post-o11y-export-raw-data): 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…
- [Create list](/docs/openapi/o11y/post-o11y-hosts-list): 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…
- [Create clusters](/docs/openapi/o11y/post-o11y-infra-monitoring-clusters): Lists Kubernetes clusters with CPU and memory usage against allocatable capacity summed over their nodes, plus per-group node readiness and pod phase…
- [Create daemonsets](/docs/openapi/o11y/post-o11y-infra-monitoring-daemonsets): Lists Kubernetes daemonsets with the CPU and memory their pods used against request and limit, the latest desired and current scheduled NODE counts (node…
- [Create deployments](/docs/openapi/o11y/post-o11y-infra-monitoring-deployments): Lists Kubernetes deployments with the CPU and memory their pods used against request and limit, the latest desired and available replica counts, and…
- [Create hosts](/docs/openapi/o11y/post-o11y-infra-monitoring-hosts): 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…
- [Create jobs](/docs/openapi/o11y/post-o11y-infra-monitoring-jobs): Lists Kubernetes jobs with the CPU and memory their pods used against request and limit, the latest desired-successful, active, failed and successful pod…
- [Create namespaces](/docs/openapi/o11y/post-o11y-infra-monitoring-namespaces): Lists Kubernetes namespaces with the CPU and memory their pods used and per-group pod phase counts.
- [Create nodes](/docs/openapi/o11y/post-o11y-infra-monitoring-nodes): Lists Kubernetes nodes with CPU and memory usage against allocatable capacity, per-group readiness counts and per-group phase counts for the pods…
- [Create pods](/docs/openapi/o11y/post-o11y-infra-monitoring-pods): 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…
- [Create pvcs](/docs/openapi/o11y/post-o11y-infra-monitoring-pvcs): Lists Kubernetes persistent volume claims with available, capacity and used bytes and inode counts, plus the claim's pod, namespace, node, statefulset and…
- [Create statefulsets](/docs/openapi/o11y/post-o11y-infra-monitoring-statefulsets): Lists Kubernetes statefulsets with the CPU and memory their pods used against request and limit, the latest desired and current replica counts, and…
- [Create list](/docs/openapi/o11y/post-o11y-jobs-list): 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…
- [Create listErrors](/docs/openapi/o11y/post-o11y-listerrors): 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](/docs/openapi/o11y/post-o11y-logs-fields): 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](/docs/openapi/o11y/post-o11y-logs-pipelines): Saves the given log parsing pipelines as the new config version for the caller's org and starts deploying it.
- [Preview pipelines](/docs/openapi/o11y/post-o11y-logs-pipelines-preview): Runs the given log parsing pipelines over the given sample records without saving anything, and returns the transformed records plus whatever the…
- [Create promote paths](/docs/openapi/o11y/post-o11y-logs-promote-paths): 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](/docs/openapi/o11y/post-o11y-messaging-queues-kafka-consumer-lag-consumer-details): Returns the consumer side of a consumer-lag view: the consumer groups reading the topic/partition named in variables, with their throughput and latency…
- [Create network latency](/docs/openapi/o11y/post-o11y-messaging-queues-kafka-consumer-lag-network-latency): Returns consumer network latency correlated per client: a throughput pass over the window finds the consumer clients, then their fetch latency joins in as…
- [Create producer details](/docs/openapi/o11y/post-o11y-messaging-queues-kafka-consumer-lag-producer-details): 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…
- [Create consumers](/docs/openapi/o11y/post-o11y-messaging-queues-kafka-onboarding-consumers): Checks whether the spans the Kafka consumer views need are arriving, row for row like producersOnboarding.
- [Create kafka](/docs/openapi/o11y/post-o11y-messaging-queues-kafka-onboarding-kafka): Checks whether Kafka's own metrics — consumer lag and partition telemetry — are arriving, so the lag views can be lit up.
- [Create producers](/docs/openapi/o11y/post-o11y-messaging-queues-kafka-onboarding-producers): 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…
- [Create consumer](/docs/openapi/o11y/post-o11y-messaging-queues-kafka-partition-latency-consumer): Returns the consumer-group latency detail for the topic and partition named in the request's variables.
- [Create overview](/docs/openapi/o11y/post-o11y-messaging-queues-kafka-partition-latency-overview): Returns the per-partition latency overview for the window — each topic/partition with its throughput and latency profile.
- [Create evaluation](/docs/openapi/o11y/post-o11y-messaging-queues-kafka-span-evaluation): 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…
- [Create consumer](/docs/openapi/o11y/post-o11y-messaging-queues-kafka-topic-throughput-consumer): Returns the consumer topic-throughput overview for the window — what each consumer group read, per topic.
- [Create consumer details](/docs/openapi/o11y/post-o11y-messaging-queues-kafka-topic-throughput-consumer-details): Breaks one consumer topic's throughput down using the topic and service named in variables.
- [Create producer](/docs/openapi/o11y/post-o11y-messaging-queues-kafka-topic-throughput-producer): Returns the producer topic-throughput overview for the window — what each producer service wrote, per topic.
- [Create producer details](/docs/openapi/o11y/post-o11y-messaging-queues-kafka-topic-throughput-producer-details): Breaks one producer topic's throughput down using the topic and service named in variables.
- [Create queue overview](/docs/openapi/o11y/post-o11y-messaging-queues-queue-overview): Lists the messaging destinations observed in the window — one row per queue/destination/service combination with its throughput and latency columns.
- [Create list](/docs/openapi/o11y/post-o11y-namespaces-list): Lists Kubernetes namespaces over a time range, each with the CPU and memory its pods used, their phase counts and its attributes; filterable, groupable…
- [Create list](/docs/openapi/o11y/post-o11y-nodes-list): Lists Kubernetes nodes over a time range, each with its CPU and memory usage against allocatable capacity, readiness condition counts and attributes;…
- [Create list](/docs/openapi/o11y/post-o11y-pods-list): Lists Kubernetes pods over a time range, each with its CPU and memory usage against request and limit, restart count, phase counts and attributes;…
- [Create list](/docs/openapi/o11y/post-o11y-processes-list): Lists monitored processes over a time range, each with its name, PID, command line and CPU and memory usage; filterable, groupable and paginated.
- [Create list](/docs/openapi/o11y/post-o11y-pvcs-list): Lists Kubernetes persistent volume claims over a time range, each with its available, capacity and used bytes, inode counts and attributes; filterable,…
- [Create analyze](/docs/openapi/o11y/post-o11y-query-filter-analyze): Analyzes a query and extracts the metric names it reads and the columns it groups by.
- [Create query range](/docs/openapi/o11y/post-o11y-query-range): Executes a composite query over a time range: builder queries over traces, logs and metrics, formulas, trace operators, PromQL and Datastore SQL,…
- [Create format](/docs/openapi/o11y/post-o11y-query-range-format): 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](/docs/openapi/o11y/post-o11y-query-range-preview): Validates a composite query and renders the Datastore statements it would run WITHOUT executing it — a dry run for agentic and tooling use.
- [Create register](/docs/openapi/o11y/post-o11y-register): Creates the FIRST organization and its admin user.
- [Create reviews](/docs/openapi/o11y/post-o11y-reviews): Creates a human-review queue in the caller's org and project.
- [Create items](/docs/openapi/o11y/post-o11y-reviews-by-id-items): Enqueues traces, observations or sessions on a review queue.
- [Create discover](/docs/openapi/o11y/post-o11y-sentinel-discover): 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…
- [Create projects](/docs/openapi/o11y/post-o11y-sentinel-projects): Creates a Sentry project under the caller's org and returns it, DSN included.
- [Rotate keys](/docs/openapi/o11y/post-o11y-sentinel-projects-by-id-keys-rotate): Rotates a project's DSN key — bumping its rotation watermark so keys below it stop verifying — and returns the project with its new DSN.
- [Create entry point operations](/docs/openapi/o11y/post-o11y-service-entry-point-operations): Returns one service's entry-point operations with the same latency and error profile topOperations reports.
- [Create top level operations](/docs/openapi/o11y/post-o11y-service-top-level-operations): 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](/docs/openapi/o11y/post-o11y-service-top-operations): 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](/docs/openapi/o11y/post-o11y-services): 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,…
- [Create apdex](/docs/openapi/o11y/post-o11y-settings-apdex): Sets one service's apdex threshold and the status codes excluded from its score.
- [Create ttl](/docs/openapi/o11y/post-o11y-settings-ttl): 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](/docs/openapi/o11y/post-o11y-span-percentile): Places one span's duration among its peers: the p50/p90/p99 durations of like spans, and the percentile the given duration lands at.
- [Create list](/docs/openapi/o11y/post-o11y-statefulsets-list): Lists Kubernetes statefulsets over a time range, each with the CPU and memory its pods used against request and limit, desired and available replica…
- [Create substitute vars](/docs/openapi/o11y/post-o11y-substitute-vars): Substitutes a query's variables and returns the resolved request, without running it — what a dashboard does before it queries.
- [Create domain](/docs/openapi/o11y/post-o11y-third-party-apis-overview-domain): Returns one external domain's endpoint-level breakdown — each endpoint with its rate, error and latency columns over the window.
- [Create list](/docs/openapi/o11y/post-o11y-third-party-apis-overview-list): Lists the external domains the instrumented services call, with request rate, error percentage and latency per domain.
- [Query variables](/docs/openapi/o11y/post-o11y-variables-query): Evaluates a dashboard variable query and returns the values the variable may take.
- [Preview metric reduction rules](/docs/openapi/o11y/previewmetricreductionrule): Estimates the series reduction and the dashboards and alerts a candidate volume-control rule would touch, without persisting it.
- [Replace views](/docs/openapi/o11y/put-o11y-explorer-views-by-viewid): Replaces one saved explorer view by id with the given view and echoes it back.
- [Replace issues](/docs/openapi/o11y/put-o11y-sentinel-issues-by-id): Changes an issue's lifecycle — resolve, ignore, reopen or assign — and returns the updated issue. Fields left unset are left unchanged.
- [Replace hosts](/docs/openapi/o11y/puthost): Records the deployment's host in Zeus, overwriting any prior one.
- [Replace profiles](/docs/openapi/o11y/putprofile): Records the deployment's profile in Zeus — how the team uses observability today and what they plan — overwriting any prior one.
- [Delete roles](/docs/openapi/o11y/removeuserrolebyuseridandroleid): Takes a role away from one org member, by user id and role id — someone else, never the caller.
- [Create resetPassword](/docs/openapi/o11y/resetpassword): Sets a new password for whoever the reset token was minted for, consuming the token.
- [Delete keys](/docs/openapi/o11y/revokeserviceaccountkey): Revokes an API key.
- [Rotate sessions](/docs/openapi/o11y/rotatesession): Exchanges a refresh token for a fresh token pair, retiring the old pair.
- [Search ingestion keys](/docs/openapi/o11y/searchingestionkeys): Lists the workspace's ingestion keys whose name matches the search, paginated.
- [Get traces](/docs/openapi/o11y/searchtraces): 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…
- [Create roles](/docs/openapi/o11y/setrolebyuserid): Assigns a role, by role name, to one org member — someone else, never the caller.
- [Test channels](/docs/openapi/o11y/testchannel): Sends a test notification to the posted receiver.
- [Create testChannel](/docs/openapi/o11y/testchanneldeprecated): Sends a test notification to the posted receiver.
- [Test rules](/docs/openapi/o11y/testrule): Fires a test notification for a rule definition without saving it, answering with how many series would alert.
- [Create testRule](/docs/openapi/o11y/testrulenotification): Fires a test notification for the posted rule definition and answers with how many series alerted and a status message.
- [Create uninstall](/docs/openapi/o11y/uninstallintegration): Removes an integration from the caller's org by id.
- [Delete lock](/docs/openapi/o11y/unlockdashboardv2): Unlocks a v2-shape dashboard. Only the dashboard's creator or an org admin may lock or unlock.
- [Delete pins](/docs/openapi/o11y/unpindashboardv2): Removes the caller's pin for a dashboard. Idempotent — unpinning a dashboard that was not pinned still succeeds.
- [Replace accounts](/docs/openapi/o11y/updateaccount): Changes a connected account's configuration for the given provider, by id.
- [Replace domains](/docs/openapi/o11y/updateauthdomain): Replaces one auth domain's SSO configuration, by id.
- [Replace channels](/docs/openapi/o11y/updatechannelbyid): Replaces a notification channel's receiver, by id.
- [Replace dashboards](/docs/openapi/o11y/updatedashboardv2): Updates a v2-shape dashboard's metadata, spec and tag set. The name is immutable and locked dashboards are rejected.
- [Replace dashboard views](/docs/openapi/o11y/updatedashboardview): Replaces a saved view's name and data.
- [Replace downtime schedules](/docs/openapi/o11y/updatedowntimeschedulebyid): Replaces a planned maintenance window, by id.
- [Update ingestion keys](/docs/openapi/o11y/updateingestionkey): Changes an ingestion key, by id.
- [Update limits](/docs/openapi/o11y/updateingestionkeylimit): Changes an ingestion key limit, by limit id.
- [Create metadata](/docs/openapi/o11y/updatemetricmetadata): Updates one metric's metadata — description, type, unit, temporality, monotonicity — and answers with the bare success envelope.
- [Replace metric reduction rules](/docs/openapi/o11y/updatemetricreductionrulebyid): Updates the match type and labels of a volume-control rule by its id; the metric name is immutable.
- [Replace me](/docs/openapi/o11y/updatemyorganization): Rewrites the caller's own organization record — display name, name, alias — always addressed as "me", never by id.
- [Replace factor password](/docs/openapi/o11y/updatemypassword): Replaces the calling user's password, refusing when the old one does not match.
- [Replace me](/docs/openapi/o11y/updatemyserviceaccount): Renames the calling service account.
- [Replace me](/docs/openapi/o11y/updatemyuserv2): Renames the calling user.
- [Replace preferences](/docs/openapi/o11y/updateorgpreference): Sets one org-scoped preference, by name.
- [Replace public](/docs/openapi/o11y/updatepublicdashboard): Updates the public-sharing config for a dashboard.
- [Replace filters](/docs/openapi/o11y/updatequickfilters): Replaces the org's quick filters for one signal with the attribute list given.
- [Replace roles](/docs/openapi/o11y/updaterole): Replaces a custom role's description and transaction groups.
- [Replace route policies](/docs/openapi/o11y/updateroutepolicy): Replaces a route policy, by id, answering with the stored policy.
- [Replace rules](/docs/openapi/o11y/updaterulebyid): Replaces an alert rule's definition, by id.
- [Replace services](/docs/openapi/o11y/updateservice): Changes a service's configuration for one connected account of the given provider, by account id and service id.
- [Replace service accounts](/docs/openapi/o11y/updateserviceaccount): Renames a service account.
- [Replace keys](/docs/openapi/o11y/updateserviceaccountkey): Renames an API key or moves its expiry.
- [Update span mappers](/docs/openapi/o11y/updatespanmapper): Changes a mapper's field context, config or enabled state. Every field is optional and only the ones sent are applied.
- [Update span mapper groups](/docs/openapi/o11y/updatespanmappergroup): Changes a group's name, condition or enabled state. Every field is optional and only the ones sent are applied.
- [Create fields](/docs/openapi/o11y/updatetracefield): 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](/docs/openapi/o11y/updatetracefunnel): Renames a funnel or rewrites its description, answering the funnel as it now stands.
- [Replace update](/docs/openapi/o11y/updatetracefunnelsteps): 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 users](/docs/openapi/o11y/updateuser): Renames one org member, by user id — someone else, never the caller, who renames themselves through updateMyUser.
- [Replace user](/docs/openapi/o11y/updateuserdeprecated): Renames one org member and may move their legacy role, answering with the updated record.
- [Replace preferences](/docs/openapi/o11y/updateuserpreference): Sets one preference of the calling user, by name.
- [Validate analytics](/docs/openapi/o11y/validatedraftfunneltraces): Lists the traces that match a funnel described inline — the builder's "try this" before anything is saved.
- [Validate analytics](/docs/openapi/o11y/validatetracefunneltraces): Lists the traces that match a saved funnel over a window — the read that answers "is this funnel finding anything at all".
- [Verify reset password tokens](/docs/openapi/o11y/verifyresetpasswordtoken): Checks that a reset-password token exists and has not expired, without consuming it.
- [OpenAPI](/docs/openapi/openapi): 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…
- [List v1](/docs/openapi/openapi/get-capabilities): The API root. One row per capability — its name, the address it answers under, whether it is generally available, and the sentence it says about itself —…
- [GET /v1/{name}](/docs/openapi/openapi/get-capability): What the capability named in the path answers: every published operation, its operationId, its method and its address, and the sentence lifted from the…
- [List commands](/docs/openapi/openapi/get-openapi-commands): 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…
- [List openapi.json](/docs/openapi/openapi/get-openapijson): 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…
- [Create mcp](/docs/openapi/openapi/post-mcp): Model Context Protocol over JSON-RPC 2.0 — one POST per message, stateless, protocol revision 2026-07-28.
- [Plan](/docs/openapi/plan): The plan catalog: every tier you can buy, what it costs, and what it grants.
- [List plan](/docs/openapi/plan/get-plan): 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](/docs/openapi/plan/get-plan-blockchain): Returns the blockchain RPC plan catalog: the tiers metered in monthly compute units, with their prices, limits and overage terms.
- [List dns](/docs/openapi/plan/get-plan-dns): ListDNSPlans returns the DNS plan catalog: the tiers priced on zones, records per zone and queries per day.
- [Get entitlements](/docs/openapi/plan/get-plan-entitlements-by-id): 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](/docs/openapi/plan/get-plan-gpu): ListGPUTiers returns the rentable GPU configurations, each with its accelerator count and model, VRAM, vCPUs, host memory and hourly price.
- [List health](/docs/openapi/plan/get-plan-health): Health reports that the plans subsystem is mounted and serving.
- [List policy](/docs/openapi/plan/get-plan-policy): Returns the published pricing policy: whether pricing is transparent, the revenue-sharing terms (idle compute resale and the open-source share) and the…
- [List regions](/docs/openapi/plan/get-plan-regions): Returns the regions cloud capacity is offered in, each with its display name and physical location.
- [Get resolve](/docs/openapi/plan/get-plan-resolve-by-id): 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…
- [List schema](/docs/openapi/plan/get-plan-schema): Returns the two JSON Schema documents this surface speaks: entitlements.schema.json, which declares every entitlement key with its type, unit and enum,…
- [List storage](/docs/openapi/plan/get-plan-storage): Returns the block-storage price block: the price per GB per month and the volume size bounds a cloud plan may attach.
- [List subscriptions](/docs/openapi/plan/get-plan-subscriptions): 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…
- [List tools](/docs/openapi/plan/get-plan-tools): 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](/docs/openapi/plan/get-plan-vocab): Returns the entitlement key vocabulary: every key with its namespace, JSON type, nullability, unit, enum and title, the list of namespaces, and the engine…
- [Platform](/docs/openapi/platform): Hanzo PaaS: deploy containers to your own tenant namespace — builds, releases, environments, logs, custom domains.
- [Delete apps](/docs/openapi/platform/delete-platform-projects-by-project-apps-by-app): Deletes an application and tears down what it runs.
- [Delete domains](/docs/openapi/platform/delete-platform-projects-by-project-apps-by-app-domains-by-host): Detaches a hostname and releases the claim.
- [List apps](/docs/openapi/platform/get-platform-apps): Answers what this organisation has declared, joined with what the delivery plane has done about it.
- [Get apps](/docs/openapi/platform/get-platform-apps-by-app): Answers ONE declaration — what git says this app is, before the delivery plane has had any say in it.
- [List cd](/docs/openapi/platform/get-platform-apps-by-app-cd): 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](/docs/openapi/platform/get-platform-builds): Returns real build records for your org. It lists the org's BuildKit build records — the git build step behind a deploy — each with the repo it built, the…
- [List cd](/docs/openapi/platform/get-platform-cd): Answers every Application the delivery plane holds.
- [List ci](/docs/openapi/platform/get-platform-ci): Answers 501. The forge's Actions runs need a Forgejo API client and this deployment has none; an empty run list would be indistinguishable from a forge…
- [List environments](/docs/openapi/platform/get-platform-environments): Returns your deploy targets, and what is running on each.
- [List fleet](/docs/openapi/platform/get-platform-fleet): Returns the platform's own service tier, and where it has drifted.
- [Get fleet](/docs/openapi/platform/get-platform-fleet-by-app): Returns one platform service, resolved to production by default.
- [List health](/docs/openapi/platform/get-platform-health): Reports whether this control plane can actually deploy anything. A real probe, not a status page.
- [List pipelines](/docs/openapi/platform/get-platform-pipelines): Returns one build-and-deploy pipeline per app, with its latest run.
- [List projects](/docs/openapi/platform/get-platform-projects): Returns your org's projects, each with how many apps live under it. It lists the caller org's projects with the number of platform applications in each.
- [Get projects](/docs/openapi/platform/get-platform-projects-by-project): Returns one project and its app count. It returns a single project of the caller's org with the number of platform applications under it.
- [List apps](/docs/openapi/platform/get-platform-projects-by-project-apps): Returns the applications in one project, with what the cluster says about them. It lists the caller org's applications under one project.
- [Get apps](/docs/openapi/platform/get-platform-projects-by-project-apps-by-app): Returns one application, with its live phase, health and secret sync.
- [List deployments](/docs/openapi/platform/get-platform-projects-by-project-apps-by-app-deployments): Returns an app's deployment history. It lists every deployment recorded for one of the caller org's applications, newest version first, each with its…
- [Get deployments](/docs/openapi/platform/get-platform-projects-by-project-apps-by-app-deployments-by-id): Returns one deployment of one app. It returns a single deployment by id, scoped to the named application of the caller's org — so an id belonging to…
- [List logs](/docs/openapi/platform/get-platform-projects-by-project-apps-by-app-deployments-by-id-logs): Returns real logs for a deployment — the build's, then the app's.
- [List domains](/docs/openapi/platform/get-platform-projects-by-project-apps-by-app-domains): Returns every hostname this app answers on.
- [List releases](/docs/openapi/platform/get-platform-releases): Returns the versions that actually reached the cluster.
- [Create apps](/docs/openapi/platform/post-platform-apps): Builds a git repository into an image and writes the declaration that names it — a values file in `hanzoai/universe` under…
- [Deploy fleet](/docs/openapi/platform/post-platform-fleet-by-app-deploy): Rolls a platform service's pods, in a named environment.
- [Create hook](/docs/openapi/platform/post-platform-hook): The forge's push-to-deploy endpoint. git.hanzo.ai runs as a separate server, so its pushes never reach this fleet's own receive-pack; without this a push…
- [Create apps](/docs/openapi/platform/post-platform-projects-by-project-apps): Creates an application from a git repo or a container image.
- [Deploy apps](/docs/openapi/platform/post-platform-projects-by-project-apps-by-app-deploy): Deploys the app — building it first if it comes from git.
- [Create domains](/docs/openapi/platform/post-platform-projects-by-project-apps-by-app-domains): Attaches a hostname — instantly if you already own it, otherwise with a DNS challenge.
- [Verify domains](/docs/openapi/platform/post-platform-projects-by-project-apps-by-app-domains-by-host-verify): Checks a custom domain's DNS and turns it on if it passes.
- [Preview apps](/docs/openapi/platform/post-platform-projects-by-project-apps-by-app-preview): Puts a branch on its own URL. It deploys an already-built `image` to a per-branch preview and answers its URL, the branch, the preview's slug and the…
- [Create promote](/docs/openapi/platform/post-platform-projects-by-project-apps-by-app-promote): Promotes an already-built release to the app.
- [Create rollback](/docs/openapi/platform/post-platform-projects-by-project-apps-by-app-rollback): Goes back to the previous release. It redeploys a prior image: the one named by `deploymentId`, or — with no body — the newest earlier deployment that…
- [Start apps](/docs/openapi/platform/post-platform-projects-by-project-apps-by-app-start): Starts a stopped app back up. It scales the app's Service back to its configured replica count and marks it live, answering the updated application.
- [Stop apps](/docs/openapi/platform/post-platform-projects-by-project-apps-by-app-stop): Stops an app without deleting it. It scales the app's Service to zero replicas and marks it stopped, answering the updated application.
- [Run platform](/docs/openapi/platform/post-platform-run): Runs a container image and gives back a URL.
- [Create runner](/docs/openapi/platform/post-platform-runner): Triggers a native build — an image, or the binaries a repo declares. The fabric's own build trigger, and what `hanzo build` and git-push-to-deploy call.
- [Replace env](/docs/openapi/platform/put-platform-projects-by-project-apps-by-app-env): Replaces an app's environment variables. It writes the app's whole environment set and answers the updated application.
- [Plugins](/docs/openapi/plugins): Plugins — reached at /v1/admin/plugins; not in the public REST contract.
- [Pref](/docs/openapi/pref): Your own settings — theme, density, pinned nav — following you across every Hanzo app.
- [List pref](/docs/openapi/pref/get-pref): Returns the signed-in caller's OWN preference document — the theme, density and pinned nav that follow them across every Hanzo surface.
- [Update pref](/docs/openapi/pref/patch-pref): 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…
- [Pricing](/docs/openapi/pricing): The price list: what every model, provider, GPU tier, tool and hosting plan costs.
- [List pricing](/docs/openapi/pricing/get-pricing): Returns the whole pricing catalog in one document: Zen and third-party models, providers, model families, the free-model list, plan and infrastructure…
- [List base](/docs/openapi/pricing/get-pricing-base): 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](/docs/openapi/pricing/get-pricing-blockchain): Returns the blockchain access plans — the RPC and node tiers, each with its monthly price, compute-unit allowance and feature list.
- [List cloud](/docs/openapi/pricing/get-pricing-cloud): Returns the public cloud section of the catalog in one document: its instance plans, its regions and its block-storage prices.
- [List plans](/docs/openapi/pricing/get-pricing-cloud-plans): 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](/docs/openapi/pricing/get-pricing-cloud-regions): Returns the regions a cloud instance can be placed in, each with its id, display name and physical location.
- [List storage](/docs/openapi/pricing/get-pricing-cloud-storage): 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](/docs/openapi/pricing/get-pricing-compute): 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…
- [List presets](/docs/openapi/pricing/get-pricing-compute-presets): Returns just the named compute sizes — the short, human-labelled list ("Starter", "Pro") a size picker renders, each carrying its provider slug, vCPU,…
- [List datastore](/docs/openapi/pricing/get-pricing-datastore): 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](/docs/openapi/pricing/get-pricing-enablement): 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…
- [List featured](/docs/openapi/pricing/get-pricing-featured): Returns the models the catalog highlights, filtered to what the caller's org may see.
- [List free](/docs/openapi/pricing/get-pricing-free): Returns the models that cost nothing to call, filtered to what the caller's org may see.
- [List gpu](/docs/openapi/pricing/get-pricing-gpu): ListGPUTiers returns the rentable GPU configurations, each with its accelerator count and model, VRAM, vCPU, host memory and hourly price.
- [List health](/docs/openapi/pricing/get-pricing-health): Health reports that the pricing subsystem is mounted and serving.
- [List iam](/docs/openapi/pricing/get-pricing-iam): ListIAMPlans returns the identity plans — the Hanzo IAM tiers, each with its monthly and annual price, monthly-active-user allowance and feature list.
- [Get model](/docs/openapi/pricing/get-pricing-model-by-name): Returns one model's catalog entry — its pricing, context window and capabilities as the pricing source records them.
- [List models](/docs/openapi/pricing/get-pricing-models): 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](/docs/openapi/pricing/get-pricing-paas): ListPaaSPlans returns the application-hosting plans — the deploy-and-host tiers, each with its monthly and annual price, app and memory allowances and…
- [List policy](/docs/openapi/pricing/get-pricing-policy): 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…
- [List providers](/docs/openapi/pricing/get-pricing-providers): Returns the model providers the catalog knows, each with its info object, filtered to what the caller's org may see.
- [List services](/docs/openapi/pricing/get-pricing-services): 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…
- [List subscriptions](/docs/openapi/pricing/get-pricing-subscriptions): Returns the API subscription plans — the account-level tiers a customer subscribes to, each with its monthly and annual price, included credit, rate…
- [List summary](/docs/openapi/pricing/get-pricing-summary): Returns the catalog's headline statistics — model counts by family and the provider directory.
- [List tools](/docs/openapi/pricing/get-pricing-tools): Returns the per-use tool prices — web search, code interpreter, file storage, image generation, speech-to-text and text-to-speech — each with the unit it…
- [Create optin](/docs/openapi/pricing/post-pricing-enablement-optin): Opts the caller's OWN org into a beta item.
- [Create optout](/docs/openapi/pricing/post-pricing-enablement-optout): Removes the caller's OWN org from a beta item's grant list, the reverse of OptIntoBeta and idempotent.
- [Sync pricing](/docs/openapi/pricing/post-pricing-sync): Refreshes the third-party section of the catalog from its upstream listings and returns the time the refreshed catalog was stamped with.
- [Projects](/docs/openapi/projects): Where your sites live: create one, deploy a build, roll back to any release.
- [Delete projects](/docs/openapi/projects/delete-projects-by-slug): Deletes a project and takes its site off the internet.
- [Delete domains](/docs/openapi/projects/delete-projects-by-slug-domains-by-host): Gives a custom hostname back, so the name is free to reuse.
- [Delete star](/docs/openapi/projects/delete-projects-by-slug-star): Removes the caller's own bookmark from a project, and answers whether it is starred afterwards.
- [List projects](/docs/openapi/projects/get-projects): Returns every project your org owns. Each row carries the slug, name, framework, visibility, status and live URL — the same rows console and the builder…
- [Get projects](/docs/openapi/projects/get-projects-by-slug): Returns one project of yours by slug — its settings, its live URL and the deployment currently serving it.
- [List deployments](/docs/openapi/projects/get-projects-by-slug-deployments): Returns a project's deploy history, newest version first.
- [Get deployments](/docs/openapi/projects/get-projects-by-slug-deployments-by-id): Returns one deployment of a project by id.
- [List domains](/docs/openapi/projects/get-projects-by-slug-domains): Returns every custom hostname this site holds: the live ones, plus any pending claim with the DNS records it still owes.
- [List releases](/docs/openapi/projects/get-projects-by-slug-releases): Returns a site's releases newest-first, marking the active one — the rollback menu.
- [List shot](/docs/openapi/projects/get-projects-by-slug-shot): Returns a screenshot of what this project currently serves, as image/png.
- [List edge](/docs/openapi/projects/get-projects-edge): health reports whether a publish reaches readers, rather than whether it was accepted.
- [List sites](/docs/openapi/projects/get-projects-sites): Returns the org's deployed sites at the pretty URLs they serve at.
- [Get sites](/docs/openapi/projects/get-projects-sites-by-slug): Returns one site — the same row ListSites carries, for one slug. Every sub-resource under a site already answered: deployments, releases, publish.
- [List tags](/docs/openapi/projects/get-projects-tags): 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…
- [Update projects](/docs/openapi/projects/patch-projects-by-slug): Changes a project's settings, and only the settings you send.
- [Create projects](/docs/openapi/projects/post-projects): Creates a project — the handle a site is deployed and served under — and answers 201 with it in `draft`.
- [Deploy projects](/docs/openapi/projects/post-projects-by-slug-deploy): Takes a built site live at `https://<slug>.hanzo.app` in one call.
- [Create deployments](/docs/openapi/projects/post-projects-by-slug-deployments): Opens a deployment and hands back a short-lived, prefix-scoped grant to write its bytes straight to object storage. Answers 202.
- [Complete deployments](/docs/openapi/projects/post-projects-by-slug-deployments-by-id-complete): CompleteDeployment is 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](/docs/openapi/projects/post-projects-by-slug-domains): Attaches one or more CUSTOM public hostnames to this org's site.
- [Verify domains](/docs/openapi/projects/post-projects-by-slug-domains-by-host-verify): 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](/docs/openapi/projects/post-projects-by-slug-publish): 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](/docs/openapi/projects/post-projects-by-slug-purge): Flushes the site's edge cache without redeploying anything.
- [Create releases](/docs/openapi/projects/post-projects-by-slug-releases): 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…
- [Create activate](/docs/openapi/projects/post-projects-by-slug-releases-by-release-activate): Points the site at an existing release — the go-live, and equally the ROLLBACK.
- [Create fork](/docs/openapi/projects/post-projects-fork): 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…
- [Create sites](/docs/openapi/projects/post-projects-sites): Generates a self-contained, mobile-responsive static site from a natural-language brief and deploys it live in one call.
- [Deploy sites](/docs/openapi/projects/post-projects-sites-deploy): Deploys a caller-supplied file manifest — the deploy_site capability an agent calls — and answers with where it went live.
- [Replace star](/docs/openapi/projects/put-projects-by-slug-star): Bookmarks a project for the person calling, and answers whether it is starred afterwards.
- [Prompt](/docs/openapi/prompt): Your prompt library, versioned, so nothing changes silently.
- [Delete prompt](/docs/openapi/prompt/delete-prompt-by-name): Delete removes one of the caller org's prompts and every version of it, answering 204.
- [List prompt](/docs/openapi/prompt/get-prompt): List 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](/docs/openapi/prompt/get-prompt-by-name): Get returns one of the caller org's prompts: its CURRENT template text plus the metadata of every version it has had.
- [List catalog](/docs/openapi/prompt/get-prompt-catalog): Catalog returns the read-only starter prompt library shipped with the binary — reference content every tenant sees the same, NOT the caller's own prompts…
- [List metrics](/docs/openapi/prompt/get-prompt-metrics): Metrics 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…
- [Create prompt](/docs/openapi/prompt/post-prompt): Create records a prompt for the caller's org and answers 201 with it.
- [Provisioning](/docs/openapi/provisioning): One-click data add-ons: a SQL, key-value, document, vector, search or object store, wired straight into your app.
- [Delete datastore](/docs/openapi/provisioning/delete-provisioning-datastore-by-name): Deprovisions one Hanzo Datastore warehouse.
- [Delete docdb](/docs/openapi/provisioning/delete-provisioning-docdb-by-name): DropDocDB deprovisions one Hanzo DocDB database.
- [Delete kv](/docs/openapi/provisioning/delete-provisioning-kv-by-name): DropKV deprovisions one Hanzo KV store. It reverts any app instance bound to it back to Base BEFORE tearing down the org's dedicated Valkey instance, then…
- [Delete s3](/docs/openapi/provisioning/delete-provisioning-s3-by-name): Deletes one bucket from the shared object store and removes its metadata row.
- [Delete search](/docs/openapi/provisioning/delete-provisioning-search-by-name): Deletes one search index from the shared backend and removes its metadata row.
- [Delete sql](/docs/openapi/provisioning/delete-provisioning-sql-by-name): DropSQL deprovisions one Hanzo SQL database.
- [Delete vector](/docs/openapi/provisioning/delete-provisioning-vector-by-name): Deletes one vector collection from the shared backend and removes its metadata row.
- [List datastore](/docs/openapi/provisioning/get-provisioning-datastore): Lists the caller org's Hanzo Datastore warehouses.
- [Get datastore](/docs/openapi/provisioning/get-provisioning-datastore-by-name): Returns one Hanzo Datastore warehouse's metadata.
- [List docdb](/docs/openapi/provisioning/get-provisioning-docdb): ListDocDB lists the caller org's Hanzo DocDB document databases.
- [Get docdb](/docs/openapi/provisioning/get-provisioning-docdb-by-name): GetDocDB returns one Hanzo DocDB database's metadata.
- [List kv](/docs/openapi/provisioning/get-provisioning-kv): ListKV lists the caller org's Hanzo KV stores.
- [Get kv](/docs/openapi/provisioning/get-provisioning-kv-by-name): GetKV returns one Hanzo KV store's metadata.
- [List s3](/docs/openapi/provisioning/get-provisioning-s3): Lists the caller org's object-storage buckets. A bucket lives in an already-live shared object store and is reached through the public gateway.
- [Get s3](/docs/openapi/provisioning/get-provisioning-s3-by-name): Returns one bucket's metadata. It carries the bucket's status and the gateway address it is reached at, and no username: the object store authenticates…
- [Search provisioning](/docs/openapi/provisioning/get-provisioning-search): Lists the caller org's search indexes. An index is a logical resource inside an already-live shared backend, so every one of them is reached through the…
- [Get search](/docs/openapi/provisioning/get-provisioning-search-by-name): Returns one search index's metadata. It carries the index's status and the gateway address it is reached at, and no username: the backend authenticates…
- [List sql](/docs/openapi/provisioning/get-provisioning-sql): ListSQL lists the caller org's Hanzo SQL databases.
- [Get sql](/docs/openapi/provisioning/get-provisioning-sql-by-name): GetSQL returns one Hanzo SQL database's metadata.
- [List vector](/docs/openapi/provisioning/get-provisioning-vector): Lists the caller org's vector collections.
- [Get vector](/docs/openapi/provisioning/get-provisioning-vector-by-name): Returns one vector collection's metadata. It carries the collection's status and the gateway address it is reached at, and no username: the backend…
- [Create datastore](/docs/openapi/provisioning/post-provisioning-datastore): Launches your org's OWN Hanzo Datastore instance and answers with its `datastore://` connection string.
- [Create docdb](/docs/openapi/provisioning/post-provisioning-docdb): CreateDocDB launches your org's OWN document-database instance and answers with its `mongodb://` connection string.
- [Create kv](/docs/openapi/provisioning/post-provisioning-kv): CreateKV launches your org's OWN key-value instance and answers with its `kv://` connection string.
- [Create s3](/docs/openapi/provisioning/post-provisioning-s3): Creates an S3-compatible bucket inside the already-running shared object store and answers with the endpoint that reaches it.
- [Search provisioning](/docs/openapi/provisioning/post-provisioning-search): Creates a search index inside the already-running shared search backend and answers with the endpoint that reaches it.
- [Create sql](/docs/openapi/provisioning/post-provisioning-sql): CreateSQL launches your org's OWN PostgreSQL instance and answers with its `postgres://` connection string.
- [Create vector](/docs/openapi/provisioning/post-provisioning-vector): Creates a vector collection inside the already-running shared vector backend and answers with the endpoint that reaches it.
- [Pubsub](/docs/openapi/pubsub): Your message bus: publish, subscribe, and durable streams your apps read at their own pace.
- [Publish pubsub](/docs/openapi/pubsub/post-pubsub-publish): Publish puts one message on the org's bus.
- [Create request](/docs/openapi/pubsub/post-pubsub-request): Request 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…
- [Reference](/docs/openapi/reference): 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…
- [Delete reference](/docs/openapi/reference/riskclearreference): Removes one of your organisation's overrides.
- [Get reference](/docs/openapi/reference/riskreference): Reference describes one set and lists your org's overrides in it.
- [List reference](/docs/openapi/reference/riskreferencesets): Lists every set this plane publishes, with its version and how fresh it is.
- [Refresh reference](/docs/openapi/reference/riskrefreshreference): Takes a new version of one set. SuperAdmin only.
- [Resolve reference](/docs/openapi/reference/riskresolvereference): Looks keys up against the reference plane.
- [Replace reference](/docs/openapi/reference/risksetreference): Writes your organisation's own allow and deny entries over a set.
- [Referral](/docs/openapi/referral): Referral ATTRIBUTION: who referred whom, and whether that referee ever became a real customer.
- [List referral](/docs/openapi/referral/get-referral): Returns the caller's referral code, share link and the referrals they have made.
- [Claim referral](/docs/openapi/referral/post-referral-claim): Records that the caller's org signed up through a referral code.
- [Registry](/docs/openapi/registry): Your container and package registry: push images, pull them back, see what you store.
- [List images](/docs/openapi/registry/get-registry-images): Images 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…
- [List packages](/docs/openapi/registry/get-registry-packages): Packages 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](/docs/openapi/registry/get-registry-projects): Projects 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…
- [List status](/docs/openapi/registry/get-registry-status): Status reports whether the OCI and npm registries are reachable and, when the OCI half is auth-gated, which token realm its challenge advertises — an…
- [List tags](/docs/openapi/registry/get-registry-tags): Tags lists one org-owned repository's tags, read live from the OCI registry.
- [Create token](/docs/openapi/registry/post-registry-token): Token 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](/docs/openapi/risk): HANZO RISK's model plane: the per-organisation feature surface and the per-organisation models trained on it.
- [List health](/docs/openapi/risk/get-risk-health): Reports whether the per-organisation model plane is genuinely usable: that the plane was built, that the per-organisation stores can be written, and…
- [Replace model](/docs/openapi/risk/riskadoptmodel): 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…
- [List features](/docs/openapi/risk/riskfeatures): Features is the feature catalogue in its two honest lenses.
- [Create learn](/docs/openapi/risk/risklearn): Learn records a batch of events into the caller organisation's own aggregates and lets its model learn from them. It answers how many it learned from.
- [List policy](/docs/openapi/risk/riskpolicy): Policy reports the caller organisation's own decision-regime history: every distinct regime it has adopted, which version is in force, and what retention…
- [Create model](/docs/openapi/risk/riskpublishmodel): 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](/docs/openapi/risk/riskscore): Score judges one event against the caller organisation's OWN model and learns nothing from it.
- [Search risk](/docs/openapi/risk/risksearch): Search 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](/docs/openapi/risk/risksearchresult): Reads back one search run: every shape tried over this organisation's own history, best first, and the one that fit.
- [Replace policy](/docs/openapi/risk/risksetpolicy): 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…
- [List state](/docs/openapi/risk/riskstate): State 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…
- [S3](/docs/openapi/s3): Object storage: your buckets and the files in them, with signed URLs for upload and download.
- [Delete buckets](/docs/openapi/s3/delete-s3-buckets-by-bucket): Removes an EMPTY bucket and answers 204. A non-empty bucket is 409 rather than a cascade: deleting a tenant's objects behind a single bucket call is not a…
- [List buckets](/docs/openapi/s3/get-s3-buckets): Lists the caller org's own buckets. Only the caller's: every bucket is physically named under a per-org prefix and the listing strips that prefix, so a…
- [List objects](/docs/openapi/s3/get-s3-buckets-by-bucket-objects): Lists one folder level of a bucket. Folder-style by default: sub-prefixes come back as directory entries, which is the file-manager view.
- [List health](/docs/openapi/s3/get-s3-health): Health reports whether this deployment can serve object storage.
- [Create buckets](/docs/openapi/s3/post-s3-buckets): Makes a new bucket for the caller's org and answers 201 with it.
- [Create objects](/docs/openapi/s3/post-s3-buckets-by-bucket-objects): Mints a presigned PUT URL the caller uploads to DIRECTLY.
- [Sandbox](/docs/openapi/sandbox): 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](/docs/openapi/sandbox/delete-sandbox-by-id): Ends a sandbox and releases the compute behind it. Answers 204. ENDING IS NOT STOPPING.
- [Create end](/docs/openapi/sandbox/end-sandbox): Ends the caller's sandbox lease: the pod goes, and the volume goes only when the caller asked for that too.
- [List sandbox](/docs/openapi/sandbox/get-sandbox): Lists the caller org's sandboxes, newest first. `?project=` and `?status=` narrow it.
- [Get sandbox](/docs/openapi/sandbox/get-sandbox-by-id): Returns one sandbox: its class, project, image, the runtime it was given, its status and when its lease ends.
- [List fs](/docs/openapi/sandbox/get-sandbox-by-id-fs): Reads one file from the sandbox's project directory as text, or lists the entries when the path names a directory.
- [List screen](/docs/openapi/sandbox/get-sandbox-by-id-screen): A complete, self-contained desktop — noVNC inline, no other origin — that opens its own socket and draws this sandbox's display.
- [List ws](/docs/openapi/sandbox/get-sandbox-by-id-screen-ws): 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](/docs/openapi/sandbox/get-sandbox-by-id-terminal): A complete, self-contained terminal — xterm inline, no other origin — that opens its own socket and runs a shell in this sandbox.
- [List ws](/docs/openapi/sandbox/get-sandbox-by-id-terminal-ws): 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](/docs/openapi/sandbox/lease-sandbox): Leases the caller's sandbox, or returns the one it named if that lease is still running.
- [Create sandbox](/docs/openapi/sandbox/post-sandbox): Leases a sandbox — a real computer — for the caller's org. The class decides what it is for and therefore its image, working directory and isolation.
- [Create exec](/docs/openapi/sandbox/post-sandbox-by-id-exec): Runs one command in a sandbox the caller holds and answers with its exit code, stdout and stderr.
- [Create fs](/docs/openapi/sandbox/post-sandbox-by-id-fs): Writes the request body to one file in the sandbox's project directory, creating parent directories.
- [Create ticket](/docs/openapi/sandbox/post-sandbox-by-id-screen-ticket): Mints a short-lived grant to open the screen of a desktop sandbox.
- [Create ticket](/docs/openapi/sandbox/post-sandbox-by-id-terminal-ticket): Mints a short-lived grant to open a terminal on a sandbox.
- [Create read](/docs/openapi/sandbox/read-sandbox-file): Reads one path in the caller's sandbox: a file's bytes, or a directory's entries when the path names one.
- [Run sandbox](/docs/openapi/sandbox/run-in-sandbox): Runs one command inside the caller's sandbox and answers its exit code, stdout and stderr.
- [Stop sandbox](/docs/openapi/sandbox/stop-run): Interrupts whatever the caller's sandbox is running and answers how many commands it ended.
- [Create write](/docs/openapi/sandbox/write-sandbox-file): Writes bytes to one path in the caller's sandbox, creating parents, and answers the resolved path.
- [SBOM](/docs/openapi/sbom): What is inside a container image: every component, resolvable by digest or image ref.
- [List health](/docs/openapi/sbom/get-sbom-health): Health is a pure liveness probe: the service is up; datastore reflects whether the datastore store is connected.
- [Create sbom](/docs/openapi/sbom/post-sbom): Ingest persists a CycloneDX SBOM's components keyed by image digest.
- [Search](/docs/openapi/search): One ranked result set over everything your org has stored.
- [Create search](/docs/openapi/search/search): Is the typed op behind POST /v1/search. It does exactly two things the in-process entry point must not do: resolve the tenant from the validated…
- [Security](/docs/openapi/security): Secret scanning for your code: submit sources, get findings, masked never raw.
- [List findings](/docs/openapi/security/get-security-findings): Is the org's findings — rule, severity, path, line, masked preview and fingerprint — newest first, across scans or within one.
- [Get findings](/docs/openapi/security/get-security-findings-by-id): 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…
- [List health](/docs/openapi/security/get-security-health): Reports that the scanning subsystem is serving and how many secret-detection rules the engine holds.
- [List rules](/docs/openapi/security/get-security-rules): Is the secret-detection catalog the engine scans with.
- [List scans](/docs/openapi/security/get-security-scans): Is the org's scan history, newest first, each as the same summary the submission answered — files read, findings fired, tally by severity.
- [Get scans](/docs/openapi/security/get-security-scans-by-id): 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](/docs/openapi/security/post-security-scans): 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…
- [SEO](/docs/openapi/seo): 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](/docs/openapi/seo/seoaudit): Fetches one page and reports what it gets wrong.
- [Create backlinks](/docs/openapi/seo/seobacklink): Summarises who links to a target. It returns the authority score, how many links point at it and from how many distinct sites, how many of those are…
- [Create competitors](/docs/openapi/seo/seocompetitor): Names the domains that place for the same phrases.
- [Create ideas](/docs/openapi/seo/seoidea): Grows a seed phrase into the phrases nobody named yet.
- [Create keywords](/docs/openapi/seo/seokeyword): Measures phrases the caller already has. It answers, for each phrase named, how many people search it in a month, what an advertising click on it costs,…
- [Create rankings](/docs/openapi/seo/seorank): Reports every phrase a domain already places for.
- [List rates](/docs/openapi/seo/seorate): Publishes what every call on this surface costs.
- [Settings](/docs/openapi/settings): How an org configures each product it uses, secret fields included.
- [Get settings](/docs/openapi/settings/get-settings-by-product): 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,…
- [Replace settings](/docs/openapi/settings/put-settings-by-product): Writes the caller org's configuration for one product and answers the stored result, secrets masked.
- [Share](/docs/openapi/share): A public URL for a service on your own machine, and a list of what you have open.
- [List share](/docs/openapi/share/get-share): Returns the tunnel shares the caller's org currently has open, across every environment that org has enabled.
- [Enable share](/docs/openapi/share/post-share-enable): Enable provisions the caller org's tunnel account and returns the credential the `hanzo share` CLI needs to run a tunnel.
- [Skills](/docs/openapi/skills): Skills — reached at /.well-known/agent-skills/; not in the public REST contract.
- [Social](/docs/openapi/social): Posting to every social account you own, now or on a schedule.
- [Delete accounts](/docs/openapi/social/delete-social-accounts-by-id): Removes one connected account from the org and answers 204 with no body; an id that is not there is 404. It removes the account record only.
- [Delete posts](/docs/openapi/social/delete-social-posts-by-id): Removes one post from the org and answers 204 with no body; an id that is not there is 404. It deletes the record here only.
- [List accounts](/docs/openapi/social/get-social-accounts): Returns the org's connected accounts — each one's id, network, handle, status and timestamps, most-recently-updated first.
- [Get accounts](/docs/openapi/social/get-social-accounts-by-id): Returns one of the org's connected accounts by id — its network, handle, status and timestamps — or 404.
- [List posts](/docs/openapi/social/get-social-posts): Returns the org's posts — content, channel, status, scheduled time, media and timestamps — most-recently-updated first.
- [Get posts](/docs/openapi/social/get-social-posts-by-id): 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…
- [List providers](/docs/openapi/social/get-social-providers): Reports each supported network's publish-readiness: whether this deployment holds the OAuth application credentials for it and, when it does not, exactly…
- [List summary](/docs/openapi/social/get-social-summary): 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](/docs/openapi/social/post-social-accounts): 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](/docs/openapi/social/post-social-posts): Stores a post for the org and answers 201 with the stored row.
- [Publish posts](/docs/openapi/social/post-social-posts-by-id-publish): Publishes the post immediately to the connected accounts on its channel and answers with the updated row, carrying the account and external id it…
- [Replace accounts](/docs/openapi/social/put-social-accounts-by-id): Replaces the account's network, handle and status with what the body carries, and answers with the stored row.
- [Replace posts](/docs/openapi/social/put-social-posts-by-id): Replaces the post's content, channel, status, scheduled time and media with what the body carries, and answers with the stored row.
- [Standing](/docs/openapi/standing): Prices and tracks what it costs to KEEP a company, as distinct from what it cost to form one.
- [Create upkeep](/docs/openapi/standing/post-standing-upkeep): Reports what keeping this entity costs every year, itemised.
- [Sync](/docs/openapi/sync): Data sync: link two endpoints and keep them in step, on a webhook, on a schedule, or on demand.
- [Delete sync](/docs/openapi/sync/delete-sync-by-id): Delete removes one sync and tears down the outbound mirror it derived, answering 204.
- [List sync](/docs/openapi/sync/get-sync): List returns every sync link the caller's org has, each with its two endpoints, its direction and trigger policy, and the time it last reconciled.
- [Get sync](/docs/openapi/sync/get-sync-by-id): Get returns one sync by id. It is org-scoped: an id belonging to another tenant is the same 404 an unknown id gives, so a probe learns nothing about what…
- [Update sync](/docs/openapi/sync/patch-sync-by-id): Patch updates one sync's mutable policy — direction, trigger and actor — in place.
- [Create sync](/docs/openapi/sync/post-sync): Create declares a sync between two endpoints and returns it.
- [Run sync](/docs/openapi/sync/post-sync-by-id-run): Run reconciles one sync now — the manual re-sync, and the initial import for a link created without run=true.
- [Tasks](/docs/openapi/tasks): Hanzo Tasks: durable workflows that survive a crash, with every run visible and replayable.
- [Delete tasks](/docs/openapi/tasks/delete-tasks): Answers 307 with Location /v1/tasks/ — this address serves nothing itself.
- [List tasks](/docs/openapi/tasks/get-tasks): Answers 307 with Location /v1/tasks/ — this address serves nothing itself.
- [Update tasks](/docs/openapi/tasks/patch-tasks): Answers 307 with Location /v1/tasks/ — this address serves nothing itself.
- [Create tasks](/docs/openapi/tasks/post-tasks): Answers 307 with Location /v1/tasks/ — this address serves nothing itself.
- [Replace tasks](/docs/openapi/tasks/put-tasks): Answers 307 with Location /v1/tasks/ — this address serves nothing itself.
- [Taxonomy](/docs/openapi/taxonomy): 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](/docs/openapi/taxonomy/delete-taxonomy-categories-by-id): Removes one empty category. A category that still has taxa filed under it is refused with 409 and a count: deleting the label off a group must never…
- [Delete taxa](/docs/openapi/taxonomy/delete-taxonomy-taxa-by-id): Removes one product from the catalogue. An id no taxon holds is a 404.
- [List taxonomy](/docs/openapi/taxonomy/get-taxonomy): Read 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…
- [Replace categories](/docs/openapi/taxonomy/put-taxonomy-categories-by-id): Creates or replaces one category and returns it as stored.
- [Replace taxa](/docs/openapi/taxonomy/put-taxonomy-taxa-by-id): Creates or replaces one product and returns it as stored. The id in the URL is the one it is filed under whatever the body says.
- [Team](/docs/openapi/team): Your org's shared workspace: documents edited together, files, seats, and agents as teammates.
- [Delete cookie](/docs/openapi/team/delete-team-account-cookie): Signs this browser out of team by expiring the HttpOnly account-token cookie the OAuth callback set.
- [Delete files](/docs/openapi/team/delete-team-files-by-workspace-by-filename): Removes one blob from a workspace's file store.
- [Get auth](/docs/openapi/team/get-team-account-auth-by-provider): 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](/docs/openapi/team/get-team-account-auth-by-provider-callback): 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…
- [List providers](/docs/openapi/team/get-team-account-providers): Returns the identity providers this deployment starts a login with. It is always exactly one — hanzo.id.
- [List plan](/docs/openapi/team/get-team-billing-plan): 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](/docs/openapi/team/get-team-billing-ui): Serves the usage-and-wallet page the Team front links to — HTML, not JSON.
- [List bots](/docs/openapi/team/get-team-bots): Returns the caller org's bot members — the org's agents projected as the workspace Employees they become, each with the member account uuid and Person…
- [List collaborator](/docs/openapi/team/get-team-collaborator): 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…
- [Get files](/docs/openapi/team/get-team-files-by-workspace-by-filename): Streams one blob's raw BYTES back — this is the read side of the workspace file store, not a JSON envelope around it.
- [List rooms](/docs/openapi/team/get-team-rooms): Returns every room of the caller's org, across the workspaces it owns, with the work facet each carries.
- [List statistics](/docs/openapi/team/get-team-transactor-api-v1-statistics): Statistics returns the transactor's live sessions for the workspace the caller's credential names — the endpoint the front's workspace switcher and server…
- [Get transactor](/docs/openapi/team/get-team-transactor-by-token): Upgrades to the WebSocket the Team client runs an entire workspace over: every frame is a ZAP envelope wrapping one JSON-RPC message — findAll/findOne…
- [List statistics](/docs/openapi/team/get-team-transactor-statistics): Statistics returns the transactor's live sessions for the workspace the caller's credential names — the endpoint the front's workspace switcher and server…
- [Create account](/docs/openapi/team/post-team-account): The account control plane the Team client speaks: one POST carries a `method` verb and its `params`, and answers {"result": …}.
- [Sync bots](/docs/openapi/team/post-team-bots-sync): SyncBots re-projects the caller org's agents as workspace members into EVERY workspace of the org, and removes the ones whose agent is gone.
- [Create rpc](/docs/openapi/team/post-team-collaborator-rpc-by-documentid): CollabRPC is the collaborative-markup snapshot plane the Team front's editor speaks: createContent stores a document field's markup at a fresh, immutable…
- [Create files](/docs/openapi/team/post-team-files-by-workspace): Stores one file in a workspace'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…
- [Replace cookie](/docs/openapi/team/put-team-account-cookie): Writes the team session token into the HttpOnly `account-token` cookie — Secure, SameSite=Lax, whole-origin scope, thirty days — and answers {"result":…
- [Replace rooms](/docs/openapi/team/put-team-rooms-by-id): States what a room is for: its lifecycle intent, and what it is about. It answers the room as it now stands.
- [Tel](/docs/openapi/tel): The telecommunications surface: phone numbers, calls and messages, on whatever carrier the deployment is configured for.
- [Delete calls](/docs/openapi/tel/delete-tel-calls-by-id): Ends a call this org placed. The holding is read for THIS org before the carrier is asked, for the reason releaseNumber gives one surface up: an id…
- [Delete numbers](/docs/openapi/tel/delete-tel-numbers-by-id): Checks the holding is THIS org's before it reaches the carrier.
- [List calls](/docs/openapi/tel/get-tel-calls): Lists the calls this org has placed or received, newest first.
- [List messages](/docs/openapi/tel/get-tel-messages): Lists the messages this org has sent or received, newest first.
- [List numbers](/docs/openapi/tel/get-tel-numbers): Lists the phone numbers this org HOLDS — the ones it has bought and not released.
- [List available](/docs/openapi/tel/get-tel-numbers-available): Asks the carrier what is available to buy.
- [List summary](/docs/openapi/tel/get-tel-summary): Counts what this org holds on the telephony plane: its numbers, its calls and its messages.
- [Create calls](/docs/openapi/tel/post-tel-calls): Dials. An `agent` names a Hanzo assistant to answer it; the call is refused up front when no assistant plane is configured, because a call that connects…
- [Create messages](/docs/openapi/tel/post-tel-messages): Sends a message from one of this org's own numbers.
- [Create numbers](/docs/openapi/tel/post-tel-numbers): Provisions with the carrier FIRST and records second.
- [Template](/docs/openapi/template): A gallery of starter kits you can deploy as they come.
- [Delete template](/docs/openapi/template/delete-template-by-slug): Deletes the caller org's OWN starter kit.
- [List template](/docs/openapi/template/get-template): Lists the public starter-kit catalog plus, for a validated caller, that org's own private kits.
- [Get template](/docs/openapi/template/get-template-by-slug): Returns one starter kit: the caller org's own by that slug, else the public catalog's.
- [Create template](/docs/openapi/template/post-template): Creates a starter kit PRIVATE to the caller's org and answers 201 with the stored kit.
- [Replace template](/docs/openapi/template/put-template-by-slug): Overwrites the caller org's OWN starter kit at the path slug, answering the stored kit.
- [Todo](/docs/openapi/todo): Hanzo Todo: boards, the work items on them, and the filters that make a board.
- [Delete projects](/docs/openapi/todo/delete-todo-projects-by-key): Answers 405. A todo board IS a repository on this deployment's forge, so creating, renaming and deleting one is a FORGE operation carried out with FORGE…
- [List board](/docs/openapi/todo/get-todo-board): Returns a board's issues — work items with their column, priority, assignee, labels and schedule. WHICH board is a filter, not an address.
- [List issues](/docs/openapi/todo/get-todo-issues): Answers across every project in the org. The org comes from the validated principal and never from the request: a caller able to name the org could read…
- [List projects](/docs/openapi/todo/get-todo-projects): Returns the boards of your org — the places your work actually is. The key addresses the board's issues.
- [Get projects](/docs/openapi/todo/get-todo-projects-by-key): Returns one board of your org by its key — the repository name.
- [List issues](/docs/openapi/todo/get-todo-projects-by-key-issues): Returns a board's issues — work items with their column, priority, assignee, labels and schedule. WHICH board is a filter, not an address.
- [Get issues](/docs/openapi/todo/get-todo-projects-by-key-issues-by-num): Returns ONE work item in full — its description included.
- [Get rooms](/docs/openapi/todo/get-todo-rooms-by-room): Summarises one room's work. The room is opaque here and is deliberately not resolved: this package cannot say whether a room exists — apps/team owns that…
- [Update projects](/docs/openapi/todo/patch-todo-projects-by-key): Answers 405. A todo board IS a repository on this deployment's forge, so creating, renaming and deleting one is a FORGE operation carried out with FORGE…
- [Update issues](/docs/openapi/todo/patch-todo-projects-by-key-issues-by-num): Edits a work item — rename it, rewrite it, move it to another column, or re-prioritise it. Absent fields are left alone. MOVING A CARD IS A RELABEL.
- [Create projects](/docs/openapi/todo/post-todo-projects): Answers 405. A todo board IS a repository on this deployment's forge, so creating, renaming and deleting one is a FORGE operation carried out with FORGE…
- [Create issues](/docs/openapi/todo/post-todo-projects-by-key-issues): Opens a work item on the board — an issue on that repository on the deployment's forge, filed as YOU.
- [Claim issues](/docs/openapi/todo/post-todo-projects-by-key-issues-by-num-claim): Takes an issue: it becomes yours and it moves to in_progress. The holder is the CALLER, never an argument.
- [Tools](/docs/openapi/tools): Everything your org can call, in one list: connector actions, functions, agents, skills and your own MCP servers.
- [Delete servers](/docs/openapi/tools/delete-tools-mcp-servers-by-id): Deregisters one of the caller org's external MCP servers, so its tools leave the registry.
- [Delete authored](/docs/openapi/tools/delete-tools-plugins-authored-by-id): Removes one of the caller org's built plugins, so the runtime can no longer load it.
- [Delete skills](/docs/openapi/tools/delete-tools-skills-by-id): Removes one of the caller org's authored skills. Scoped to the caller's org, so an id belonging to another tenant is never reached.
- [List tools](/docs/openapi/tools/get-tools): Lists every tool the caller's org and project can reach, from every source, each flagged with whether it is activated.
- [List activation](/docs/openapi/tools/get-tools-activation): Reports which tools are switched on for the caller's org and project.
- [List catalog](/docs/openapi/tools/get-tools-catalog): Lists the MCP servers the public registries publish, as we hold them: our canonical copy of registry.modelcontextprotocol.io, plus what we decided about…
- [Get catalog](/docs/openapi/tools/get-tools-catalog-by-id): 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…
- [List servers](/docs/openapi/tools/get-tools-mcp-servers): Lists the external MCP servers the caller's org has registered.
- [List plugins](/docs/openapi/tools/get-tools-plugins): Reports what this deployment actually mounted: every subsystem the composition root declared and whether it is switched on.
- [List authored](/docs/openapi/tools/get-tools-plugins-authored): Lists the plugins the caller's org BUILT, newest first, each with the TypeScript as authored.
- [List skills](/docs/openapi/tools/get-tools-skills): 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](/docs/openapi/tools/get-tools-skills-authored): Lists the caller org's OWN skills with their SKILL.md bodies.
- [Update catalog](/docs/openapi/tools/patch-tools-catalog-by-id): Sets what WE say about one catalog entry — hidden, featured, official, logo — and answers with the stored listing.
- [Create call](/docs/openapi/tools/post-tools-call): Runs one of the caller's activated tools and answers with its output.
- [Sync catalog](/docs/openapi/tools/post-tools-catalog-sync): Pulls the public MCP registry into our canonical copy and reports what changed. SuperAdmin only; every other caller is refused.
- [Create servers](/docs/openapi/tools/post-tools-mcp-servers): 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](/docs/openapi/tools/post-tools-plugins-build): Builds and stores one plugin for the caller's org. The 201 carries the bundle's size, whether a model wrote the source, and the plugin as stored.
- [Create skills](/docs/openapi/tools/post-tools-skills): Adds or revises one of the caller org's own skills, and answers 201 with the stored record.
- [Replace activation](/docs/openapi/tools/put-tools-activation): Switches tools on and off for the caller's org and project, and answers with the resulting activated set.
- [Translate](/docs/openapi/translate): Text in, the same text out in the language you asked for.
- [List memory](/docs/openapi/translate/get-translate-memory): List 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](/docs/openapi/translate/post-translate): 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…
- [Replace memory](/docs/openapi/translate/put-translate-memory): Review records a human decision on one translation-memory entry, and returns the entry as stored.
- [Treasury](/docs/openapi/treasury): The reserve fund behind every payout: real capital, held and accounted for.
- [List treasury](/docs/openapi/treasury/get-treasury): Returns the reserve fund's health and the current revenue-share policy for any validated caller.
- [List accounts](/docs/openapi/treasury/get-treasury-accounts): Returns the ledger accounts the caller may see, with their balances.
- [Trust](/docs/openapi/trust): 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](/docs/openapi/trust/delete-trust-by-kind-by-id): Removes one record from a section of your organization's trust centre. A record that is not there is a 404, never a silent success.
- [List trust](/docs/openapi/trust/get-trust): Reads YOUR organization's whole trust centre, including the addresses of your own gated documents.
- [List controls](/docs/openapi/trust/get-trust-controls): Lists every control your organization publishes, with the counts.
- [Get controls](/docs/openapi/trust/get-trust-controls-by-id): Reads one control by id.
- [List coverage](/docs/openapi/trust/get-trust-coverage): 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…
- [Get coverage](/docs/openapi/trust/get-trust-coverage-by-framework): 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…
- [List documents](/docs/openapi/trust/get-trust-documents): Lists your organization's documents. Because this is your own centre, a gated artifact carries its address here; through the published endpoint it does…
- [List evidence](/docs/openapi/trust/get-trust-evidence): Reads the audit rows that stand behind one control, over a window.
- [List faq](/docs/openapi/trust/get-trust-faq): Lists your knowledge base — the questions a reviewer asks, answered once.
- [List frameworks](/docs/openapi/trust/get-trust-frameworks): Lists the frameworks coverage is computed against, and how many clauses each publishes.
- [List policies](/docs/openapi/trust/get-trust-policies): Lists your organization's published policies.
- [List profile](/docs/openapi/trust/get-trust-profile): 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…
- [Get published](/docs/openapi/trust/get-trust-published-by-org): Reads a published trust centre — the whole thing in one answer: the organization's profile, its control inventory, coverage computed against each…
- [List risk](/docs/openapi/trust/get-trust-risk): Reads your risk profile — the label and value pairs describing what your organization handles and how.
- [List subprocessors](/docs/openapi/trust/get-trust-subprocessors): Lists the third parties your organization sends data to, each naming what it is for.
- [List updates](/docs/openapi/trust/get-trust-updates): Lists your trust-centre updates, newest as you ordered them.
- [Replace trust](/docs/openapi/trust/put-trust-by-kind-by-id): Writes one record into a section of YOUR organization's trust centre — profile, control, document, subprocessor, policy, faq, update or risk.
- [Usage](/docs/openapi/usage): What your org ran and what it cost, broken down per account.
- [List analytics](/docs/openapi/usage/get-usage-analytics): Is 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…
- [List access](/docs/openapi/usage/get-usage-analytics-access): Echoes a plan's resolved analytics entitlement so a dashboard can configure itself against the LIVE catalog instead of hardcoding tier numbers.
- [List samples](/docs/openapi/usage/get-usage-samples): Is 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](/docs/openapi/usage/get-usage-summary): 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…
- [Create usage](/docs/openapi/usage/post-usage): 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 —…
- [Validator](/docs/openapi/validator): One-click validator onboarding: prove your Genesis NFT, get a node provisioned, queue its registration.
- [List validator](/docs/openapi/validator/get-validator): Returns the validator slots the caller's org has claimed.
- [Get validator](/docs/openapi/validator/get-validator-by-tokenid): Returns one claimed validator slot, scoped to the caller's org.
- [List challenge](/docs/openapi/validator/get-validator-challenge): Issues the single-use nonce and the exact message a wallet must sign to claim a validator slot.
- [Create validator](/docs/openapi/validator/post-validator): Claims a validator slot and provisions its node, after proving the caller's wallet owns the slot's NFT.
- [Visor](/docs/openapi/visor): The compute you rent from Hanzo: machines, GPUs and clusters — launch one, resize it, tear it down.
- [Create clusters](/docs/openapi/visor/attachcluster): 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…
- [Replace agent](/docs/openapi/visor/bindmachineagent): 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](/docs/openapi/visor/cancelfleetjob): Cancels a queued or running render in the caller's org.
- [Create clusters](/docs/openapi/visor/createkubernetescluster): Provisions a DOKS cluster for the caller's org and answers 201.
- [Create pools](/docs/openapi/visor/createnodepool): Adds a node pool to one of the caller org's clusters and answers 201 with the created pool.
- [Delete bots](/docs/openapi/visor/deletebot): Tears down both halves of a bot: it unbinds the agent (best-effort — a bot with no binding still deletes), then terminates the machine.
- [Delete clusters](/docs/openapi/visor/deletekubernetescluster): Destroys a DOKS cluster by id and answers 204. ADMIN-GATED, like create.
- [Delete machines](/docs/openapi/visor/deletemachine): Terminates one of the caller org's machines.
- [Delete pools](/docs/openapi/visor/deletenodepool): Removes a node pool from one of the caller org's clusters.
- [Delete clusters](/docs/openapi/visor/detachcluster): Removes a BYO cluster from the caller org's fleet.
- [List regions](/docs/openapi/visor/get-visor-compute-regions): Regions lists the regions a machine can be launched in. The catalog is GLOBAL — identical for every tenant — so no owner is forwarded upstream.
- [List sizes](/docs/openapi/visor/get-visor-compute-sizes): Sizes lists the machine sizes available to launch, with their specifications.
- [Get bots](/docs/openapi/visor/getbot): Returns one of the caller org's bot machines with its agent binding.
- [Get clusters](/docs/openapi/visor/getkubernetescluster): Returns one cluster's detail: node pools + worker nodes.
- [Get machines](/docs/openapi/visor/getmachine): Returns one of the caller org's machines by its org-scoped name.
- [List agent](/docs/openapi/visor/getmachineagent): Returns the agent binding of one of the caller org's machines, or 404 when the machine runs no bot runtime.
- [List bots](/docs/openapi/visor/listbots): Returns the caller org's bot machines — the kind=bot machines — each joined with the agent binding that says which cloud Agent it runs.
- [List clusters](/docs/openapi/visor/listclusters): 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…
- [List fleet](/docs/openapi/visor/listfleet): 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…
- [List jobs](/docs/openapi/visor/listfleetjobs): 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,…
- [List samples](/docs/openapi/visor/listfleetsamples): Returns the caller org's utilization series, oldest first.
- [List workers](/docs/openapi/visor/listfleetworkers): Returns the caller org's BYO machines — the ones that dialed in via `hanzo link` — with everything each host reported about itself.
- [List alerts](/docs/openapi/visor/listgpualerts): Is an HONEST empty surface: Visor exposes no GPU alert inventory, so this returns [] rather than fabricating alerts.
- [List gpus](/docs/openapi/visor/listgpus): 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…
- [List clusters](/docs/openapi/visor/listkubernetesclusters): 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](/docs/openapi/visor/listkubernetesnodes): 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…
- [List agents](/docs/openapi/visor/listmachineagents): 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](/docs/openapi/visor/listmachines): 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…
- [Create bots](/docs/openapi/visor/post-visor-compute-bots-by-id-by-action): Dispatches one verb against a bot the caller's org owns.
- [Launch bots](/docs/openapi/visor/post-visor-compute-bots-launch): Creates BOTH halves of a bot in one call and answers 201 with the bot: the cloud agent it runs, then a bot-kind machine bootstrapped with the bot runtime,…
- [Create machines](/docs/openapi/visor/post-visor-machines): Provisions a machine owned by the caller's org and answers 201 with the machine.
- [Create samples](/docs/openapi/visor/recordfleetsample): Records a BYO worker's live GPU utilization into the SAME series the fleet board overlays.
- [Create scale](/docs/openapi/visor/scalenodepool): Resizes a node pool to an absolute node count and returns the pool as Visor reports it after the change.
- [Delete agent](/docs/openapi/visor/unbindmachineagent): Detaches the agent runtime from one of the caller org's machines.
- [Wallet](/docs/openapi/wallet): Blockchain key custody: create wallets, rotate their keys, and sign with them.
- [List wallet](/docs/openapi/wallet/get-wallet): Returns the caller org's wallets, newest first, optionally NARROWED within the org by project, agent or account.
- [List accounts](/docs/openapi/wallet/get-wallet-accounts): Returns the caller org's wallet accounts, newest first.
- [Get wallet](/docs/openapi/wallet/get-wallet-by-id): Returns one of the caller org's wallets: its scope, custody kind, tier, chain and on-chain address.
- [Create wallet](/docs/openapi/wallet/post-wallet): 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](/docs/openapi/wallet/post-wallet-accounts): Opens a named wallet account for the caller's org.
- [Create keys](/docs/openapi/wallet/post-wallet-by-id-keys): Rolls one wallet's signing material through its own custody backend and answers the wallet with whatever address that produced.
- [Create sign](/docs/openapi/wallet/post-wallet-by-id-sign): 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](/docs/openapi/wallet/post-wallet-by-id-transactions): 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](/docs/openapi/web3): 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](/docs/openapi/web3/get-web3-chains): Reports the chains this deployment can reach.
- [Get chains](/docs/openapi/web3/get-web3-chains-by-chain): Reports one chain and whether its upstream is answering.
- [Get tokens](/docs/openapi/web3/get-web3-tokens-by-chain-by-address): Reads an address's native balance on a chain.
- [Create rpc](/docs/openapi/web3/post-web3-rpc-by-chain): Forwards a JSON-RPC call to the named chain and returns its answer unchanged.
- [Webhook](/docs/openapi/webhook): How your app hears about events: register an endpoint, pick the events, get each one delivered and signed.
- [Delete webhook](/docs/openapi/webhook/delete-webhook-by-id): Removes one of the caller org's webhook endpoints and answers 204 with no body.
- [List webhook](/docs/openapi/webhook/get-webhook): Returns every webhook endpoint the caller's org has registered, newest first, each with its 7-day delivery and failure counts.
- [Get webhook](/docs/openapi/webhook/get-webhook-by-id): Returns one of the caller org's webhook endpoints with its 7-day delivery and failure counts, signing secret redacted.
- [List deliveries](/docs/openapi/webhook/get-webhook-by-id-deliveries): 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](/docs/openapi/webhook/post-webhook): Registers a new webhook subscription for the caller's org and answers 201 with the endpoint INCLUDING its freshly minted signing secret.
- [Create secret](/docs/openapi/webhook/post-webhook-by-id-secret): 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](/docs/openapi/webhook/post-webhook-by-id-test): 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…
- [Replace webhook](/docs/openapi/webhook/put-webhook-by-id): 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…
- [Websearch](/docs/openapi/websearch): A web search and a page fetch your agents can call.
- [Search websearch](/docs/openapi/websearch/delete-websearch-search): Answers {query, number_of_results, results:[{url, title, content, engine}]} — the exact /search?format=json contract a SearXNG client decodes, so an agent…
- [Search websearch](/docs/openapi/websearch/get-websearch-search): Answers {query, number_of_results, results:[{url, title, content, engine}]} — the exact /search?format=json contract a SearXNG client decodes, so an agent…
- [Search websearch](/docs/openapi/websearch/patch-websearch-search): Answers {query, number_of_results, results:[{url, title, content, engine}]} — the exact /search?format=json contract a SearXNG client decodes, so an agent…
- [Create scrape](/docs/openapi/websearch/post-websearch-scrape): Takes {url} and answers {success, data:{markdown, metadata}} — the exact contract a firecrawl client decodes.
- [Search websearch](/docs/openapi/websearch/post-websearch-search): Answers {query, number_of_results, results:[{url, title, content, engine}]} — the exact /search?format=json contract a SearXNG client decodes, so an agent…
- [Search websearch](/docs/openapi/websearch/put-websearch-search): Answers {query, number_of_results, results:[{url, title, content, engine}]} — the exact /search?format=json contract a SearXNG client decodes, so an agent…
- [Create websearch](/docs/openapi/websearch/search-web): Searches the live web and answers with ranked results.
- [World](/docs/openapi/world): A live news feed filtered to what your project cares about.
- [List world](/docs/openapi/world/get-world): Answers GET /v1/world — the product's public endpoint, naming every wire this surface answers on.
- [List limits](/docs/openapi/world/get-world-limits): 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…
- [List news](/docs/openapi/world/get-world-news): 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…
- [List pipeline](/docs/openapi/world/get-world-pipeline): Returns the caller project's news pipeline: which feeds it reads and how the merged result is filtered.
- [List stream](/docs/openapi/world/get-world-stream): 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…
- [Replace pipeline](/docs/openapi/world/put-world-pipeline): Replaces the caller project's news pipeline and returns what was stored.
- [x402](/docs/openapi/x402): Pay-per-request over HTTP 402: quote a price, take the payment, serve the resource.
- [Get settlements](/docs/openapi/x402/get-x402-settlements-by-id): Settlement reads one x402 payment receipt by id.
- [Zen](/docs/openapi/zen): 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](/docs/cli): The `hanzo` command line — 2250 commands across 118 capabilities, generated from the CLI's own command table.
- [Account](/docs/cli/account): The `hanzo account` commands.
- [Ad](/docs/cli/ad): The `hanzo ad` commands.
- [Affiliate](/docs/cli/affiliate): The `hanzo affiliate` commands.
- [Agents](/docs/cli/agents): The `hanzo agents` commands.
- [AI](/docs/cli/ai): The `hanzo ai` commands.
- [Allowance](/docs/cli/allowance): The `hanzo allowance` commands.
- [Ask](/docs/cli/ask): The `hanzo ask` commands.
- [Audit](/docs/cli/audit): The `hanzo audit` commands.
- [Author](/docs/cli/author): The `hanzo author` commands.
- [Authz](/docs/cli/authz): The `hanzo authz` commands.
- [Auto](/docs/cli/auto): The `hanzo auto` commands.
- [Base](/docs/cli/base): The `hanzo base` commands.
- [Benchmark](/docs/cli/benchmark): The `hanzo benchmark` commands.
- [Billing](/docs/cli/billing): The `hanzo billing` commands.
- [Blueprint](/docs/cli/blueprint): The `hanzo blueprint` commands.
- [Books](/docs/cli/books): The `hanzo books` commands.
- [Bot](/docs/cli/bot): The `hanzo bot` commands.
- [Campaign](/docs/cli/campaign): The `hanzo campaign` commands.
- [Captable](/docs/cli/captable): The `hanzo captable` commands.
- [Catalog](/docs/cli/catalog): The `hanzo catalog` commands.
- [Channels](/docs/cli/channels): The `hanzo channels` commands.
- [Cloudflare](/docs/cli/cloudflare): The `hanzo cloudflare` commands.
- [Code](/docs/cli/code): The `hanzo code` commands.
- [Commerce](/docs/cli/commerce): The `hanzo commerce` commands.
- [Company](/docs/cli/company): The `hanzo company` commands.
- [Compliance](/docs/cli/compliance): The `hanzo compliance` commands.
- [Content](/docs/cli/content): The `hanzo content` commands.
- [Crawl](/docs/cli/crawl): The `hanzo crawl` commands.
- [CRM](/docs/cli/crm): The `hanzo crm` commands.
- [Dataroom](/docs/cli/dataroom): The `hanzo dataroom` commands.
- [Dataset](/docs/cli/dataset): The `hanzo dataset` commands.
- [Deploy](/docs/cli/deploy): The `hanzo deploy` commands.
- [Destination](/docs/cli/destination): The `hanzo destination` commands.
- [DNS](/docs/cli/dns): The `hanzo dns` commands.
- [Domain](/docs/cli/domain): The `hanzo domain` commands.
- [Engine](/docs/cli/engine): The `hanzo engine` commands.
- [Entitlement](/docs/cli/entitlement): The `hanzo entitlement` commands.
- [Esign](/docs/cli/esign): The `hanzo esign` commands.
- [Eval](/docs/cli/eval): The `hanzo eval` commands.
- [Event](/docs/cli/event): The `hanzo event` commands.
- [Exec](/docs/cli/exec): The `hanzo exec` commands.
- [Experiment](/docs/cli/experiment): The `hanzo experiment` commands.
- [Explorer](/docs/cli/explorer): The `hanzo explorer` commands.
- [Flags](/docs/cli/flags): The `hanzo flags` commands.
- [Flow](/docs/cli/flow): The `hanzo flow` commands.
- [Framework](/docs/cli/framework): The `hanzo framework` commands.
- [Functions](/docs/cli/functions): The `hanzo functions` commands.
- [Gateway](/docs/cli/gateway): The `hanzo gateway` commands.
- [Git](/docs/cli/git): The `hanzo git` commands.
- [Graph](/docs/cli/graph): The `hanzo graph` commands.
- [Guide](/docs/cli/guide): The `hanzo guide` commands.
- [Help](/docs/cli/help): The `hanzo help` commands.
- [IAM](/docs/cli/iam): The `hanzo iam` commands.
- [Index](/docs/cli/index): The `hanzo index` commands.
- [Ingress](/docs/cli/ingress): The `hanzo ingress` commands.
- [Integrations](/docs/cli/integrations): The `hanzo integrations` commands.
- [KMS](/docs/cli/kms): The `hanzo kms` commands.
- [Knowledge](/docs/cli/knowledge): The `hanzo knowledge` commands.
- [KV](/docs/cli/kv): The `hanzo kv` commands.
- [Label](/docs/cli/label): The `hanzo label` commands.
- [Leaderboard](/docs/cli/leaderboard): The `hanzo leaderboard` commands.
- [Legal](/docs/cli/legal): The `hanzo legal` commands.
- [Licensing](/docs/cli/licensing): The `hanzo licensing` commands.
- [Link](/docs/cli/link): The `hanzo link` commands.
- [LSP](/docs/cli/lsp): The `hanzo lsp` commands.
- [Marketing](/docs/cli/marketing): The `hanzo marketing` commands.
- [Marketplace](/docs/cli/marketplace): The `hanzo marketplace` commands.
- [Meet](/docs/cli/meet): The `hanzo meet` commands.
- [Metrics](/docs/cli/metrics): The `hanzo metrics` commands.
- [ML](/docs/cli/ml): The `hanzo ml` commands.
- [MQ](/docs/cli/mq): The `hanzo mq` commands.
- [Network](/docs/cli/network): The `hanzo network` commands.
- [Node](/docs/cli/node): The `hanzo node` commands.
- [Notify](/docs/cli/notify): The `hanzo notify` commands.
- [O11y](/docs/cli/o11y): The `hanzo o11y` commands.
- [OpenAPI](/docs/cli/openapi): The `hanzo openapi` commands.
- [Plan](/docs/cli/plan): The `hanzo plan` commands.
- [Platform](/docs/cli/platform): The `hanzo platform` commands.
- [Pref](/docs/cli/pref): The `hanzo pref` commands.
- [Pricing](/docs/cli/pricing): The `hanzo pricing` commands.
- [Projects](/docs/cli/projects): The `hanzo projects` commands.
- [Prompt](/docs/cli/prompt): The `hanzo prompt` commands.
- [Provisioning](/docs/cli/provisioning): The `hanzo provisioning` commands.
- [Pubsub](/docs/cli/pubsub): The `hanzo pubsub` commands.
- [Reference](/docs/cli/reference): The `hanzo reference` commands.
- [Referral](/docs/cli/referral): The `hanzo referral` commands.
- [Registry](/docs/cli/registry): The `hanzo registry` commands.
- [Risk](/docs/cli/risk): The `hanzo risk` commands.
- [S3](/docs/cli/s3): The `hanzo s3` commands.
- [Sandbox](/docs/cli/sandbox): The `hanzo sandbox` commands.
- [SBOM](/docs/cli/sbom): The `hanzo sbom` commands.
- [Search](/docs/cli/search): The `hanzo search` commands.
- [Security](/docs/cli/security): The `hanzo security` commands.
- [SEO](/docs/cli/seo): The `hanzo seo` commands.
- [Settings](/docs/cli/settings): The `hanzo settings` commands.
- [Share](/docs/cli/share): The `hanzo share` commands.
- [Social](/docs/cli/social): The `hanzo social` commands.
- [Standing](/docs/cli/standing): The `hanzo standing` commands.
- [Sync](/docs/cli/sync): The `hanzo sync` commands.
- [Tasks](/docs/cli/tasks): The `hanzo tasks` commands.
- [Taxonomy](/docs/cli/taxonomy): The `hanzo taxonomy` commands.
- [Team](/docs/cli/team): The `hanzo team` commands.
- [Tel](/docs/cli/tel): The `hanzo tel` commands.
- [Template](/docs/cli/template): The `hanzo template` commands.
- [Todo](/docs/cli/todo): The `hanzo todo` commands.
- [Tools](/docs/cli/tools): The `hanzo tools` commands.
- [Translate](/docs/cli/translate): The `hanzo translate` commands.
- [Treasury](/docs/cli/treasury): The `hanzo treasury` commands.
- [Trust](/docs/cli/trust): The `hanzo trust` commands.
- [Usage](/docs/cli/usage): The `hanzo usage` commands.
- [Validator](/docs/cli/validator): The `hanzo validator` commands.
- [Visor](/docs/cli/visor): The `hanzo visor` commands.
- [Wallet](/docs/cli/wallet): The `hanzo wallet` commands.
- [Web3](/docs/cli/web3): The `hanzo web3` commands.
- [Webhook](/docs/cli/webhook): The `hanzo webhook` commands.
- [Websearch](/docs/cli/websearch): The `hanzo websearch` commands.
- [World](/docs/cli/world): The `hanzo world` commands.
- [x402](/docs/cli/x402): The `hanzo x402` commands.

## MCP — one page per tool MCP exposes

- [Cloud MCP](/docs/mcp-tools): One JSON-RPC endpoint that gives any MCP client 121 tools over the Hanzo cloud, plus the external servers your org registers.
- [Affiliate](/docs/mcp-tools/affiliate): affiliates: 17 operations.
- [Agents](/docs/mcp-tools/agents): agents: 36 operations.
- [AI](/docs/mcp-tools/ai): ai: 294 operations.
- [Tool catalogue](/docs/mcp-tools/all-tools): Every one of the 121 tools documented here, grouped by the product it calls.
- [Allowance](/docs/mcp-tools/allowance): allowance: 1 operations.
- [Ask](/docs/mcp-tools/ask): ask: 2 operations.
- [Audit](/docs/mcp-tools/audit): audit: 1 operations.
- [Author](/docs/mcp-tools/author): authors: 11 operations.
- [Authz](/docs/mcp-tools/authz): authz: 2 operations.
- [Base](/docs/mcp-tools/base): base: 1 operations.
- [Benchmark](/docs/mcp-tools/benchmark): benchmark: 6 operations.
- [Billing](/docs/mcp-tools/billing): billing: 9 operations.
- [Blueprint](/docs/mcp-tools/blueprint): blueprint: 3 operations.
- [Campaign](/docs/mcp-tools/campaign): campaign: 11 operations.
- [Captable](/docs/mcp-tools/captable): captable: 31 operations.
- [Catalog](/docs/mcp-tools/catalog): catalog: 1 operations.
- [Code](/docs/mcp-tools/code): code: 7 operations.
- [Commerce](/docs/mcp-tools/commerce): commerce: 215 operations.
- [Company](/docs/mcp-tools/company): company: 22 operations.
- [Compliance](/docs/mcp-tools/compliance): compliance: 17 operations.
- [Content](/docs/mcp-tools/content): content: 6 operations.
- [Crawl](/docs/mcp-tools/crawl): crawl: 1 operations.
- [CRM](/docs/mcp-tools/crm): crm: 20 operations.
- [Dataroom](/docs/mcp-tools/dataroom): dataroom: 17 operations.
- [Dataset](/docs/mcp-tools/dataset): dataset: 7 operations.
- [Deploy](/docs/mcp-tools/deploy): deploy: 21 operations.
- [Destination](/docs/mcp-tools/destination): destinations: 5 operations.
- [Domain](/docs/mcp-tools/domain): domain: 7 operations.
- [Engine](/docs/mcp-tools/engine): engine: 4 operations.
- [Esign](/docs/mcp-tools/esign): esign: 9 operations.
- [Experiment](/docs/mcp-tools/experiment): experiments: 7 operations.
- [Flow](/docs/mcp-tools/flow): flow: 8 operations.
- [Framework](/docs/mcp-tools/framework): framework: 17 operations.
- [Gateway](/docs/mcp-tools/gateway): gateway: 3 operations.
- [Git](/docs/mcp-tools/git): git: 56 operations.
- [Guide](/docs/mcp-tools/guide): guide: 19 operations.
- [IAM](/docs/mcp-tools/iam): iam: 75 operations.
- [Index](/docs/mcp-tools/indexes): index: 17 operations.
- [Ingress](/docs/mcp-tools/ingress): ingress: 18 operations.
- [KMS](/docs/mcp-tools/kms): kms: 2 operations.
- [Label](/docs/mcp-tools/label): label: 7 operations.
- [Legal](/docs/mcp-tools/legal): legal: 11 operations.
- [Licensing](/docs/mcp-tools/licensing): licensing: 11 operations.
- [Link](/docs/mcp-tools/link): link: 11 operations.
- [Marketing](/docs/mcp-tools/marketing): marketing: 35 operations.
- [Marketplace](/docs/mcp-tools/marketplace): marketplace: 6 operations.
- [Meet](/docs/mcp-tools/meet): meet: 13 operations.
- [ML](/docs/mcp-tools/ml): ml: 7 operations.
- [MQ](/docs/mcp-tools/mq): mq: 15 operations.
- [Network](/docs/mcp-tools/network): zt: 4 operations.
- [Notify](/docs/mcp-tools/notify): notify: 4 operations.
- [O11y](/docs/mcp-tools/o11y): o11y: 340 operations.
- [Plan](/docs/mcp-tools/plan): plan: 15 operations.
- [Platform](/docs/mcp-tools/platform): platform: 39 operations.
- [Pricing](/docs/mcp-tools/pricing): pricing: 33 operations.
- [Prompt](/docs/mcp-tools/prompt): prompts: 6 operations.
- [Reference](/docs/mcp-tools/reference): reference: 6 operations.
- [Registry](/docs/mcp-tools/registry): registry: 5 operations.
- [Risk](/docs/mcp-tools/risk): risk: 10 operations.
- [S3](/docs/mcp-tools/s3): storage: 8 operations.
- [Sandbox](/docs/mcp-tools/sandbox): sandboxes: 19 operations.
- [SBOM](/docs/mcp-tools/sbom): sbom: 3 operations.
- [Security](/docs/mcp-tools/security): security: 7 operations.
- [Share](/docs/mcp-tools/share): share: 2 operations.
- [Social](/docs/mcp-tools/social): social: 13 operations.
- [Sync](/docs/mcp-tools/sync): sync: 6 operations.
- [Tasks](/docs/mcp-tools/tasks): tasks: 20 operations.
- [Taxonomy](/docs/mcp-tools/taxonomy): taxonomy: 5 operations.
- [Team](/docs/mcp-tools/team): team: 18 operations.
- [Tel](/docs/mcp-tools/tel): tel: 10 operations.
- [Template](/docs/mcp-tools/template): templates: 5 operations.
- [Todo](/docs/mcp-tools/todo): todo: 12 operations.
- [Tools](/docs/mcp-tools/tools): tools: 19 operations.
- [Translate](/docs/mcp-tools/translate): translate: 3 operations.
- [Unmapped](/docs/mcp-tools/unmapped): 41 MCP tools MCP exposes that the OpenAPI document does not describe.
- [account](/docs/mcp-tools/unmapped/account): account: 8 operations.
- [admin](/docs/mcp-tools/unmapped/admin): admin: 56 operations.
- [admission](/docs/mcp-tools/unmapped/admission): admission: 1 operations.
- [ads](/docs/mcp-tools/unmapped/ads): ads: 7 operations.
- [analytics](/docs/mcp-tools/unmapped/analytics): analytics: 12 operations.
- [auto](/docs/mcp-tools/unmapped/auto): auto: 11 operations.
- [automations](/docs/mcp-tools/unmapped/automations): automations: 18 operations.
- [books](/docs/mcp-tools/unmapped/books): books: 24 operations.
- [bot](/docs/mcp-tools/unmapped/bot): bot: 4 operations.
- [bots](/docs/mcp-tools/unmapped/bots): bots: 8 operations.
- [channels](/docs/mcp-tools/unmapped/channels): channels: 7 operations.
- [cloudflare](/docs/mcp-tools/unmapped/cloudflare): cloudflare: 33 operations.
- [describe](/docs/mcp-tools/unmapped/describe): The description and input schema of ONE operation, named as it appears in a subsystem tool's "op" enum.
- [dns](/docs/mcp-tools/unmapped/dns): dns: 5 operations.
- [do](/docs/mcp-tools/unmapped/do): do: 8 operations.
- [entitlements](/docs/mcp-tools/unmapped/entitlements): entitlements: 3 operations.
- [evals](/docs/mcp-tools/unmapped/evals): evals: 16 operations.
- [exec](/docs/mcp-tools/unmapped/exec): exec: 5 operations.
- [explorer](/docs/mcp-tools/unmapped/explorer): explorer: 2 operations.
- [flags](/docs/mcp-tools/unmapped/flags): flags: 8 operations.
- [functions](/docs/mcp-tools/unmapped/functions): functions: 10 operations.
- [help](/docs/mcp-tools/unmapped/help): help: 4 operations.
- [integrations](/docs/mcp-tools/unmapped/integrations): integrations: 45 operations.
- [knowledge](/docs/mcp-tools/unmapped/knowledge): knowledge: 9 operations.
- [leaderboard](/docs/mcp-tools/unmapped/leaderboard): leaderboard: 6 operations.
- [lsp](/docs/mcp-tools/unmapped/lsp): lsp: 5 operations.
- [metrics](/docs/mcp-tools/unmapped/metrics): metrics: 11 operations.
- [plugins](/docs/mcp-tools/unmapped/plugins): plugins: 4 operations.
- [prefs](/docs/mcp-tools/unmapped/prefs): prefs: 2 operations.
- [product](/docs/mcp-tools/unmapped/product): product: 4 operations.
- [projects](/docs/mcp-tools/unmapped/projects): projects: 48 operations.
- [provisioning](/docs/mcp-tools/unmapped/provisioning): provisioning: 28 operations.
- [pubsub](/docs/mcp-tools/unmapped/pubsub): pubsub: 18 operations.
- [referrals](/docs/mcp-tools/unmapped/referrals): referrals: 4 operations.
- [research](/docs/mcp-tools/unmapped/research): research: 8 operations.
- [settings](/docs/mcp-tools/unmapped/settings): settings: 2 operations.
- [skills](/docs/mcp-tools/unmapped/skills): skills: 2 operations.
- [treasury](/docs/mcp-tools/unmapped/treasury): treasury: 7 operations.
- [venue](/docs/mcp-tools/unmapped/venue): venue: 5 operations.
- [web3](/docs/mcp-tools/unmapped/web3): web3: 3 operations.
- [x402](/docs/mcp-tools/unmapped/x402): x402: 1 operations.
- [Usage](/docs/mcp-tools/usage): usage: 5 operations.
- [Validator](/docs/mcp-tools/validator): validators: 4 operations.
- [Visor](/docs/mcp-tools/visor): visor: 34 operations.
- [Wallet](/docs/mcp-tools/wallet): wallets: 7 operations.
- [Webhook](/docs/mcp-tools/webhook): webhooks: 7 operations.
- [Websearch](/docs/mcp-tools/websearch): websearch: 7 operations.
- [World](/docs/mcp-tools/world): world: 6 operations.

## Open source — docs ported from the repositories themselves

- [Projects](/docs/projects): Aggregated documentation across Hanzo organizations.
- [hanzoai](/docs/projects/hanzoai): Projects in the hanzoai organization.
- [Index](/docs/projects/hanzoai/authz)
- [Base](/docs/projects/hanzoai/base): Hanzo Base — multi-tenant SQLite backend with polyglot in-process extension runtimes and age-encrypted WAL replication; the storage substrate of the Hanzo cloud.
- [Index](/docs/projects/hanzoai/ci)
- [Core Networkmanagement](/docs/projects/hanzoai/core-networkmanagement): Networkmanager built with coreDNS and coreDHCP with web gui
- [Index](/docs/projects/hanzoai/datastore)
- [Formats for Input and Output Data](/docs/projects/hanzoai/datastore/en/sql-reference/formats): Supported input and output formats
- [Deepspec](/docs/projects/hanzoai/deepspec): DeepSpec (DSpark/DFlash/Eagle3 draft training) + Hanzo V4 pipeline — fork of deepseek-ai/DeepSpec
- [Esign](/docs/projects/hanzoai/esign): Hanzo eSign — open-source electronic document signing.
- [Expr](/docs/projects/hanzoai/expr): Expression language and expression evaluation for Go
- [Forum](/docs/projects/hanzoai/forum): Tracking fork of Discourse, kept for a future Hanzo community forum. Nothing Hanzo-specific built on it yet.
- [Index](/docs/projects/hanzoai/gateway)
- [Go Fuse](/docs/projects/hanzoai/go-fuse): FUSE bindings for Go
- [Index](/docs/projects/hanzoai/goa)
- [Index](/docs/projects/hanzoai/goexif)
- [Govaluate](/docs/projects/hanzoai/govaluate): MIT expression evaluation for Go (fork of Knetic/govaluate)
- [Helpdesk](/docs/projects/hanzoai/helpdesk): Hanzo Help Center — Frappe Helpdesk fork (Base/SQLite, IAM SSO). Second Frappe app proving one-Frappe-core → all-Frappe-apps.
- [Index](/docs/projects/hanzoai/helper)
- [Iam](/docs/projects/hanzoai/iam): Hanzo IAM v2 — proprietary identity service on zap-proto/zip + hanzoai/orm + hanzoai/base. Clean-room, original work.
- [Authentication](/docs/projects/hanzoai/iam/sdk/authentication): JWT validation, OIDC discovery, and OAuth2 PKCE flows with @hanzo/iam.
- [Billing](/docs/projects/hanzoai/iam/sdk/billing): Subscription management, plans, pricing, and payment APIs with the IAM billing client.
- [React Bindings](/docs/projects/hanzoai/iam/sdk/react): Drop-in React provider and hooks for Hanzo IAM — authentication, org switching, and token management.
- [IAM SDK](/docs/projects/hanzoai/iam/sdk/README): TypeScript SDK for Hanzo IAM — OIDC auth, JWT validation, OAuth2 PKCE, org/billing APIs, and React bindings.
- [Ingress](/docs/projects/hanzoai/ingress): Hanzo Ingress -- cloud-native, Kubernetes-native L7 reverse proxy and load balancer for Hanzo AI infrastructure (automatic TLS, dynamic config, zero-downtime reloads).
- [Insights](/docs/projects/hanzoai/insights): Hanzo Insights — product analytics and feature flags.
- [SDK feature support](/docs/projects/hanzoai/insights/published/docs/surveys/sdk-feature-support)
- [Kv](/docs/projects/hanzoai/kv): Ultra-fast key-value store with Redis API compatibility
- [Migrate](/docs/projects/hanzoai/migrate): Database migrations. CLI and Golang library.
- [Ml](/docs/projects/hanzoai/ml): 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](/docs/projects/hanzoai/o11y): Hanzo o11y — OpenTelemetry-native observability (metrics, traces, logs) for the Hanzo platform, backed by Hanzo Datastore.
- [Index](/docs/projects/hanzoai/o11y-foundry)
- [Orm](/docs/projects/hanzoai/orm): 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)
- [Index](/docs/projects/hanzoai/otel-collector)
- [Index](/docs/projects/hanzoai/paas-demo)
- [ROCm](/docs/projects/hanzoai/ROCm): Hanzo downstream of AMD ROCm (MIT), manifest pinned to rocm-7.2.0 for gfx builds
- [Index](/docs/projects/hanzoai/rocm-rs)
- [S3](/docs/projects/hanzoai/s3): Hanzo S3 — S3-compatible distributed object storage
- [Social](/docs/projects/hanzoai/social): 📨 Hanzo Social — agentic social media scheduling 🤖
- [Index](/docs/projects/hanzoai/sql)
- [Sqlite3](/docs/projects/hanzoai/sqlite3): Go bindings to SQLite using wasm2go
- [Vfs](/docs/projects/hanzoai/vfs): S3-backed virtual block filesystem with PQ encryption — unlimited write storage for stateful services
- [Zen Dub](/docs/projects/hanzoai/zen-dub): Zen Dub - Real-time high-quality lip-sync model

## SDKs — one page per language

- [SDKs](/docs/sdks): Official Hanzo SDKs for every language — Python, TypeScript, Go, Rust, C++, Swift, Kotlin. Two lines per language — the full Cloud SDK and the AI/Agents library.
- [AST (AI Structured Training)](/docs/sdks/ast): Structured AI training data collection SDK for capturing interactions, feedback, and model outputs.
- [C++ SDK](/docs/sdks/cpp): The Hanzo C++ Cloud SDK — native client via CMake. Coming soon.
- [Go SDK](/docs/sdks/go): The Hanzo Go Cloud SDK — go get github.com/hanzoai/go-sdk. Functional options, minimal dependencies.
- [IAM SDK](/docs/sdks/iam): TypeScript SDK for Hanzo IAM — authentication, organizations, billing, and React bindings.
- [Kotlin SDK](/docs/sdks/kotlin): The Hanzo Kotlin Cloud SDK — native JVM/Android client via Gradle. Coming soon.
- [Python SDK](/docs/sdks/python): The flagship Hanzo Python SDK — pip install hanzo for AI + agents, pip install hanzoai for the full Cloud SDK.
- [Rust SDK](/docs/sdks/rust): The Hanzo Rust Cloud SDK — async Tokio client. Coming soon on crates.io; usable today as a git dependency.
- [Swift SDK](/docs/sdks/swift): The Hanzo Swift Cloud SDK — native iOS/macOS client via Swift Package Manager. Coming soon.
- [TypeScript SDK](/docs/sdks/typescript): The Hanzo TypeScript SDK — @hanzo/ai for the AI/agents library and @hanzo/sdk for the full Cloud SDK. Node, Deno, Bun, browser.

## Architecture

- [Architecture](/docs/architecture): How Hanzo Cloud is built today, and the plugin-platform direction it is evolving toward.
- [The Platform Algebra](/docs/architecture/algebra): 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](/docs/architecture/philosophy): 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](/docs/architecture/plugin-platform): 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](/docs/contributing/authoring-cli): The CLI tool that automates setups and installs components.
- [Docs Architecture (ADR)](/docs/contributing/docs-architecture): 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](/docs/contributing/preview): A light tool to view Markdown files.
- [Style](/docs/contributing/style): 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.

## Docs

- [Documentation](/docs): Build Anything with Hanzo. Every model, every tool, one key — in our cloud or on your own machine.

## Authentication

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

## Extensions

- [Integrations & Extensions](/docs/apps): Install and connect Hanzo across your browser, editor, desktop, docs, design tools, and business apps — one API key, one identity, everywhere.
- [Browser](/docs/apps/browser): Hanzo in Chrome, Edge, Firefox, and Safari — AI chat, page context, and one-click actions on any tab.
- [Business](/docs/apps/business): Connect Hanzo to Salesforce, DocuSign, Notion, HubSpot, and Shopify — summarize records, draft content, and act on your business data over OAuth.
- [Comms](/docs/apps/comms): 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](/docs/apps/design): Hanzo in Figma and Sketch — generate, rename, and annotate layers and copy from your AI assistant.
- [Desktop](/docs/apps/desktop): 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 the Claude Desktop connector.
- [Dev](/docs/apps/dev): The Hanzo GitHub App and GitLab integration — automated PR/MR review, issue triage, and @hanzo mentions in your repos.
- [IDEs & Editors](/docs/apps/ides): Hanzo in VS Code, Cursor, Windsurf, Antigravity, JetBrains, and JupyterLab — an inline AI coding assistant and agent.
- [Docs & Office](/docs/apps/office): Hanzo in Word, Excel, PowerPoint, Outlook, Google Workspace, and PDF — draft, summarize, and edit documents in place.
- [Productivity](/docs/apps/productivity): Hanzo in Clio and Raycast — AI in your legal practice management and one keystroke away from your command bar.
- [Verticals](/docs/apps/verticals): Industry integrations — Epic (healthcare), Procore (construction), and QuickBooks (finance) — connected over their native app models with data kept server-side.

## Hanzo Chat

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

## Coding agents

- [Coding agents](/docs/coding): Run a coding agent in your repo — ours, Claude Code or Codex — from one command.

## Core ideas

- [Concepts](/docs/concepts): Six ideas the whole API is built out of — tenancy, projects, sandboxes, agents, memory and workflows.
- [Agents](/docs/concepts/agents): 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.
- [Memory](/docs/concepts/memory): 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](/docs/concepts/multitenancy): 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](/docs/concepts/projects): 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](/docs/concepts/sandboxes): 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](/docs/concepts/workflows): 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](/docs/console): The unified cloud console for Hanzo Cloud -- manage every product, key, and organization from one app at console.hanzo.ai.

## Credits & billing

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

## Hanzo Dev

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

## Meet Enso

- [Meet Enso](/docs/enso): Hanzo's own model family — enso, enso-flash, and enso-ultra. What each one is for, and how to pick.

## Environments

- [Environments](/docs/environments): 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](/docs/errors): Every error code Hanzo Index can return, with its HTTP status and type. The `link` in an error body points here.

## Events

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

## Build a game

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

## Glossary

- [Glossary](/docs/glossary): 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](/docs/guides): One task per page, each written four ways: a CLI command, an SDK call, an HTTP request and an MCP tool.
- [Agent](/docs/guides/agent): Create an agent, run it, read the run back.
- [Chat](/docs/guides/chat): One completion.
- [Hello](/docs/guides/hello): Identity — prove the key works and print who it belongs to.
- [Integrations](/docs/guides/integrations): Point any agent framework at Hanzo. One host, one key, two lines — and the exact parameter name for each of sixteen frameworks.
- [Agno](/docs/guides/integrations/agno): OpenAILike takes base_url. A sibling class reaches the responses shape on the same parameter.
- [AutoGen](/docs/guides/integrations/autogen): OpenAIChatCompletionClient takes base_url, and model_info alongside it whenever the model name is not one OpenAI serves.
- [Claude Agent SDK](/docs/guides/integrations/claude-agent-sdk): The one framework on the Anthropic shape, and the one that wants the bare host — ANTHROPIC_BASE_URL takes no /v1.
- [Cloudflare Agents](/docs/guides/integrations/cloudflare-agents): No base-URL parameter of its own — instantiate the openai client inside the Agent and set baseURL on it.
- [CrewAI](/docs/guides/integrations/crewai): LLM takes base_url. custom_openai=True is what lets you name a model id CrewAI does not recognise.
- [DSPy](/docs/guides/integrations/dspy): dspy.LM takes api_base through kwargs, forwarded to LiteLLM. Name the model in provider/name form.
- [Google ADK](/docs/guides/integrations/google-adk): ADK reaches an OpenAI-compatible endpoint through LiteLlm, whose parameter is api_base — not base_url.
- [LangGraph](/docs/guides/integrations/langgraph): The base URL goes on the model, not the agent. ChatOpenAI takes base_url; hand the instance to create_agent.
- [Letta](/docs/guides/integrations/letta): A configuration flow, not a constructor. Add an OpenAI-compatible provider through /connect, then pick the model.
- [LlamaIndex](/docs/guides/integrations/llamaindex): OpenAILike takes api_base — not base_url — and needs is_chat_model set, because it defaults to the completions endpoint.
- [Mastra](/docs/guides/integrations/mastra): No provider factory. The base URL is the url field of the agent's model object, beside a routing id.
- [OpenAI Agents SDK](/docs/guides/integrations/openai-agents): base_url goes on an AsyncOpenAI client. The SDK defaults to Responses, so choose the endpoint deliberately.
- [Pydantic AI](/docs/guides/integrations/pydantic-ai): OpenAIProvider takes base_url. Which model class you pick decides whether you land on chat completions or responses.
- [Semantic Kernel](/docs/guides/integrations/semantic-kernel): .NET takes endpoint as a Uri behind an experimental pragma. Python has no such parameter — hand it an AsyncOpenAI client.
- [smolagents](/docs/guides/integrations/smolagents): OpenAIModel takes api_base. The class is OpenAIModel — OpenAIServerModel is gone from the reference.
- [Vercel AI SDK](/docs/guides/integrations/vercel-ai-sdk): createOpenAICompatible takes baseURL. Two other providers on the same parameter reach the responses and messages shapes.
- [Migrate](/docs/guides/migrate): 40 vendors, each mapped to the Hanzo capability that answers it — how to start, nouns, the call before and after, and what does not carry.
- [AgentMail](/docs/guides/migrate/agentmail): AgentMail gives an agent its own mailbox. Here /v1/notify sends and /v1/channels carries the conversation — but there is no mailbox, so read the last section first.
- [Algolia](/docs/guides/migrate/algolia): 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.
- [Auth0](/docs/guides/migrate/auth0): 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](/docs/guides/migrate/carta): 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](/docs/guides/migrate/centaur): Centaur gives a Slack thread a Kubernetes pod, a coding harness and a credential proxy. Here that is /v1/channels, /v1/agents, /v1/sandbox and /v1/integrations on one origin — with a kernel boundary Centaur leaves off by default.
- [Clerk](/docs/guides/migrate/clerk): 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.
- [Composio](/docs/guides/migrate/composio): Composio gives an agent authenticated tools across third-party apps. Here that is /v1/integrations for the org's credential, /v1/integrations/connectors for a user's own, and /v1/tools for the actions they reach.
- [Datadog](/docs/guides/migrate/datadog): 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](/docs/guides/migrate/docusign): 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](/docs/guides/migrate/doppler): 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](/docs/guides/migrate/e2b): E2B leases isolated sandboxes for code an agent wrote. Here that is /v1/sandbox, with /v1/exec for the one-shot snippet case.
- [ElevenLabs](/docs/guides/migrate/elevenlabs): ElevenLabs synthesizes speech and transcribes it back. Here that is /v1/audio — five operations, OpenAI-shaped for speech and transcription.
- [Firebase](/docs/guides/migrate/firebase): 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/functions (11), hosting is /v1/projects (27), and the project id stops being something you carry.
- [Fly.io](/docs/guides/migrate/fly): 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/visor (34) for a machine placed in a region — with the tenant coming from your key rather than an org_slug field.
- [GoDaddy](/docs/guides/migrate/godaddy): GoDaddy sells and holds domains. Here that is /v1/domain — seven operations covering availability, search, purchase, renewal and transfer.
- [Grafana](/docs/guides/migrate/grafana): 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](/docs/guides/migrate/heroku): 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).
- [Lago](/docs/guides/migrate/lago): 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](/docs/guides/migrate/langsmith): 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](/docs/guides/migrate/launchdarkly): LaunchDarkly decides which users see which behaviour. Here that is /v1/flags — eight operations, one deterministic decision, and no SDK that has to be kept warm.
- [Modal](/docs/guides/migrate/modal): Modal deploys Python functions onto GPUs and calls them from a client. Here that is /v1/functions (11 operations) for the function, /v1/sandbox (19) for a sandbox and /v1/visor (34) for the accelerators underneath — with the tenant coming from your key rather than a workspace.
- [Netlify](/docs/guides/migrate/netlify): 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/functions (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](/docs/guides/migrate/okta): 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](/docs/guides/migrate/openai): 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/agents (37) for the assistant that runs, with the OpenAI-shaped inference routes at the addresses your client already calls.
- [Pinecone](/docs/guides/migrate/pinecone): 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](/docs/guides/migrate/planetscale): 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](/docs/guides/migrate/posthog): PostHog is product analytics, feature flags, experiments and session replay behind one SDK. Here that is /v1/event (12), /v1/flags (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](/docs/guides/migrate/render): 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](/docs/guides/migrate/replicate): 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](/docs/guides/migrate/sentry): 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](/docs/guides/migrate/sqs): SQS is a queue between services. Here that is /v1/mq for durable streams and consumers, and /v1/pubsub for the publish itself.
- [Stripe](/docs/guides/migrate/stripe): 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](/docs/guides/migrate/supabase): 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/functions (11), /v1/s3 (6), /v1/mq (15) and /v1/index (17) do the rest.
- [Tavily](/docs/guides/migrate/tavily): 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](/docs/guides/migrate/temporal): 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](/docs/guides/migrate/twilio): Twilio holds phone numbers and moves messages over them. Three capabilities answer it — /v1/tel for the carrier, /v1/notify for transactional delivery, /v1/channels for chat.
- [Upstash](/docs/guides/migrate/upstash): 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](/docs/guides/migrate/vault): 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](/docs/guides/migrate/vercel): 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](/docs/guides/migrate/workos): 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](/docs/guides/money): Balance, then the usage that moved it.
- [Store](/docs/guides/store): KV round-trip — create a store, read it back, delete it.
- [Tools](/docs/guides/tools): List the MCP tools this key can reach.

## MCP

- [MCP](/docs/mcp): 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](/docs/models): The live model catalogue — every id you can pass, and what it costs.

## The Network

- [The Network](/docs/network): 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](/docs/pricing): What a request costs — the three 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](/docs/proof-of-ai): 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](/docs/proof-of-ai/node-operator): 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](/docs/proof-of-ai/oss-payouts): 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](/docs/quickstart): 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.

## Run your org

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

## Startups

- [Startups](/docs/startups): 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](/docs/studio): 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](/docs/studio/getting-started): Run Hanzo Studio locally, submit your first prompt, and scale to GPU.

## Usage

- [Usage](/docs/usage): 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](/docs/usage/console): Connect your AI accounts at console.hanzo.ai and read the unified usage dashboard.
- [Quickstart](/docs/usage/quickstart): Install @hanzo/usage and read unified AI usage in ~15 lines of TypeScript.
- [Smart routing](/docs/usage/routing): 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](/docs/usage/teams): Share verified logins org-wide, route AI usage through Hanzo, and get per-member analytics.

## Webhooks

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

## Workspace

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

## Hanzo ZAP

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