# AI URL: https://docs.hanzo.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 cloud BUILDS but cannot INSTALL. Also for this capability: **API** · [CLI](https://docs.hanzo.ai/docs/cli/ai) · [MCP](https://docs.hanzo.ai/docs/mcp-tools/ai) · [SDKs](https://docs.hanzo.ai/docs/sdks) Hanzo AI — the model API on /v1 (/v1/chat/completions, /v1/messages, /v1/models and the rest of hanzoai/ai's surface) — mounted into a cloud binary with the money, ingest and telemetry callbacks cloud BUILDS but cannot INSTALL. > [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides) | | | | -------------- | -------------------------------------- | | **Base URL** | `https://api.hanzo.ai` | | **Operations** | 311 | | **Auth** | `Authorization: Bearer $HANZO_API_KEY` | ## Specification > **HIP-1211 · AI — The Model API** — Draft · [read the specification →](https://github.com/hanzoai/hips/blob/7ed737180339cd05b5f2935eafe7f7b83d2449a2/HIPs/hip-1211-ai-the-model-api.md) `ai` is the model API: the OpenAI- and Anthropic-compatible wire and the routing, memory, retrieval and fine-tuning surfaces behind it. The implementation is the `hanzoai/ai` module, mounted into a cloud binary by `hanzoai/cloud` `apps/ai` with the money, ingest and telemetry callbacks cloud builds but cannot install (`apps/ai/ai.go:1-17`). This HIP states the target address surface: the wire family at the root, everything else under `/v1/ai`. ### Motivation The module registers one greedy `/v1/*` door and the manifest hands it the `/v1` remainder (`manifest/apps.go:444`), which is how a dozen satellite roots — router, memory, rag and their compatibility twins — came to answer beside the wire under names nobody would call a product. The document now comes from the module's own router (`apps/ai/ai.go:75-90`), so the surface is honest about what it is; this HIP settles which of those roots are the capability's and which are gone. ### Specification The key words MUST, MUST NOT, SHOULD, SHOULD NOT and MAY are to be interpreted as in RFC 2119. #### The wire family stays at the root The vendor-compatible wire — `/v1/chat/completions`, `/v1/completions`, `/v1/embeddings`, `/v1/messages`, `/v1/models`, `/v1/images/*`, `/v1/audio/*`, `/v1/videos/*`, `/v1/responses`, `/v1/rerank` — is fixed by the protocol every vendor SDK hard-codes, is exempt by HIP-0139 §3.2, and belongs to `ai` and to no other capability. It MUST NOT move. #### Everything else answers under /v1/ai Six satellite roots fold under the capability's own name, each an HTTP binding of the module's handlers with no store of its own in cloud: the routing policy/stats/rewards surface (`/v1/ai/router`), the org's routing settings (`/v1/ai/org/settings`), fine-tuning jobs — the module's TrainJob broker — (`/v1/ai/finetune`), per-user memories (`/v1/ai/memory`), the RAG surface (`/v1/ai/rag`: embed, query, delete, context, and ingest — `/v1/docs/ingest` writes the same index the query reads, so it folds to `/v1/ai/rag/ingest` rather than minting a second root), the per-request routing reward (`/v1/ai/feedback`), and the public geo aggregate of request traffic (`/v1/ai/traffic`). Six roots are deleted, not moved: `/v1/documents` and `/v1/query` and `/v1/query_multiple` are compatibility spellings of routes that already exist under rag; `/v1/dev-bridge` is desktop tooling that spawns a local child process; `/v1/install-patch` is a device-management remnant; `/v1/wecom-bot` is a bot channel that belongs to `bots` if it is ever productized. There is no alias for any of them. Today's router still serves each satellite at its old root out of the `/v1` remainder; every such pair is a line in `hanzoai/cloud` `openapi/misfiled.txt` until the fold lands. The route moves land in the `hanzoai/ai` module, where the router lives (`routers/wired_gen.go`). The document is the module's own, read out of the pinned module at describe time (`apps/ai/ai.go:39-71`); operations answer the module's envelope, whose `data` stays untyped here because per-operation bodies are typing work in the module that owns the handlers. #### Tenancy, money and the count The capability owns no store in cloud; all state lives behind the `hanzoai/ai` module. A request's tenant is the validated principal's org, and every debit and count is keyed by that namespace and never by a body field. Metering is per served call, self-reported by the module's one usage hook: a priced call debits its dollar cost over the internal plane to the commerce ledger, with the idempotency ref minted server-side per debit so a caller-supplied id can never dedupe a second answer into a first (`apps/ai/ai.go:195-215`); a free call counts once against its subject's plan allowance, and both halves always run (`apps/ai/ai.go:229-256`). The plugin declares `Price: cloud.Metered` (`plugin/ai/main.go:43`). #### Events and observability It publishes no events on the tenant bus, so a customer's webhooks receive nothing from this capability. It emits the `gen_ai` span family for every completion, through the host's one tracer provider — adopted at mount so the module cannot fork a second, dark provider (`apps/ai/ai.go:271-287`). #### Stage `ga`, and the row is marked `Vital` (`manifest/apps.go:444`). #### Upstreams The capability embeds `github.com/hanzoai/ai` v1.833.106 (Apache-2.0), which is the whole implementation — router, wire, memory, rag, finetune. The OpenAI and Anthropic wire shapes are implemented formats, not embedded code. Nothing else here derives from an OSS upstream. ### Rationale The alternative for the satellites was to keep them where SDK compatibility put them and describe the exceptions. But the exemption in HIP-0139 §3.2 is exactly as wide as the protocol: the wire paths are hard-coded in vendor SDKs and the satellites are not — LangChain-era twins and device-management remnants have no SDK pinning them, so they take the ordinary rule. Folding rather than splitting follows from the store: there is none in cloud, so §7.1's default applies to every pair. ### Security Considerations The wrong implementation here is free inference and mis-billed inference. The debit path is the guard on both: the charge is keyed to the validated namespace, the ref is server-minted (a client-controlled ref let one pinned owner/name pair dedupe every later completion into the first one's entry — `apps/ai/ai.go:184-193`), and the free-call count runs even when the debit fails, so neither leg's failure opens the other. Deleting the compatibility roots is also a security act: each was an unowned door into the same index the canonical routes guard. ## Four surfaces | Surface | Reaches this capability as | Coverage | | -------- | ------------------------------------------ | ------------------------------------------------------------------------- | | **REST** | `ai` at its own prefix | 311 operations | | **CLI** | `hanzo 3d …` | 296 of 311 — the CLI pins the document on its own clock | | **SDK** | `AiApi` in every published client | 273 of 311 — the clients are generated at their own release | | **MCP** | tool `ai` on `https://api.hanzo.ai/v1/mcp` | 3 operations, 2 under the document's own id — ask `describe` for the rest | ## Quickstart ```bash export HANZO_API_KEY=sk-... # console.hanzo.ai → API keys ``` Then the first call — a read that needs nothing but the key. `GET /v1/models`, operation `get_models`: **CLI** ```bash hanzo models list ``` **SDK** **.ts** ```ts import { Configuration, AiApi } from 'hanzoai'; const api = new AiApi(new Configuration({ accessToken: process.env.HANZO_API_KEY })); const { data } = await api.getModels(); ``` **.py** ```python from hanzoai.cloud import ApiClient, Configuration from hanzoai.cloud.api import AiApi client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"])) result = AiApi(client).get_models() ``` **.go** ```go cfg := hanzoai.NewConfiguration() cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY")) client := hanzoai.NewAPIClient(cfg) resp, _, err := client.AiAPI.GetModels(context.Background()).Execute() if err != nil { return err } ``` **.rs** ```rust use hanzo_client::apis::{configuration::Configuration, ai_api}; let mut cfg = Configuration::new(); cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok(); let result = ai_api::get_models(&cfg, Default::default()).await?; ``` **.java** ```java import ai.hanzo.cloud.ApiClient; import ai.hanzo.cloud.api.AiApi; ApiClient client = new ApiClient(); client.setBearerToken(System.getenv("HANZO_API_KEY")); var result = new AiApi(client).getModels(); ``` **HTTP** ```bash curl https://api.hanzo.ai/v1/models \ -H "Authorization: Bearer $HANZO_API_KEY" ``` **MCP** MCP declares no tool for **ai** — `tools/list` on `https://api.hanzo.ai/v1/mcp` names the products it does reach. Use HTTP or an SDK. Answers `200` with `object` — Success.. ## Endpoints | Endpoint | What it does | | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`GET /v1/3d/{id}/content`](https://docs.hanzo.ai/docs/openapi/ai/get-3d-by-id-content) | Implements GET /v1/3d/:id/content (Download 3D splat/glb content). | | [`GET /v1/3d/{id}`](https://docs.hanzo.ai/docs/openapi/ai/get-3d-by-id) | Implements GET /v1/3d/:id (Retrieve 3D status). | | [`POST /v1/3d/generations`](https://docs.hanzo.ai/docs/openapi/ai/post-3d-generations) | Implements POST /v1/3d/generations (Text/Image to 3D & Gaussian Splats). | | [`GET /v1/ai/account`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-account) | Account | | [`GET /v1/ai/activities`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-activities) | List activities | | [`GET /v1/ai/answer`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-answer) | Answer | | [`GET /v1/ai/articles/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-articles-by-owner-by-name) | Retrieve a article | | [`PUT /v1/ai/articles/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-articles-by-owner-by-name) | Replace a article | | [`PATCH /v1/ai/articles/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-articles-by-owner-by-name) | Update a article | | [`DELETE /v1/ai/articles/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-articles-by-owner-by-name) | Delete a article | | [`GET /v1/ai/articles/global`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-articles-global) | List articles across tenants | | [`GET /v1/ai/articles`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-articles) | List articles | | [`POST /v1/ai/articles`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-articles) | Create a article | | [`POST /v1/ai/assets/{owner}/{name}/scan`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-assets-by-owner-by-name-scan) | Scan (asset) | | [`GET /v1/ai/assets/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-assets-by-owner-by-name) | Retrieve a asset | | [`PUT /v1/ai/assets/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-assets-by-owner-by-name) | Replace a asset | | [`PATCH /v1/ai/assets/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-assets-by-owner-by-name) | Update a asset | | [`DELETE /v1/ai/assets/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-assets-by-owner-by-name) | Delete a asset | | [`POST /v1/ai/assets/scan`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-assets-scan) | Scan (asset) | | [`GET /v1/ai/assets`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-assets) | List assets | | [`POST /v1/ai/assets`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-assets) | Create a asset | | [`GET /v1/ai/chats/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-chats-by-owner-by-name) | Retrieve a chat | | [`PUT /v1/ai/chats/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-chats-by-owner-by-name) | Replace a chat | | [`PATCH /v1/ai/chats/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-chats-by-owner-by-name) | Update a chat | | [`DELETE /v1/ai/chats/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-chats-by-owner-by-name) | Delete a chat | | [`GET /v1/ai/chats/global`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-chats-global) | List chats across tenants | | [`GET /v1/ai/chats`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-chats) | List chats | | [`POST /v1/ai/chats`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-chats) | Create a chat | | [`GET /v1/ai/connections/{provider}/authorize`](https://docs.hanzo.ai/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. | | [`GET /v1/ai/connections/{provider}/callback`](https://docs.hanzo.ai/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 row/logs) through the same path as a BYOK key, and the org's provider row is upserted to "connected". | | [`GET /v1/ai/connections/{provider}/usage`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-connections-by-provider-usage) | Imports the caller org's usage for a connected third-party account. | | [`POST /v1/ai/connections/{provider}`](https://docs.hanzo.ai/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 best-effort tombstones the sealed secret. | | [`DELETE /v1/ai/connections/{provider}`](https://docs.hanzo.ai/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 best-effort tombstones the sealed secret. | | [`GET /v1/ai/connections`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-connections) | Lists the org's connectable AI accounts and whether each is currently connected. | | [`POST /v1/ai/connections`](https://docs.hanzo.ai/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. | | [`GET /v1/ai/dashboards/agents`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-dashboards-agents) | Dashboards Agents | | [`GET /v1/ai/dashboards/vm`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-dashboards-vm) | Dashboards Vm | | [`POST /v1/ai/deployments/{owner}/{name}/deploy`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-deployments-by-owner-by-name-deploy) | Deploy (application) | | [`POST /v1/ai/deployments/{owner}/{name}/undeploy`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-deployments-by-owner-by-name-undeploy) | Undeploy (application) | | [`GET /v1/ai/deployments/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-deployments-by-owner-by-name) | Retrieve a application | | [`PUT /v1/ai/deployments/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-deployments-by-owner-by-name) | Replace a application | | [`PATCH /v1/ai/deployments/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-deployments-by-owner-by-name) | Update a application | | [`DELETE /v1/ai/deployments/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-deployments-by-owner-by-name) | Delete a application | | [`GET /v1/ai/deployments`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-deployments) | List deployments | | [`POST /v1/ai/deployments`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-deployments) | Create a application | | [`POST /v1/ai/feedback`](https://docs.hanzo.ai/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. | | [`POST /v1/ai/files/{owner}/{name}/vectors`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-files-by-owner-by-name-vectors) | Vectors (file) | | [`GET /v1/ai/files/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-files-by-owner-by-name) | Retrieve a file | | [`PUT /v1/ai/files/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-files-by-owner-by-name) | Replace a file | | [`PATCH /v1/ai/files/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-files-by-owner-by-name) | Update a file | | [`DELETE /v1/ai/files/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-files-by-owner-by-name) | Delete a file | | [`POST /v1/ai/files/activate`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-files-activate) | Activate (file) | | [`GET /v1/ai/files/active`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-files-active) | Active (file) | | [`GET /v1/ai/files/global`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-files-global) | List files across tenants | | [`POST /v1/ai/files/upload`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-files-upload) | Upload (file) | | [`GET /v1/ai/files`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-files) | List files | | [`POST /v1/ai/files`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-files) | Create a file | | [`POST /v1/ai/finetune/cancel`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-finetune-cancel) | Deletes the TrainJob CR, meters the GPU-hours used so far, and marks the job cancelled. | | [`POST /v1/ai/finetune/deploy`](https://docs.hanzo.ai/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. | | [`GET /v1/ai/finetune/hf/datasets`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-finetune-hf-datasets) | Proxies a HuggingFace dataset search (dataset picker). | | [`GET /v1/ai/finetune/hf/models`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-finetune-hf-models) | Proxies a HuggingFace model search (base-model picker). | | [`GET /v1/ai/finetune/hf/repo`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-finetune-hf-repo) | Returns a repo's detail (files, gated/private state). | | [`GET /v1/ai/finetune/job`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-finetune-job) | Returns one job with refreshed live status. | | [`GET /v1/ai/finetune/jobs`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-finetune-jobs) | Returns the org's jobs, refreshing live status for active ones. | | [`POST /v1/ai/finetune/jobs`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-finetune-jobs) | Validates the request, resolves efficient defaults, persists the job, and submits a real TrainJob CR. | | [`GET /v1/ai/finetune/presets`](https://docs.hanzo.ai/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 render "Recommended" as a one-click, ready-to-run default. | | [`GET /v1/ai/forms/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-forms-by-owner-by-name) | Retrieve a form | | [`PUT /v1/ai/forms/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-forms-by-owner-by-name) | Replace a form | | [`PATCH /v1/ai/forms/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-forms-by-owner-by-name) | Update a form | | [`DELETE /v1/ai/forms/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-forms-by-owner-by-name) | Delete a form | | [`GET /v1/ai/forms/data`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-forms-data) | Data (form) | | [`GET /v1/ai/forms/global`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-forms-global) | List forms across tenants | | [`GET /v1/ai/forms`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-forms) | List forms | | [`POST /v1/ai/forms`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-forms) | Create a form | | [`GET /v1/ai/graphs/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-graphs-by-owner-by-name) | Retrieve a graph | | [`PUT /v1/ai/graphs/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-graphs-by-owner-by-name) | Replace a graph | | [`PATCH /v1/ai/graphs/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-graphs-by-owner-by-name) | Update a graph | | [`DELETE /v1/ai/graphs/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-graphs-by-owner-by-name) | Delete a graph | | [`GET /v1/ai/graphs/global`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-graphs-global) | List graphs across tenants | | [`GET /v1/ai/graphs`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-graphs) | List graphs | | [`POST /v1/ai/graphs`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-graphs) | Create a graph | | [`GET /v1/ai/k8s-status`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-k8s-status) | K8s Status | | [`GET /v1/ai/limits`](https://docs.hanzo.ai/docs/openapi/ai/ailimits) | Reads the caller's plan usage: for each class of model the plan includes, the share used of the billing period and of its short window, who pays for the next request, and whether the caller is in limited mode and why; the share used of the session and the day; and the ways on. | | [`PUT /v1/ai/limits`](https://docs.hanzo.ai/docs/openapi/ai/aisetlimits) | Sets the payer's choice to keep using a model on credits once the plan's included usage of it is spent. | | [`POST /v1/ai/mcp/chat`](https://docs.hanzo.ai/docs/openapi/ai/aichat) | Asks one model one prompt and answers the reply, which model served it and who paid. | | [`POST /v1/ai/mcp/decisions`](https://docs.hanzo.ai/docs/openapi/ai/aidecide) | Runs one decision — the caller's own POST /v1/decisions, gated and billed exactly as that route is — and answers the decision, which model served it and who paid. | | [`GET /v1/ai/mcp/models`](https://docs.hanzo.ai/docs/openapi/ai/aimodels) | Searches the model catalog — the one GET /v1/models lists — by text, class, family or capability, and answers each match with its class, family, list price (per token and per million; variable for a router billed at the answering model's price), context window and capabilities. | | [`GET /v1/ai/mcp/tools`](https://docs.hanzo.ai/docs/openapi/ai/aimcptools) | Reports what THIS PROCESS's MCP server carries: how many tools its own registry projects, optionally their names, and which subsystems this process composed. | | [`POST /v1/ai/memory/delete`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-memory-delete) | Delete one of the authenticated user's memories | | [`GET /v1/ai/memory/facts`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-memory-facts) | List the authenticated user's stored facts | | [`GET /v1/ai/memory/list`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-memory-list) | List the authenticated user's memories, newest first | | [`GET /v1/ai/memory/recall`](https://docs.hanzo.ai/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 | | [`POST /v1/ai/memory/remember`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-memory-remember) | Store a memory for the authenticated user | | [`GET /v1/ai/memory/search`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-memory-search) | Search the authenticated user's memories (semantic, text fallback) | | [`POST /v1/ai/memory/update`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-memory-update) | Update one of the authenticated user's memories | | [`GET /v1/ai/messages/{owner}/{name}/answer`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-messages-by-owner-by-name-answer) | Answer (message) | | [`GET /v1/ai/messages/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-messages-by-owner-by-name) | Retrieve a message | | [`PUT /v1/ai/messages/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-messages-by-owner-by-name) | Replace a message | | [`PATCH /v1/ai/messages/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-messages-by-owner-by-name) | Update a message | | [`DELETE /v1/ai/messages/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-messages-by-owner-by-name) | Delete a message | | [`DELETE /v1/ai/messages/welcome`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-messages-welcome) | Welcome (message) | | [`GET /v1/ai/messages`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-messages) | List messages | | [`POST /v1/ai/messages`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-messages) | Create a message | | [`GET /v1/ai/nodes/{owner}/{name}/tunnel`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-nodes-by-owner-by-name-tunnel) | Tunnel (node) | | [`POST /v1/ai/nodes/{owner}/{name}/tunnel`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-nodes-by-owner-by-name-tunnel) | Tunnel (node) | | [`GET /v1/ai/nodes/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-nodes-by-owner-by-name) | Retrieve a node | | [`PUT /v1/ai/nodes/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-nodes-by-owner-by-name) | Replace a node | | [`PATCH /v1/ai/nodes/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-nodes-by-owner-by-name) | Update a node | | [`DELETE /v1/ai/nodes/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-nodes-by-owner-by-name) | Delete a node | | [`GET /v1/ai/nodes`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-nodes) | List nodes | | [`POST /v1/ai/nodes`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-nodes) | Create a node | | [`GET /v1/ai/org/settings/list`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`POST /v1/ai/org/settings/list`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`PUT /v1/ai/org/settings/list`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`PATCH /v1/ai/org/settings/list`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`DELETE /v1/ai/org/settings/list`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`GET /v1/ai/org/settings`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`POST /v1/ai/org/settings`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`PUT /v1/ai/org/settings`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`PATCH /v1/ai/org/settings`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`DELETE /v1/ai/org/settings`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`PUT /v1/ai/preferences`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-preferences) | Preferences | | [`PATCH /v1/ai/preferences`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-preferences) | Preferences | | [`GET /v1/ai/prometheus`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-prometheus) | Prometheus | | [`GET /v1/ai/providers/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-providers-by-owner-by-name) | Retrieve a provider | | [`PUT /v1/ai/providers/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-providers-by-owner-by-name) | Replace a provider | | [`PATCH /v1/ai/providers/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-providers-by-owner-by-name) | Update a provider | | [`DELETE /v1/ai/providers/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-providers-by-owner-by-name) | Delete a provider | | [`GET /v1/ai/providers/global`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-providers-global) | List providers across tenants | | [`POST /v1/ai/providers/mcp-tools`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-providers-mcp-tools) | Mcp Tools (provider) | | [`GET /v1/ai/providers`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-providers) | List providers | | [`POST /v1/ai/providers`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-providers) | Create a provider | | [`GET /v1/ai/rag/context`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-rag-context) | Return every stored chunk of one file\_id (full document context). | | [`POST /v1/ai/rag/delete`](https://docs.hanzo.ai/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. | | [`POST /v1/ai/rag/embed`](https://docs.hanzo.ai/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. | | [`POST /v1/ai/rag/ingest`](https://docs.hanzo.ai/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 {owner}-{store}-docs — the same index /v1/chat retrieval reads. | | [`POST /v1/ai/rag/query-multiple`](https://docs.hanzo.ai/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`). | | [`POST /v1/ai/rag/query`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-rag-query) | Retrieve the top-K chunks relevant to a query, scoped to a single uploaded file (`file_id`). | | [`GET /v1/ai/records/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-records-by-owner-by-name) | Retrieve a record | | [`PUT /v1/ai/records/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-records-by-owner-by-name) | Replace a record | | [`PATCH /v1/ai/records/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-records-by-owner-by-name) | Update a record | | [`DELETE /v1/ai/records/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-records-by-owner-by-name) | Delete a record | | [`POST /v1/ai/records/batch`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-records-batch) | Batch (record) | | [`POST /v1/ai/records/commit-second`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-records-commit-second) | Commit Second (record) | | [`POST /v1/ai/records/commit`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-records-commit) | Commit (record) | | [`GET /v1/ai/records/query-second`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-records-query-second) | Query Second (record) | | [`GET /v1/ai/records/query`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-records-query) | Query (record) | | [`GET /v1/ai/records`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-records) | List records | | [`POST /v1/ai/records`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-records) | Create a record | | [`POST /v1/ai/remote-connections/{owner}/{name}/start`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-remote-connections-by-owner-by-name-start) | Start (connection) | | [`POST /v1/ai/remote-connections/{owner}/{name}/stop`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-remote-connections-by-owner-by-name-stop) | Stop (connection) | | [`GET /v1/ai/remote-connections/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-remote-connections-by-owner-by-name) | Retrieve a connection | | [`PUT /v1/ai/remote-connections/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-remote-connections-by-owner-by-name) | Replace a connection | | [`PATCH /v1/ai/remote-connections/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-remote-connections-by-owner-by-name) | Update a connection | | [`DELETE /v1/ai/remote-connections/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-remote-connections-by-owner-by-name) | Delete a connection | | [`GET /v1/ai/remote-connections`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-remote-connections) | List remote-connections | | [`POST /v1/ai/remote-connections`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-remote-connections) | Create a connection | | [`GET /v1/ai/router/artifact-meta`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`POST /v1/ai/router/artifact-meta`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`PUT /v1/ai/router/artifact-meta`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`PATCH /v1/ai/router/artifact-meta`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`DELETE /v1/ai/router/artifact-meta`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`POST /v1/ai/router/catalog/propose`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-router-catalog-propose) | Answers the diff an edited catalog would apply to a family, and the version it would be made from. | | [`POST /v1/ai/router/catalog/rollback`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-router-catalog-rollback) | Applies an earlier version of a family's catalog again, as a new version. | | [`POST /v1/ai/router/catalog/test`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-router-catalog-test) | Sends one short turn to a SKU through its family and answers which upstream wrote it and how long it took. | | [`GET /v1/ai/router/catalog`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-router-catalog) | Lists the Zen and Enso routing catalogs: what each serves, its accounts and model health, and its version history. | | [`PUT /v1/ai/router/catalog`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-router-catalog) | Applies an edited catalog to one family, made from its newest version, and records the new version. | | [`GET /v1/ai/router/data`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-router-data) | Router Data | | [`DELETE /v1/ai/router/data`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-router-data) | Router Data | | [`GET /v1/ai/router/defaults`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`POST /v1/ai/router/defaults`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`PUT /v1/ai/router/defaults`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`PATCH /v1/ai/router/defaults`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`DELETE /v1/ai/router/defaults`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`GET /v1/ai/router/history`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-router-history) | Returns the router-improvement time-series. | | [`GET /v1/ai/router/judge-panel`](https://docs.hanzo.ai/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, the live in-process per-judge calibration (weight/mean/n), and the static published benchmark. | | [`GET /v1/ai/router/ledger`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`POST /v1/ai/router/ledger`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`PUT /v1/ai/router/ledger`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`PATCH /v1/ai/router/ledger`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`DELETE /v1/ai/router/ledger`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`GET /v1/ai/router/policy`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`POST /v1/ai/router/policy`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`PUT /v1/ai/router/policy`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`PATCH /v1/ai/router/policy`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`DELETE /v1/ai/router/policy`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`GET /v1/ai/router/rewards`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`POST /v1/ai/router/rewards`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`PUT /v1/ai/router/rewards`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`PATCH /v1/ai/router/rewards`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`DELETE /v1/ai/router/rewards`](https://docs.hanzo.ai/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 /v1/ai/org/settings\[/list]). | | [`GET /v1/ai/router/stats`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-router-stats) | Returns the router observability aggregate. | | [`GET /v1/ai/routes/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-routes-by-owner-by-name) | Retrieve a model-route | | [`PUT /v1/ai/routes/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-routes-by-owner-by-name) | Replace a model-route | | [`PATCH /v1/ai/routes/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-routes-by-owner-by-name) | Update a model-route | | [`DELETE /v1/ai/routes/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-routes-by-owner-by-name) | Delete a model-route | | [`GET /v1/ai/routes`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-routes) | List routes | | [`POST /v1/ai/routes`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-routes) | Create a model-route | | [`GET /v1/ai/scales/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-scales-by-owner-by-name) | Retrieve a scale | | [`PUT /v1/ai/scales/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-scales-by-owner-by-name) | Replace a scale | | [`PATCH /v1/ai/scales/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-scales-by-owner-by-name) | Update a scale | | [`DELETE /v1/ai/scales/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-scales-by-owner-by-name) | Delete a scale | | [`GET /v1/ai/scales/global`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-scales-global) | List scales across tenants | | [`GET /v1/ai/scales/public`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-scales-public) | Public (scale) | | [`GET /v1/ai/scales`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-scales) | List scales | | [`POST /v1/ai/scales`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-scales) | Create a scale | | [`GET /v1/ai/scans/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-scans-by-owner-by-name) | Retrieve a scan | | [`PUT /v1/ai/scans/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-scans-by-owner-by-name) | Replace a scan | | [`PATCH /v1/ai/scans/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-scans-by-owner-by-name) | Update a scan | | [`DELETE /v1/ai/scans/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-scans-by-owner-by-name) | Delete a scan | | [`GET /v1/ai/scans`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-scans) | List scans | | [`POST /v1/ai/scans`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-scans) | Create a scan | | [`GET /v1/ai/signin-sessions/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-signin-sessions-by-owner-by-name) | Retrieve a session | | [`PUT /v1/ai/signin-sessions/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-signin-sessions-by-owner-by-name) | Replace a session | | [`PATCH /v1/ai/signin-sessions/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-signin-sessions-by-owner-by-name) | Update a session | | [`DELETE /v1/ai/signin-sessions/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-signin-sessions-by-owner-by-name) | Delete a session | | [`GET /v1/ai/signin-sessions/duplicated`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-signin-sessions-duplicated) | Duplicated (session) | | [`GET /v1/ai/signin-sessions`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-signin-sessions) | List signin-sessions | | [`POST /v1/ai/signin-sessions`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-signin-sessions) | Create a session | | [`POST /v1/ai/signin`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-signin) | Signin | | [`POST /v1/ai/signout`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-signout) | Signout | | [`POST /v1/ai/stores/{owner}/{name}/vectors`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-stores-by-owner-by-name-vectors) | Vectors (store) | | [`GET /v1/ai/stores/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-stores-by-owner-by-name) | Retrieve a store | | [`PUT /v1/ai/stores/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-stores-by-owner-by-name) | Replace a store | | [`PATCH /v1/ai/stores/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-stores-by-owner-by-name) | Update a store | | [`DELETE /v1/ai/stores/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-stores-by-owner-by-name) | Delete a store | | [`GET /v1/ai/stores/global`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-stores-global) | List stores across tenants | | [`GET /v1/ai/stores/names`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-stores-names) | Names (store) | | [`GET /v1/ai/stores/providers`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-stores-providers) | Providers (store) | | [`GET /v1/ai/stores`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-stores) | List stores | | [`POST /v1/ai/stores`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-stores) | Create a store | | [`GET /v1/ai/system`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-system) | System | | [`POST /v1/ai/tasks/{owner}/{name}/analyze`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-tasks-by-owner-by-name-analyze) | Analyze (task) | | [`POST /v1/ai/tasks/{owner}/{name}/document`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-tasks-by-owner-by-name-document) | Document (task) | | [`GET /v1/ai/tasks/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-tasks-by-owner-by-name) | Retrieve a task | | [`PUT /v1/ai/tasks/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-tasks-by-owner-by-name) | Replace a task | | [`PATCH /v1/ai/tasks/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-tasks-by-owner-by-name) | Update a task | | [`DELETE /v1/ai/tasks/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-tasks-by-owner-by-name) | Delete a task | | [`GET /v1/ai/tasks/global`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-tasks-global) | List tasks across tenants | | [`GET /v1/ai/tasks`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-tasks) | List tasks | | [`POST /v1/ai/tasks`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-tasks) | Create a task | | [`GET /v1/ai/templates/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-templates-by-owner-by-name) | Retrieve a template | | [`PUT /v1/ai/templates/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-templates-by-owner-by-name) | Replace a template | | [`PATCH /v1/ai/templates/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-templates-by-owner-by-name) | Update a template | | [`DELETE /v1/ai/templates/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-templates-by-owner-by-name) | Delete a template | | [`GET /v1/ai/templates`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-templates) | List templates | | [`POST /v1/ai/templates`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-templates) | Create a template | | [`GET /v1/ai/traffic/globe`](https://docs.hanzo.ai/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 points with per-service-class counts, plus headline throughput rates. | | [`GET /v1/ai/training-contribution`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-training-contribution) | Training Contribution | | [`PUT /v1/ai/training-contribution`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-training-contribution) | Training Contribution | | [`PATCH /v1/ai/training-contribution`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-training-contribution) | Training Contribution | | [`PUT /v1/ai/tree-files/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-tree-files-by-owner-by-name) | Replace a tree-file | | [`PATCH /v1/ai/tree-files/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-tree-files-by-owner-by-name) | Update a tree-file | | [`DELETE /v1/ai/tree-files/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-tree-files-by-owner-by-name) | Delete a tree-file | | [`POST /v1/ai/tree-files`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-tree-files) | Create a tree-file | | [`GET /v1/ai/usages/by-user`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-usages-by-user) | By User (usage) | | [`GET /v1/ai/usages/cloud`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-usages-cloud) | Cloud (usage) | | [`GET /v1/ai/usages/range`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-usages-range) | Range (usage) | | [`GET /v1/ai/usages/user-names`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-usages-user-names) | User Names (usage) | | [`GET /v1/ai/usages`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-usages) | List usages | | [`GET /v1/ai/vectors/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-vectors-by-owner-by-name) | Retrieve a vector | | [`PUT /v1/ai/vectors/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-vectors-by-owner-by-name) | Replace a vector | | [`PATCH /v1/ai/vectors/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-vectors-by-owner-by-name) | Update a vector | | [`DELETE /v1/ai/vectors/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-vectors-by-owner-by-name) | Delete a vector | | [`DELETE /v1/ai/vectors/all`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-vectors-all) | All (vector) | | [`GET /v1/ai/vectors/global`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-vectors-global) | List vectors across tenants | | [`GET /v1/ai/vectors`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-vectors) | List vectors | | [`POST /v1/ai/vectors`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-vectors) | Create a vector | | [`GET /v1/ai/version`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-version) | Version | | [`GET /v1/ai/videos/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-videos-by-owner-by-name) | Retrieve a video | | [`PUT /v1/ai/videos/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-videos-by-owner-by-name) | Replace a video | | [`PATCH /v1/ai/videos/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-videos-by-owner-by-name) | Update a video | | [`DELETE /v1/ai/videos/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-videos-by-owner-by-name) | Delete a video | | [`GET /v1/ai/videos/global`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-videos-global) | List videos across tenants | | [`POST /v1/ai/videos/upload`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-videos-upload) | Upload (video) | | [`GET /v1/ai/videos`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-videos) | List videos | | [`POST /v1/ai/videos`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-videos) | Create a video | | [`GET /v1/ai/workflows/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-workflows-by-owner-by-name) | Retrieve a workflow | | [`PUT /v1/ai/workflows/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/put-ai-workflows-by-owner-by-name) | Replace a workflow | | [`PATCH /v1/ai/workflows/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/patch-ai-workflows-by-owner-by-name) | Update a workflow | | [`DELETE /v1/ai/workflows/{owner}/{name}`](https://docs.hanzo.ai/docs/openapi/ai/delete-ai-workflows-by-owner-by-name) | Delete a workflow | | [`GET /v1/ai/workflows/global`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-workflows-global) | List workflows across tenants | | [`GET /v1/ai/workflows`](https://docs.hanzo.ai/docs/openapi/ai/get-ai-workflows) | List workflows | | [`POST /v1/ai/workflows`](https://docs.hanzo.ai/docs/openapi/ai/post-ai-workflows) | Create a workflow | | [`POST /v1/audio/foley`](https://docs.hanzo.ai/docs/openapi/ai/post-audio-foley) | Serves the generative audio verbs — /v1/audio/voice (TTS), /music, /foley — that the Zen family serves natively. | | [`POST /v1/audio/music`](https://docs.hanzo.ai/docs/openapi/ai/post-audio-music) | Serves the generative audio verbs — /v1/audio/voice (TTS), /music, /foley — that the Zen family serves natively. | | [`POST /v1/audio/speech`](https://docs.hanzo.ai/docs/openapi/ai/post-audio-speech) | The OpenAI-compatible TTS endpoint (POST /v1/audio/speech). | | [`POST /v1/audio/transcript/{id}`](https://docs.hanzo.ai/docs/openapi/ai/post-audio-transcript-by-id) | Serves the growing transcript over HTTP: POST opens one, POST to its id pushes raw pcm16 at 16 kHz, and DELETE closes it with the settled text. | | [`DELETE /v1/audio/transcript/{id}`](https://docs.hanzo.ai/docs/openapi/ai/delete-audio-transcript-by-id) | Serves the growing transcript over HTTP: POST opens one, POST to its id pushes raw pcm16 at 16 kHz, and DELETE closes it with the settled text. | | [`POST /v1/audio/transcript`](https://docs.hanzo.ai/docs/openapi/ai/post-audio-transcript) | Serves the growing transcript over HTTP: POST opens one, POST to its id pushes raw pcm16 at 16 kHz, and DELETE closes it with the settled text. | | [`POST /v1/audio/transcriptions/public`](https://docs.hanzo.ai/docs/openapi/ai/post-audio-transcriptions-public) | Transcribes up to a minute of audio for a caller with no account, on Hanzo's own transcriber, within a daily allowance per visitor. | | [`POST /v1/audio/transcriptions`](https://docs.hanzo.ai/docs/openapi/ai/post-audio-transcriptions) | The OpenAI-compatible STT endpoint (POST /v1/audio/transcriptions, multipart: file + model \[+ language + response\_format]). | | [`POST /v1/audio/voice`](https://docs.hanzo.ai/docs/openapi/ai/post-audio-voice) | Serves the generative audio verbs — /v1/audio/voice (TTS), /music, /foley — that the Zen family serves natively. | | [`POST /v1/chat/completions`](https://docs.hanzo.ai/docs/openapi/ai/post-chat-completions) | Implements the OpenAI-compatible chat completions API | | [`POST /v1/chat/public`](https://docs.hanzo.ai/docs/openapi/ai/post-chat-public) | Serves one completion to a caller with no account. | | [`POST /v1/chat`](https://docs.hanzo.ai/docs/openapi/ai/post-chat) | Implements the OpenAI-compatible chat completions API | | [`POST /v1/completions`](https://docs.hanzo.ai/docs/openapi/ai/post-completions) | Implements the OpenAI-compatible chat completions API | | [`POST /v1/decisions`](https://docs.hanzo.ai/docs/openapi/ai/post-decisions) | Implements POST /v1/decisions (the Decisions API). | | [`POST /v1/embeddings`](https://docs.hanzo.ai/docs/openapi/ai/post-embeddings) | Implements POST /v1/embeddings (OpenAI-compatible). | | [`POST /v1/images/generations`](https://docs.hanzo.ai/docs/openapi/ai/post-images-generations) | Implements POST /v1/images/generations (OpenAI-compatible). | | [`POST /v1/messages/count_tokens`](https://docs.hanzo.ai/docs/openapi/ai/post-messages-count-tokens) | Implements POST /v1/messages/count\_tokens. | | [`POST /v1/messages`](https://docs.hanzo.ai/docs/openapi/ai/post-messages) | Implements the Anthropic Messages API. | | [`GET /v1/models/{model}/access`](https://docs.hanzo.ai/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. | | [`POST /v1/models/{model}/access`](https://docs.hanzo.ai/docs/openapi/ai/post-models-by-model-access) | Records the caller's waitlist request for a gated model and answers their new standing. | | [`GET /v1/models/providers`](https://docs.hanzo.ai/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 /v1/models`](https://docs.hanzo.ai/docs/openapi/ai/get-models) | Returns the list of available models from the routing table. | | [`POST /v1/rerank`](https://docs.hanzo.ai/docs/openapi/ai/post-rerank) | Implements POST /v1/rerank (Cohere/Jina-compatible). | | [`POST /v1/responses`](https://docs.hanzo.ai/docs/openapi/ai/post-responses) | Implements POST /v1/responses. | | [`GET /v1/videos/{id}/content`](https://docs.hanzo.ai/docs/openapi/ai/get-videos-by-id-content) | Implements GET /v1/videos/{id}/content — download the finished MP4. | | [`GET /v1/videos/{id}`](https://docs.hanzo.ai/docs/openapi/ai/get-videos-by-id) | Implements GET /v1/videos/{id} — poll a job's status. | | [`POST /v1/videos/generations`](https://docs.hanzo.ai/docs/openapi/ai/post-videos-generations) | Implements POST /v1/videos/generations — the ASYNC create. | --- [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)