API Reference
The unified REST API reference for every Hanzo product — 185 products, 2217 operations, generated from the OpenAPI document.
Hanzo API Reference
One cloud, one credential. Every Hanzo product speaks REST over HTTPS, shares a single API key, and is documented here straight from the OpenAPI document that also generates the SDKs, the CLI and the MCP tools — 185 products, 2217 operations.
Authentication
Every product accepts the same bearer credential — a Hanzo IAM JWT or an hk- API key.
curl -H "Authorization: Bearer $HANZO_API_KEY" https://api.hanzo.ai/v1/modelsGet a key at console.hanzo.ai. New here? Six flows, four surfaces walks the same journeys as CLI, SDK, HTTP and MCP.
Products
Ads
Package ads is your paid ad campaigns, launched and paused from one place. · 7 operations
Affiliates
Package affiliates is a partner program that pays commission on what your referrals spend. · 10 operations
Agent
Package agent is a conversation that uses your org's own tools to get an answer. · 4 operations
Agents
Package agents is autonomous agents for your org: define them, run them, keep every run. · 31 operations
Ai
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 208 operations
Analytics
Package analytics is product analytics: send an event, read back who did what. · 4 operations
Ask
Package ask is a plain-language question about your business, answered with real numbers. · 1 operations
Audio
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 4 operations
Audit
Package auditlog is your org's tamper-evident audit trail: every security-relevant event, hash-chained and readable. · 1 operations
Authors
Package authors is a royalty for open-source work: your repo runs, you get paid. · 5 operations
Authz
· 3 operations
Auto
Package auto is Hanzo Auto: build a flow from triggers and actions, publish it, and watch every run. · 11 operations
Automations
Package automations is workflows that run themselves, on a schedule or a webhook. · 18 operations
Avatar
Package account is your own account: API keys you mint and revoke, and org onboarding. · 2 operations
Balancers
Package do is the org-scoped private-network surface — /v1/vpcs and /v1/balancers — carved out of Hanzo's OWN house DigitalOcean… · 4 operations
Base
Package base is managed Hanzo Base: a hosted backend for your app — collections, records, access rules and sign-in. · 1 operations
Benchmark
Package benchmark is one honest score for any model, on the tests everyone quotes. · 6 operations
Billing
Package billing is your org's balance, what it has spent, and the cards it pays with. · 40 operations
Blueprint
Package blueprint is what a template costs to run, worked out before you deploy. · 3 operations
Books
Package books is double-entry accounting: chart of accounts, ledger, bank reconciliation, and the reports that prove the books… · 25 operations
Bot
Package bot is your own machines, connected and ready to take a command. · 10 operations
Bots
Package bots is a bot doing your work on a real desktop, live, while you watch. · 3 operations
Builds
Package platform is Hanzo PaaS: deploy containers to your own tenant namespace — builds, releases, environments, logs, custom… · 1 operations
Campaign
Package campaign is one go-to-market push across paid, organic and email at once. · 11 operations
Captable
Package captable is your cap table: stakeholders, share classes, grants, SAFEs, rounds, and who owns what. · 31 operations
Catalog
Package catalog is one place to browse every project, app and site built here. · 8 operations
Channels
Package channels is one inbox for the chat apps you connect — Discord, Slack, Teams, Telegram. · 7 operations
Chat
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 2 operations
Cloud
Package venue is bring your own cloud: link a DigitalOcean, AWS or GCP account and its clusters show up ready to run work. · 5 operations
Cloudflare
Package cloudflare is your Cloudflare account, managed from Hanzo: zones, Pages, Workers, Workers AI, R2, KV and D1. · 33 operations
Clusters
Package visor is the compute you rent from Hanzo: machines, GPUs and clusters — launch one, resize it, tear it down. · 6 operations
Code
Package code is search and symbols across your repos, for you and your agents. · 7 operations
Collections
Package base is managed Hanzo Base: a hosted backend for your app — collections, records, access rules and sign-in. · 12 operations
Commands
· 1 operations
Commerce
Package commerce is selling: checkout, subscriptions, invoices, spend alerts, payment webhooks and the storefront catalog. · 3 operations
Company
Package company is incorporation end to end: pick a structure, add founders, pay, file, and e-sign. · 22 operations
Completions
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 1 operations
Compliance
Package compliance is your KYC/KYB onboarding, accreditation records, and the evidence trail behind them. · 17 operations
Compute
Package visor is the compute you rent from Hanzo: machines, GPUs and clusters — launch one, resize it, tear it down. · 7 operations
Connector
Package integrations is how your org connects third-party accounts like Slack, and revokes them. · 1 operations
Connectors
Package integrations is how your org connects third-party accounts like Slack, and revokes them. · 8 operations
Content
Package content is marketing content from draft to published, on every channel. · 6 operations
Crawl
Package crawl is any web page turned into clean markdown a model can read. · 1 operations
Crm
Package crm is your sales pipeline: the companies, the people, the deals in play. · 20 operations
Csrf
Package account is your own account: API keys you mint and revoke, and org onboarding. · 1 operations
Dataroom
Package dataroom is a secure document room you share by link and watch page by page. · 17 operations
Datastore
Package provisioning is one-click data add-ons: a SQL, key-value, document, vector, search or object store, wired straight into… · 4 operations
Delete
· 2 operations
Deploy
Package deploy is Hanzo CD: see what each app is running, sync it, and roll back a bad release. · 21 operations
Destinations
Package destinations is your events forwarded to the ad and analytics tools you use. · 5 operations
Dev-bridge
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 1 operations
Dns
Package dns is your DNS records: the zones and records behind every name you point at Hanzo. · 6 operations
Docdb
Package provisioning is one-click data add-ons: a SQL, key-value, document, vector, search or object store, wired straight into… · 4 operations
Docs
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 1 operations
Documents
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 2 operations
Domain
Package domain is Hanzo Domains: search a name, see the price, buy it from your prepaid wallet. · 7 operations
Download
Package exec is the code interpreter: run a snippet in a sandbox and move files in and out. · 12 operations
Embed
Package account is your own account: API keys you mint and revoke, and org onboarding. · 1 operations
Embeddings
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 1 operations
Enablement
Package pricing is the price list: what every model, provider, GPU tier, tool and hosting plan costs. · 3 operations
Engine
Package engine is Hanzo Engine: which models the serving runtime has loaded, and the GPUs under it. · 4 operations
Entitlements
Package entitlements is what your org may run: what the plan grants, and which of those products are switched on. · 1 operations
Environments
Package platform is Hanzo PaaS: deploy containers to your own tenant namespace — builds, releases, environments, logs, custom… · 1 operations
Errors
Package analytics is product analytics: send an event, read back who did what. · 1 operations
Esign
Package esign is a document out for signature, signed and filed with an audit trail. · 13 operations
Evals
Package eval is scoring a model on your own data, with a judge you choose. · 16 operations
Event
Package analytics is product analytics: send an event, read back who did what. · 3 operations
Exec
Package exec is the code interpreter: run a snippet in a sandbox and move files in and out. · 12 operations
Experiments
Package experiments is A/B testing anything: a flag, an ad, a subject line, a model. · 7 operations
Feedback
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 1 operations
Files
Package exec is the code interpreter: run a snippet in a sandbox and move files in and out. · 12 operations
Finance
· 8 operations
Finetune
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 9 operations
Flags
Package flags is feature flags: ship it dark, then turn it on for who you pick. · 9 operations
Fleet
Package visor is the compute you rent from Hanzo: machines, GPUs and clusters — launch one, resize it, tear it down. · 6 operations
Flow
Package flow is Hanzo Flow: build an agent workflow on a visual canvas, run it, and read every run. · 8 operations
Framework
Package framework is document types you define: describe a record once, then create, list, submit and cancel documents against it. · 19 operations
Functions
Package functions is your serverless code: publish it, call it over HTTP, watch every run and what it cost. · 11 operations
Gateway
Package gateway is live control of the policy your API applies to every incoming request: CORS, rate limits, cache TTL and… · 3 operations
Generate-text-to-speech-audio
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 1 operations
Generate-text-to-speech-audio-stream
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 1 operations
Get
· 26 operations
Git
Package git is Git hosting for your org: create repos, clone, push, and see what they cost. · 36 operations
Gpus
Package visor is the compute you rent from Hanzo: machines, GPUs and clusters — launch one, resize it, tear it down. · 2 operations
Guide
Package guide is a step-by-step checklist that gets your business running on AI. · 19 operations
Health
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 1 operations
Help
Package help is a support desk: customers file tickets, your team answers them. · 4 operations
Iam
Package iam is Hanzo's identity provider: users, organizations, applications, and the OIDC/OAuth2 endpoints every Hanzo service… · 170 operations
Images
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 1 operations
Index
Package index is fast full-text search over your own data, typos forgiven. · 17 operations
Indexers
Package explorer is chain data: your block indexers and how far each has caught up, plus the on-chain price feeds. · 1 operations
Ingress
Package ingress is your front door: automatic TLS certificates and hostname routing to any backend, changed live. · 18 operations
Insights
Package analytics is product analytics: send an event, read back who did what. · 2 operations
Install-patch
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 1 operations
Integrations
Package integrations is how your org connects third-party accounts like Slack, and revokes them. · 32 operations
K8s
Package visor is the compute you rent from Hanzo: machines, GPUs and clusters — launch one, resize it, tear it down. · 5 operations
Kb
Package knowledge is your team's wiki and your agents' memory, searchable by meaning. · 9 operations
Keys
Package account is your own account: API keys you mint and revoke, and org onboarding. · 3 operations
Kms
Package kms is secret custody: your org's secrets sealed at rest, plus threshold signing. · 7 operations
Kv
Package provisioning is one-click data add-ons: a SQL, key-value, document, vector, search or object store, wired straight into… · 4 operations
Legal
Package legal is the paperwork your company needs, drafted, signed and filed. · 11 operations
Licensing
· 6 operations
Links
Package link is the unified AI login manager's registry: the org+user-scoped record of WHICH provider accounts (Claude Max,… · 11 operations
Logs
· 3 operations
Machines
Package visor is the compute you rent from Hanzo: machines, GPUs and clusters — launch one, resize it, tear it down. · 8 operations
Marketing
Package marketing is lifecycle email: drip sequences that reach the right people. · 35 operations
Marketplace
Package marketplace is the shop for tools and agents: browse, install into your project, publish your own free or priced. · 6 operations
Mcp
Package tools is everything your org can call, in one list: connector actions, functions, agents, skills and your own MCP servers. · 3 operations
Meet
Package meet is the virtual office: it decides who may join a room and mints the short-lived token that lets them in. · 2 operations
Memory
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 7 operations
Mesh
Package zt mounts the Hanzo Cloud NETWORKING surface: the tenant's Hanzo Zero Trust footprint — overlay networks, their routers… · 1 operations
Messages
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 2 operations
Metrics
· 4 operations
Ml
Package ml is model serving: deploy a model behind an endpoint and call it. · 7 operations
Models
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 4 operations
Mq
Package mq is queue and stream admin for your org: create them, watch them drain, ack what you pulled. · 15 operations
Networks
Package zt mounts the Hanzo Cloud NETWORKING surface: the tenant's Hanzo Zero Trust footprint — overlay networks, their routers… · 3 operations
Notify
Package notify is transactional email and SMS, sent through your org's own provider credential. · 4 operations
O11y
Package o11y is your logs, metrics and traces: ship them in, query them, chart them. · 364 operations
Options
· 2 operations
Oracles
Package explorer is chain data: your block indexers and how far each has caught up, plus the on-chain price feeds. · 1 operations
Org
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 12 operations
Orgs
Package account is your own account: API keys you mint and revoke, and org onboarding. · 3 operations
Patch
· 2 operations
Payments
Package commerce is selling: checkout, subscriptions, invoices, spend alerts, payment webhooks and the storefront catalog. · 2 operations
Pipelines
Package platform is Hanzo PaaS: deploy containers to your own tenant namespace — builds, releases, environments, logs, custom… · 1 operations
Plans
Package plan is the plan catalog: every tier you can buy, what it costs, and what it grants. · 20 operations
Platform
Package platform is Hanzo PaaS: deploy containers to your own tenant namespace — builds, releases, environments, logs, custom… · 41 operations
Plugins
Package plugin is what each host is running, and how to change it: enable, disable, reload, or pin a service to a version. · 4 operations
Post
· 8 operations
Prefs
Package prefs is your own settings — theme, density, pinned nav — following you across every Hanzo app. · 2 operations
Pricing
Package pricing is the price list: what every model, provider, GPU tier, tool and hosting plan costs. · 25 operations
Process-speech-to-text
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 1 operations
Projects
Package projects is where your sites live: create one, deploy a build, roll back to any release. · 15 operations
Prompts
Package prompts is your prompt library, versioned, so nothing changes silently. · 6 operations
Pubsub
Package pubsub is your message bus: publish, subscribe, and durable streams your apps read at their own pace. · 18 operations
Put
· 3 operations
Query
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 1 operations
Query_multiple
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 1 operations
Rag
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 5 operations
Referrals
Package referrals is referral ATTRIBUTION: who referred whom, and whether that referee ever became a real customer. · 2 operations
Registry
Package registry is your container and package registry: push images, pull them back, see what you store. · 6 operations
Releases
Package platform is Hanzo PaaS: deploy containers to your own tenant namespace — builds, releases, environments, logs, custom… · 1 operations
Rerank
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 1 operations
Research
Package research is every experiment you have ever run, kept and comparable. · 8 operations
Responses
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 1 operations
Risk
Package risk is HANZO RISK's model plane: the per-organisation feature surface and the per-organisation models trained on it. · 31 operations
Router
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 35 operations
Run
Package platform is Hanzo PaaS: deploy containers to your own tenant namespace — builds, releases, environments, logs, custom… · 1 operations
Runner
Package platform is Hanzo PaaS: deploy containers to your own tenant namespace — builds, releases, environments, logs, custom… · 3 operations
S3
Package provisioning is one-click data add-ons: a SQL, key-value, document, vector, search or object store, wired straight into… · 12 operations
Sbom
Package sbom is what is inside a container image: every component, resolvable by digest or image ref. · 3 operations
Scrape
Package websearch is a web search and a page fetch your agents can call. · 1 operations
Search
Package provisioning is one-click data add-ons: a SQL, key-value, document, vector, search or object store, wired straight into… · 6 operations
Security
Package security is secret scanning for your code: submit sources, get findings, masked never raw. · 7 operations
Sentry
Package o11y is your logs, metrics and traces: ship them in, query them, chart them. · 23 operations
Settings
Package settings is how an org configures each product it uses, secret fields included. · 2 operations
Share
Package share is a public URL for a service on your own machine, and a list of what you have open. · 2 operations
Sites
Package projects is where your sites live: create one, deploy a build, roll back to any release. · 7 operations
Skills
Package skills is the skill catalogue an AI client reads to learn what it can do. · 4 operations
Social
Package social is posting to every social account you own, now or on a schedule. · 13 operations
Sql
Package provisioning is one-click data add-ons: a SQL, key-value, document, vector, search or object store, wired straight into… · 4 operations
Store
Package commerce is selling: checkout, subscriptions, invoices, spend alerts, payment webhooks and the storefront catalog. · 34 operations
Summary
Package o11y is your logs, metrics and traces: ship them in, query them, chart them. · 1 operations
Sync
Package sync is data sync: link two endpoints and keep them in step, on a webhook, on a schedule, or on demand. · 6 operations
Tasks
Package tasks is Hanzo Tasks: durable workflows that survive a crash, with every run visible and replayable. · 12 operations
Team
Package team is your org's shared workspace: documents edited together, files, seats, and agents as teammates. · 17 operations
Templates
Package templates is a gallery of starter kits you can deploy as they come. · 5 operations
Tools
Package tools is everything your org can call, in one list: connector actions, functions, agents, skills and your own MCP servers. · 8 operations
Traces
· 4 operations
Tracker
Package tracker is your org's issue tracker: projects, issues, and the filters to find them. · 10 operations
Traffic
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 1 operations
Translate
Package translate is text in, the same text out in the language you asked for. · 3 operations
Upload
Package exec is the code interpreter: run a snippet in a sandbox and move files in and out. · 12 operations
Usage
Package usage is what your org ran and what it cost, broken down per account. · 11 operations
Validators
Package validators is one-click validator onboarding: prove your Genesis NFT, get a node provisioned, queue its registration. · 4 operations
Vector
Package provisioning is one-click data add-ons: a SQL, key-value, document, vector, search or object store, wired straight into… · 6 operations
Videos
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 3 operations
Vpcs
Package do is the org-scoped private-network surface — /v1/vpcs and /v1/balancers — carved out of Hanzo's OWN house DigitalOcean… · 4 operations
Wallets
Package wallets is blockchain key custody: create wallets, rotate their keys, and sign with them. · 8 operations
Webhooks
Package webhooks is how your app hears about events: register an endpoint, pick the events, get each one delivered and signed. · 8 operations
Websearch
Package websearch is a web search and a page fetch your agents can call. · 6 operations
Wecom-bot
Package ai is Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's… · 2 operations
World
Package world is a live news feed filtered to what your project cares about. · 6 operations
X402
Package x402 is pay-per-request over HTTP 402: quote a price, take the payment, serve the resource. · 1 operations
Prefer to click? The interactive reference renders the same document.
How is this guide?