Cloud MCP
Tool catalogue
Every one of the 755 tools documented here, grouped by the product it calls.
This reference documents 755 tools from tools/list on https://api.hanzo.ai/v1/mcp, across 104 products, plus 12 the OpenAPI document does not describe. Every one has a page; every page is linked from here.
marketing
| Tool | Route | Description |
|---|---|---|
delete_v1_marketing_audiences_id | DELETE /v1/marketing/audiences/{id} | Removes one of the caller org's audiences and answers 204. |
delete_v1_marketing_calendar_id | DELETE /v1/marketing/calendar/{id} | Removes one of the caller org's posts and answers 204. |
delete_v1_marketing_campaigns_id | DELETE /v1/marketing/campaigns/{id} | Removes one of the caller org's campaigns and answers 204. |
delete_v1_marketing_suppressions | DELETE /v1/marketing/suppressions | Re-subscribes an address on one channel and answers 204. |
get_v1_marketing_audiences | GET /v1/marketing/audiences | Returns the org's saved audiences, most recently updated first. |
get_v1_marketing_audiences_id | GET /v1/marketing/audiences/{id} | Returns one of the caller org's saved audiences. |
get_v1_marketing_audiences_id_preview | GET /v1/marketing/audiences/{id}/preview | Evaluates the cohort LIVE — the same resolution an enrollment would run — and reports how big it is and how… |
get_v1_marketing_calendar | GET /v1/marketing/calendar | Returns the org's calendar, soonest scheduled first, optionally narrowed to one status. |
get_v1_marketing_calendar_id | GET /v1/marketing/calendar/{id} | Returns one of the caller org's posts, including the exact error behind a failed publish. |
get_v1_marketing_campaigns | GET /v1/marketing/campaigns | Returns the org's campaigns, most recently updated first, optionally narrowed to one lifecycle status. |
get_v1_marketing_campaigns_id | GET /v1/marketing/campaigns/{id} | Returns one of the caller org's campaigns. |
get_v1_marketing_promos | GET /v1/marketing/promos | Returns every promo the deployment offers with its live counters: how many orgs have redeemed it and how many… |
get_v1_marketing_promos_code_eligibility | GET /v1/marketing/promos/{code}/eligibility | Prices a promo against a plan and seat count. |
get_v1_marketing_promos_code_redemption | GET /v1/marketing/promos/{code}/redemption | Returns the caller org's OWN redemption of a promo — an org-scoped read, so it can never surface another… |
get_v1_marketing_sequences | GET /v1/marketing/sequences | Returns the org's drip sequences, most recently updated first. |
get_v1_marketing_sequences_id | GET /v1/marketing/sequences/{id} | Returns one of the caller org's sequences together with its steps in send order. |
get_v1_marketing_sequences_id_enrollments | GET /v1/marketing/sequences/{id}/enrollments | Returns who is walking one sequence, most recently enrolled first, with each walk's current step and next due… |
get_v1_marketing_sequences_id_steps | GET /v1/marketing/sequences/{id}/steps | Returns one sequence's steps in send order. |
get_v1_marketing_summary | GET /v1/marketing/summary | Rolls up the caller org's campaigns: how many there are, how many are active, and the summed budget and spend… |
get_v1_marketing_suppressions | GET /v1/marketing/suppressions | Returns the org's opt-out list, newest first — everyone the send gate will refuse to deliver to. |
get_v1_marketing_unsubscribe | GET /v1/marketing/unsubscribe | Is the PUBLIC one-click endpoint (no principal): a recipient clicks the signed link in an email footer. |
post_v1_marketing_audiences | POST /v1/marketing/audiences | Saves a cohort filter for the caller's org. Name is required. |
post_v1_marketing_calendar | POST /v1/marketing/calendar | Adds a post to the content calendar. Channel and body are required. |
post_v1_marketing_calendar_id_publish | POST /v1/marketing/calendar/{id}/publish | Publishes a post NOW, synchronously, whatever its schedule. |
post_v1_marketing_campaigns | POST /v1/marketing/campaigns | Registers a campaign in the caller's org. Name is required; channel defaults to email and status to draft,… |
post_v1_marketing_campaigns_id_schedule | POST /v1/marketing/campaigns/{id}/schedule | Sets a campaign's send time and moves it to "scheduled". |
post_v1_marketing_promos_code_redeem | POST /v1/marketing/promos/{code}/redeem | Redeems the promo for the caller's org, crediting the discount value to its wallet through the finance… |
post_v1_marketing_sequences | POST /v1/marketing/sequences | Registers a drip sequence in the caller's org. |
post_v1_marketing_sequences_id_enroll | POST /v1/marketing/sequences/{id}/enroll | Adds one contact or a whole audience to a sequence and schedules the first step for each. |
post_v1_marketing_sequences_id_enrollments_eid_cancel | POST /v1/marketing/sequences/{id}/enrollments/{eid}/cancel | Stops one walk mid-sequence and answers 204: no further step is sent, and steps already delivered are not… |
post_v1_marketing_sequences_id_status | POST /v1/marketing/sequences/{id}/status | Flips draft/active/archived — the activation gate for sending, since only an active sequence accepts… |
post_v1_marketing_sequences_id_steps | POST /v1/marketing/sequences/{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… |
post_v1_marketing_suppressions | POST /v1/marketing/suppressions | Records an opt-out for the org (admin / self-service management). |
put_v1_marketing_calendar_id | PUT /v1/marketing/calendar/{id} | Replaces a post's editable fields. It is a full write, not a patch, and it RESETS the lifecycle from the… |
put_v1_marketing_campaigns_id | PUT /v1/marketing/campaigns/{id} | Replaces a campaign's editable fields. It is a full write, not a patch: every field takes the value in the… |
cloudflare
| Tool | Route | Description |
|---|---|---|
delete_v1_cloudflare_d1_databases_database | DELETE /v1/cloudflare/d1/databases/{database} | D1DatabaseDelete deletes a D1 database and everything stored in it. |
delete_v1_cloudflare_kv_namespaces_namespace | DELETE /v1/cloudflare/kv/namespaces/{namespace} | KVNamespaceDelete deletes a Workers KV namespace and every key in it. |
delete_v1_cloudflare_kv_namespaces_namespace_values_key | DELETE /v1/cloudflare/kv/namespaces/{namespace}/values/{key} | KVValueDelete removes one key from a Workers KV namespace. |
delete_v1_cloudflare_pages_projects_project | DELETE /v1/cloudflare/pages/projects/{project} | PagesDelete deletes a Cloudflare Pages project, and with it every deployment it has ever made. |
delete_v1_cloudflare_pages_projects_project_domains_domain | DELETE /v1/cloudflare/pages/projects/{project}/domains/{domain} | PagesDomainDelete detaches a custom domain from a Cloudflare Pages project. |
delete_v1_cloudflare_r2_buckets_bucket | DELETE /v1/cloudflare/r2/buckets/{bucket} | R2BucketDelete deletes an R2 bucket. Requires org admin. |
delete_v1_cloudflare_workers_scripts_script | DELETE /v1/cloudflare/workers/scripts/{script} | WorkersScriptDelete removes a Worker script from the org's Cloudflare account. Requires org admin. |
delete_v1_cloudflare_workers_zones_zone_routes_route | DELETE /v1/cloudflare/workers/zones/{zone}/routes/{route} | WorkersRouteDelete unbinds a Worker route, so its pattern stops dispatching to a script. |
get_v1_cloudflare_d1_databases | GET /v1/cloudflare/d1/databases | D1DatabaseList lists the D1 databases on the org's Cloudflare account. |
get_v1_cloudflare_kv_namespaces | GET /v1/cloudflare/kv/namespaces | KVNamespaceList lists the Workers KV namespaces on the org's Cloudflare account. |
get_v1_cloudflare_pages_projects | GET /v1/cloudflare/pages/projects | PagesList lists the org's Cloudflare Pages projects. |
get_v1_cloudflare_pages_projects_project | GET /v1/cloudflare/pages/projects/{project} | PagesGet reads one Cloudflare Pages project — its build config, deployment configs and latest deployment. |
get_v1_cloudflare_r2_buckets | GET /v1/cloudflare/r2/buckets | R2BucketList lists the R2 buckets on the org's Cloudflare account. |
get_v1_cloudflare_workers_scripts | GET /v1/cloudflare/workers/scripts | WorkersScriptList lists the Worker scripts on the org's Cloudflare account. |
get_v1_cloudflare_workers_subdomain | GET /v1/cloudflare/workers/subdomain | WorkersSubdomainGet reads the org account's workers.dev subdomain — the name under which every… |
get_v1_cloudflare_workers_zones_zone_routes | GET /v1/cloudflare/workers/zones/{zone}/routes | WorkersRouteList lists the Worker routes bound within one zone — the URL patterns that dispatch to a script. |
get_v1_cloudflare_zones | GET /v1/cloudflare/zones | ZonesList lists the Cloudflare zones the org's connected API token can see, paged and filtered by the query… |
get_v1_cloudflare_zones_zone | GET /v1/cloudflare/zones/{zone} | ZoneGet reads one Cloudflare zone the org's token can see. Any org member may read. |
get_v1_cloudflare_zones_zone_analytics | GET /v1/cloudflare/zones/{zone}/analytics | ZoneAnalytics reads a zone's Cloudflare traffic dashboard — requests, bandwidth, threats and pageviews over… |
post_v1_cloudflare_d1_databases | POST /v1/cloudflare/d1/databases | D1DatabaseCreate creates a D1 database on the org's Cloudflare account. |
post_v1_cloudflare_kv_namespaces | POST /v1/cloudflare/kv/namespaces | KVNamespaceCreate creates a Workers KV namespace on the org's Cloudflare account. Requires org admin. |
post_v1_cloudflare_pages_projects | POST /v1/cloudflare/pages/projects | PagesCreate creates a Cloudflare Pages project on the org's account. Requires org admin. |
post_v1_cloudflare_pages_projects_project_domains | POST /v1/cloudflare/pages/projects/{project}/domains | PagesDomainAdd attaches a custom domain to a Cloudflare Pages project. Requires org admin. |
post_v1_cloudflare_r2_buckets | POST /v1/cloudflare/r2/buckets | R2BucketCreate creates an R2 bucket on the org's Cloudflare account. |
post_v1_cloudflare_workers_scripts_script_subdomain | POST /v1/cloudflare/workers/scripts/{script}/subdomain | WorkersScriptSubdomainSet publishes or withdraws one Worker script on the account's workers.dev subdomain. |
post_v1_cloudflare_workers_zones_zone_routes | POST /v1/cloudflare/workers/zones/{zone}/routes | WorkersRouteCreate binds a URL pattern in a zone to a Worker script. |
post_v1_cloudflare_zones_zone_purge | POST /v1/cloudflare/zones/{zone}/purge | ZonePurge drops a zone's Cloudflare edge cache — either the whole zone (purge_everything) or exactly the… |
agents
| Tool | Route | Description |
|---|---|---|
delete_v1_agents_ref | DELETE /v1/agents/{ref} | DeleteAgent removes an agent and every run recorded against it. |
delete_v1_agents_targets_id | DELETE /v1/agents/targets/{id} | DeleteTarget deregisters one machine. Only its owner, or an org admin, may remove it; an unknown id, a… |
get_v1_agents | GET /v1/agents | ListAgents returns every agent defined in the caller's org, each with the number of runs recorded against it. |
get_v1_agents_activity | GET /v1/agents/activity | AgentActivity serves the org-wide recent-activity feed. |
get_v1_agents_builds | GET /v1/agents/builds | ListBuilds returns the public index of every published build, most recently updated first, so a gallery can… |
get_v1_agents_builds_org_project | GET /v1/agents/builds/{org}/{project} | ReadBuild returns the readable build of one product: the agent session that produced it, turn by turn — the… |
get_v1_agents_metrics | GET /v1/agents/metrics | AgentMetrics serves the invocations-over-time histogram for the org's Agents dashboard. |
get_v1_agents_ref | GET /v1/agents/{ref} | GetAgent returns one agent with its system prompt and its 20 most recent runs. |
get_v1_agents_ref_runs | GET /v1/agents/{ref}/runs | ListAgentRuns returns one agent's execution history, newest first — each run's input, its output or its… |
get_v1_agents_sessions | GET /v1/agents/sessions | ListSessions returns the caller org's live sessions, newest first — each with its event count, its… |
get_v1_agents_sessions_id | GET /v1/agents/sessions/{id} | GetSession returns one session with its direct child sessions and its 50 most recent events, oldest of those… |
get_v1_agents_sessions_id_control | GET /v1/agents/sessions/{id}/control | DrainSessionControl returns the steering commands (pause/resume/stop/message) recorded against the caller's… |
get_v1_agents_sessions_id_tree | GET /v1/agents/sessions/{id}/tree | SessionTree returns the subagent-flow graph rooted at this session: the session, its children, their… |
get_v1_agents_targets | GET /v1/agents/targets | ListTargets returns every machine registered to the caller's org, newest first, each with its live session… |
get_v1_agents_targets_id | GET /v1/agents/targets/{id} | GetTarget returns one registered machine, with its live session load. |
patch_v1_agents_ref | PATCH /v1/agents/{ref} | UpdateAgent changes an agent in place. Every field is optional; a field the request omits keeps its stored… |
patch_v1_agents_sessions_id | PATCH /v1/agents/sessions/{id} | PatchSession updates a session's surface-owned truth: its status, its title, the run-target it is dispatched… |
patch_v1_agents_targets_id | PATCH /v1/agents/targets/{id} | PatchTarget updates one machine in place. Every field is optional; a field the request omits is left alone. |
post_v1_agents | POST /v1/agents | CreateAgent defines an agent in the caller's org: a model, a system prompt (instructions) and a set of tool… |
post_v1_agents_sessions | POST /v1/agents/sessions | RegisterSession opens a live agent session in the caller's org — the row every surface (the CLI's outer… |
post_v1_agents_targets | POST /v1/agents/targets | RegisterTarget registers a machine as an agent target, or re-links one that is already registered. |
post_v1_agents_targets_id_claim | POST /v1/agents/targets/{id}/claim | ClaimRoutedRun is the machine's long poll for work: it authenticates the daemon, stamps the liveness the… |
post_v1_agents_targets_id_key | POST /v1/agents/targets/{id}/key | MintTargetClaimKey mints (or rotates) the claim key a hanzo code --serve daemon presents to claim work for… |
post_v1_agents_targets_id_runs_runId_report | POST /v1/agents/targets/{id}/runs/{runId}/report | ReportRoutedRun completes a claimed run: it delivers the terminal result to the run's durable owner, which is… |
git
| Tool | Route | Description |
|---|---|---|
delete_v1_git_keys_id | DELETE /v1/git/keys/{id} | Removes a registered SSH key, scoped to the caller's org: an org can only delete its own, and a key id it… |
delete_v1_git_repos_name | DELETE /v1/git/repos/{name} | Removes a repo's metadata and purges its storage. Answers 204 with no body. |
delete_v1_git_repos_name_mirrors_id | DELETE /v1/git/repos/{name}/mirrors/{id} | Removes one outbound mirror target; later pushes stop being forwarded to it. Answers 204 with no body. |
delete_v1_git_repos_name_subscriptions_id | DELETE /v1/git/repos/{name}/subscriptions/{id} | Removes one Slack subscription from a repo; the notifier stops posting that repo's events to that channel. |
get_v1_git_keys | GET /v1/git/keys | Returns the SSH public keys registered to the caller's org — the keys that authenticate `git clone… |
get_v1_git_repos | GET /v1/git/repos | Returns the repos in the caller's scope, most recently updated first. |
get_v1_git_repos_name | GET /v1/git/repos/{name} | Returns one repo with its live ref state: every branch name and the resolved HEAD commit. |
get_v1_git_repos_name_blob | GET /v1/git/repos/{name}/blob | Returns one file's bytes at one revision. Text comes back verbatim, binary comes back base64, and a file past… |
get_v1_git_repos_name_commits | GET /v1/git/repos/{name}/commits | Walks a ref's history newest first, or one path's history when a path is given. |
get_v1_git_repos_name_files | GET /v1/git/repos/{name}/files | Returns every file a glob selects at one revision, WITH its bytes and the revision they came from. |
get_v1_git_repos_name_mirrors | GET /v1/git/repos/{name}/mirrors | Returns a repo's outbound mirror targets — the downstream remotes the mirror reactor pushes to whenever a… |
get_v1_git_repos_name_readme | GET /v1/git/repos/{name}/readme | Returns the README at the tree root as plain text — unrendered, so the caller decides how to present it. |
get_v1_git_repos_name_refs | GET /v1/git/repos/{name}/refs | Lists a repo's branches, tags and default branch — what a branch picker needs in one call. |
get_v1_git_repos_name_subscriptions | GET /v1/git/repos/{name}/subscriptions | Returns a repo's Slack subscriptions — which channels the lifecycle notifier posts this repo's push and… |
get_v1_git_repos_name_tree | GET /v1/git/repos/{name}/tree | Lists the immediate children of one directory at one revision, directories before files. |
get_v1_git_usage | GET /v1/git/usage | Returns per-repo and total storage bytes for the caller's org — the queryable, per-tenant number commerce and… |
patch_v1_git_repos_name | PATCH /v1/git/repos/{name} | Flips a repo's public bit, the one mutable repo setting today. |
post_v1_git_keys | POST /v1/git/keys | Registers an SSH public key so it can authenticate git clone git@<host>:<org>/<repo>.git for the caller's… |
post_v1_git_repos | POST /v1/git/repos | Provisions an empty bare repository in the caller's scope and returns it with its clone URLs. Answers 201. |
post_v1_git_repos_name_gc | POST /v1/git/repos/{name}/gc | Repacks a repo into one bitmapped pack and rewrites its commit-graph, so the next clone reuses the bitmap… |
post_v1_git_repos_name_mirror | POST /v1/git/repos/{name}/mirror | Imports an external git repository into the caller's repo, provisioning it on first use. |
post_v1_git_repos_name_mirrors | POST /v1/git/repos/{name}/mirrors | Registers a downstream remote the repo's advanced refs are pushed to whenever a push lands here. Answers 201. |
post_v1_git_repos_name_push | POST /v1/git/repos/{name}/push | Lands a set of files as one commit without a git client — the hanzo.app builder's push. |
post_v1_git_repos_name_subscriptions | POST /v1/git/repos/{name}/subscriptions | Binds a Slack channel to a repo, so the lifecycle notifier posts that repo's push and deploy events there. |
pricing
| Tool | Route | Description |
|---|---|---|
get_v1_pricing | GET /v1/pricing | GetPricing returns the whole pricing catalog in one document: Zen and third-party models, providers, model… |
get_v1_pricing_base | GET /v1/pricing/base | ListBasePlans returns the Hanzo Base plans — the managed-instance tiers, each with its monthly and annual… |
get_v1_pricing_blockchain | GET /v1/pricing/blockchain | ListBlockchainPlans returns the blockchain access plans — the RPC and node tiers, each with its monthly… |
get_v1_pricing_cloud | GET /v1/pricing/cloud | GetCloudPricing returns the public cloud section of the catalog in one document: its instance plans, its… |
get_v1_pricing_cloud_plans | GET /v1/pricing/cloud/plans | GetCloudPlans returns just the cloud instance plans — each with its vCPU, memory, disk, CPU type, VM… |
get_v1_pricing_cloud_regions | GET /v1/pricing/cloud/regions | GetCloudRegions returns the regions a cloud instance can be placed in, each with its id, display name and… |
get_v1_pricing_cloud_storage | GET /v1/pricing/cloud/storage | GetCloudStoragePricing returns the block-storage prices of the cloud section: the per-GB monthly rate and the… |
get_v1_pricing_compute | GET /v1/pricing/compute | GetComputePricing returns the compute section of the catalog: the cloud provider and region the prices are… |
get_v1_pricing_compute_presets | GET /v1/pricing/compute/presets | GetComputePresets returns just the named compute sizes — the short, human-labelled list ("Starter", "Pro") a… |
get_v1_pricing_featured | GET /v1/pricing/featured | ListFeaturedModels returns the models the catalog highlights, filtered to what the caller's org may see. |
get_v1_pricing_free | GET /v1/pricing/free | ListFreeModels returns the models that cost nothing to call, filtered to what the caller's org may see. |
get_v1_pricing_gpu | GET /v1/pricing/gpu | ListGPUTiers returns the rentable GPU configurations, each with its accelerator count and model, VRAM, vCPU,… |
get_v1_pricing_health | GET /v1/pricing/health | Health reports that the pricing subsystem is mounted and serving. |
get_v1_pricing_iam | GET /v1/pricing/iam | ListIAMPlans returns the identity plans — the Hanzo IAM tiers, each with its monthly and annual price,… |
get_v1_pricing_model_name | GET /v1/pricing/model/{name} | GetModel returns one model's catalog entry — its pricing, context window and capabilities as the pricing… |
get_v1_pricing_models | GET /v1/pricing/models | ListModels returns the whole model catalog — Hanzo's own Zen models and every third-party model — filtered to… |
get_v1_pricing_paas | GET /v1/pricing/paas | ListPaaSPlans returns the application-hosting plans — the deploy-and-host tiers, each with its monthly and… |
get_v1_pricing_policy | GET /v1/pricing/policy | GetPricingPolicy returns the pricing policy document: the revenue-sharing terms (the idle-resale share and… |
get_v1_pricing_providers | GET /v1/pricing/providers | ListProviders returns the model providers the catalog knows, each with its info object, filtered to what the… |
get_v1_pricing_subscriptions | GET /v1/pricing/subscriptions | ListSubscriptionPlans returns the API subscription plans — the account-level tiers a customer subscribes to,… |
get_v1_pricing_summary | GET /v1/pricing/summary | GetPricingSummary returns the catalog's headline statistics — model counts by family and the provider… |
get_v1_pricing_tools | GET /v1/pricing/tools | ListToolPrices returns the per-use tool prices — web search, code interpreter, file storage, image… |
post_v1_pricing_sync | POST /v1/pricing/sync | SyncPricing refreshes the third-party section of the catalog from its upstream listings and returns the time… |
books
| Tool | Route | Description |
|---|---|---|
get_v1_books_accounts | GET /v1/books/accounts | ListAccounts returns the org's chart of accounts — the seeded fixed chart every posting key in the ledger… |
get_v1_books_bank_transactions | GET /v1/books/bank/transactions | ListBankTransactions returns the org's normalized bank transactions, newest first — every row the import and… |
get_v1_books_bank_unreconciled | GET /v1/books/bank/unreconciled | ListUnreconciled returns the org's unmatched bank inflows and their open clarifying questions — the queue a… |
get_v1_books_export | GET /v1/books/export | ExportPackage returns the complete financial package for the caller's org over (from, to]: the trial balance,… |
get_v1_books_gl | GET /v1/books/gl | ListGL returns the org's most recent GL Entry rows, newest first. |
get_v1_books_inbox | GET /v1/books/inbox | ListInbox returns the org's open document queue — everything uploaded but not yet booked, newest first, each… |
get_v1_books_metrics | GET /v1/books/metrics | Metrics returns the org's deterministic SaaS-metrics snapshot over an optional (from, to] window — MRR, ARR,… |
get_v1_books_pnl | GET /v1/books/pnl | ProfitAndLoss returns the org's accrual-basis Profit & Loss over an optional (from, to] window of RFC3339… |
get_v1_books_position | GET /v1/books/position | BalanceSheet returns the org's Balance Sheet as of to (empty = all time), with the Assets == Liabilities +… |
get_v1_books_questions | GET /v1/books/questions | ListQuestions returns the clarifying questions the caller's own recent GL raises — the unusual postings a… |
get_v1_books_rules | GET /v1/books/rules | ListRules returns the org's auto-categorization rules, highest priority first. |
get_v1_books_transactions | GET /v1/books/transactions | ListTransactions returns the org's booked ledger as a single-line register, newest first: one row per… |
get_v1_books_trial | GET /v1/books/trial | TrialBalance returns the org's trial balance over an optional [from, to] window of RFC3339 posting times,… |
get_v1_books_vendors | GET /v1/books/vendors | ListVendors returns the org's vendor book: each canonical vendor, the alias spellings a receipt may print it… |
post_v1_books_ask | POST /v1/books/ask | AskBooks answers a plain-language question about the caller's own books — "what is my MRR?", "how long is my… |
post_v1_books_bank_sync | POST /v1/books/bank/sync | SyncBank pulls every connected bank (Plaid/Teller) for the caller's org, maps each fetched transaction to a… |
post_v1_books_rules | POST /v1/books/rules | UpsertRule creates or updates one auto-categorization rule, keyed by its pattern — writing a pattern that… |
post_v1_books_scan_book | POST /v1/books/scan/book | BookScan posts a reviewed scanned bill to the ledger. |
post_v1_books_sync | POST /v1/books/sync | Sync ingests the caller's OWN org from commerce into BOTH ledgers (live and sandbox) and reports how many new… |
post_v1_books_vendors | POST /v1/books/vendors | UpsertVendor creates or updates one vendor in the org's vendor book, keyed by its canonical name — writing a… |
captable
| Tool | Route | Description |
|---|---|---|
delete_v1_captable_convertibles_id | DELETE /v1/captable/convertibles/{id} | DeleteConvertible removes one of the caller org's convertible notes, taking its principal out of the cap… |
delete_v1_captable_options_id | DELETE /v1/captable/options/{id} | DeleteOption removes one of the caller org's option grants, taking its shares out of the cap table's… |
delete_v1_captable_safes_id | DELETE /v1/captable/safes/{id} | DeleteSafe removes one of the caller org's SAFEs, taking its capital out of the cap table's… |
delete_v1_captable_shares_id | DELETE /v1/captable/shares/{id} | DeleteShare removes one of the caller org's share certificates, taking its shares out of the cap table's… |
delete_v1_captable_stakeholders_id | DELETE /v1/captable/stakeholders/{id} | DeleteStakeholder removes one of the caller org's stakeholders. |
get_v1_captable_classes | GET /v1/captable/classes | ListShareClasses returns the caller org's share classes, in creation order. |
get_v1_captable_company | GET /v1/captable/company | GetCompany returns the caller org's cap-table company record. |
get_v1_captable_convertibles | GET /v1/captable/convertibles | ListConvertibles returns the caller org's convertible notes, newest first. |
get_v1_captable_investments | GET /v1/captable/investments | ListInvestments returns the caller org's investments, newest first. |
get_v1_captable_options | GET /v1/captable/options | ListOptions returns the caller org's option grants, newest first. |
get_v1_captable_plans | GET /v1/captable/plans | ListEquityPlans returns the caller org's equity plans, newest first. |
get_v1_captable_rounds | GET /v1/captable/rounds | ListRounds returns the caller org's fundraising rounds, newest first. |
get_v1_captable_rounds_id | GET /v1/captable/rounds/{id} | GetRound returns one of the caller org's fundraising rounds together with every investment written into it,… |
get_v1_captable_safes | GET /v1/captable/safes | ListSafes returns the caller org's SAFEs, newest first. |
get_v1_captable_shares | GET /v1/captable/shares | ListShares returns the caller org's share certificates, newest first. |
get_v1_captable_stakeholders | GET /v1/captable/stakeholders | ListStakeholders returns the caller org's stakeholders, newest first. |
get_v1_captable_summary | GET /v1/captable/summary | GetSummary computes the caller org's cap table. |
patch_v1_captable_stakeholders_id | PATCH /v1/captable/stakeholders/{id} | UpdateStakeholder changes one of the caller org's stakeholders. |
post_v1_captable_rounds_id_close | POST /v1/captable/rounds/{id}/close | CloseRound closes one of the caller org's fundraising rounds, recording the close date and moving its status… |
put_v1_captable_company | PUT /v1/captable/company | UpdateCompany sets the caller org's company name and incorporation details. |
company
| Tool | Route | Description |
|---|---|---|
get_v1_company | GET /v1/company | Get returns the caller org's formation and the stages reachable from it, or 404 when the org has not begun… |
get_v1_company_register | GET /v1/company/register | ListRegister returns the platform's whole formation register, newest activity first — every org's formation,… |
get_v1_company_register_summary | GET /v1/company/register/summary | SummarizeRegister counts the platform's formations by stage — the register's shape in one read, so a queue… |
get_v1_company_review | GET /v1/company/review | ReviewQueue reports the founders whose KYC is not yet settled, oldest formation first, so the queue drains in… |
post_v1_company | POST /v1/company | Begin starts the org's one formation and returns it with the stages reachable from it. |
post_v1_company_advance | POST /v1/company/advance | Advance runs the ONE guarded transition of the formation machine. |
post_v1_company_documents | POST /v1/company/documents | GenerateDocuments renders the formation documents for the chosen structure and jurisdiction, ingests each… |
post_v1_company_esign | POST /v1/company/esign | RequestEsign sends the generated formation documents for signature by every founder and records the… |
post_v1_company_esign_complete | POST /v1/company/esign/complete | CompleteEsign records whether the formation documents have been signed. |
post_v1_company_founders | POST /v1/company/founders | SetFounders replaces the formation's founders. |
post_v1_company_fundraise_round | POST /v1/company/fundraise/round | RecordRound records a fundraising round on the org's canonical cap table. |
post_v1_company_fundraise_safe | POST /v1/company/fundraise/safe | RequestSafe raises an e-signature request over documents already in the org's data room — a SAFE, a… |
post_v1_company_genesis | POST /v1/company/genesis | RecordGenesis seeds the canonical cap table with the founding allocation (stakeholders, a common share class,… |
post_v1_company_import_captable | POST /v1/company/import/captable | ImportCapTable reads an existing company's cap table from a Google Sheet and adds its stakeholders to the… |
post_v1_company_import_documents | POST /v1/company/import/documents | ImportDocuments ingests an existing company's corporate documents from a Google Drive folder into the org's… |
post_v1_company_kyc | POST /v1/company/kyc | StartKYC opens an identity-verification session for every founder with the wired provider and records each… |
post_v1_company_kyc_decision | POST /v1/company/kyc/decision | DecideKYC records a privileged reviewer's MANUAL decision on a founder's KYC — the human-in-the-loop path,… |
post_v1_company_kyc_refresh | POST /v1/company/kyc/refresh | RefreshKYC reconciles each pending founder's KYC with the WIRED provider — the PULL path to a… |
post_v1_company_skip | POST /v1/company/skip | Skip marks the org as already incorporated and moves it onto the import path, so an existing company brings… |
put_v1_company_structure | PUT /v1/company/structure | SetStructure records the entity kind, the state of formation and the proposed name. |
crm
| Tool | Route | Description |
|---|---|---|
delete_v1_crm_companies_id | DELETE /v1/crm/companies/{id} | DeleteCompany removes one of the caller org's companies and answers 204. |
delete_v1_crm_contacts_id | DELETE /v1/crm/contacts/{id} | DeleteContact removes one of the caller org's contacts and answers 204. |
delete_v1_crm_opportunities_id | DELETE /v1/crm/opportunities/{id} | DeleteOpportunity removes one of the caller org's deals and answers 204. |
get_v1_crm_applications | GET /v1/crm/applications | ListApplications returns the org's Startup Program applications, newest first. |
get_v1_crm_applications_id | GET /v1/crm/applications/{id} | GetApplication returns one Startup Program application with its AI screen and stage history. |
get_v1_crm_companies | GET /v1/crm/companies | ListCompanies returns the caller org's companies, most recently updated first. |
get_v1_crm_companies_id | GET /v1/crm/companies/{id} | GetCompany returns one of the caller org's companies. |
get_v1_crm_contacts | GET /v1/crm/contacts | ListContacts returns the caller org's contacts, most recently updated first. |
get_v1_crm_contacts_id | GET /v1/crm/contacts/{id} | GetContact returns one of the caller org's contacts. |
get_v1_crm_opportunities | GET /v1/crm/opportunities | ListOpportunities returns the caller org's deals, most recently updated first. |
get_v1_crm_opportunities_id | GET /v1/crm/opportunities/{id} | GetOpportunity returns one of the caller org's deals. |
get_v1_crm_summary | GET /v1/crm/summary | Summary counts the caller org's CRM records: companies, contacts, opportunities. |
patch_v1_crm_applications_id | PATCH /v1/crm/applications/{id} | PatchApplication moves one Startup Program application through the pipeline. |
post_v1_crm_companies | POST /v1/crm/companies | CreateCompany adds a company to the caller's org and answers 201 with the stored record. |
post_v1_crm_contacts | POST /v1/crm/contacts | CreateContact adds a person to the caller's org and answers 201 with the stored record. |
post_v1_crm_opportunities | POST /v1/crm/opportunities | CreateOpportunity adds a deal to the caller's org and answers 201 with the stored record. |
put_v1_crm_companies_id | PUT /v1/crm/companies/{id} | UpdateCompany replaces one of the caller org's companies. |
put_v1_crm_contacts_id | PUT /v1/crm/contacts/{id} | UpdateContact replaces one of the caller org's contacts. |
put_v1_crm_opportunities_id | PUT /v1/crm/opportunities/{id} | UpdateOpportunity replaces one of the caller org's deals. |
ingress
| Tool | Route | Description |
|---|---|---|
delete_v1_ingress_middlewares_id | DELETE /v1/ingress/middlewares/{id} | DeleteMiddleware removes one of the caller org's edge transforms and hot-applies the change. |
delete_v1_ingress_routes_id | DELETE /v1/ingress/routes/{id} | DeleteRoute removes one of the caller org's routing rules and hot-applies the shrunken table, freeing its… |
delete_v1_ingress_services_id | DELETE /v1/ingress/services/{id} | DeleteService removes one of the caller org's backend pools and hot-applies the change. |
get_v1_ingress_middlewares | GET /v1/ingress/middlewares | ListMiddlewares returns every edge transform the caller's org has configured, ordered by id. |
get_v1_ingress_middlewares_id | GET /v1/ingress/middlewares/{id} | GetMiddleware returns one of the caller org's edge transforms by id. |
get_v1_ingress_routes | GET /v1/ingress/routes | ListRoutes returns every routing rule the caller's org has configured, ordered by id. |
get_v1_ingress_routes_id | GET /v1/ingress/routes/{id} | GetRoute returns one of the caller org's routing rules by id. |
get_v1_ingress_services | GET /v1/ingress/services | ListServices returns every backend pool the caller's org has configured, ordered by id. |
get_v1_ingress_services_id | GET /v1/ingress/services/{id} | GetService returns one of the caller org's backend pools by id. |
get_v1_ingress_status | GET /v1/ingress/status | Status reports the ingress edge's live posture: the role this instance runs in (app or edge), whether its… |
get_v1_ingress_tls | GET /v1/ingress/tls | GetTLS returns the caller org's ACME intent together with the edge-wide TLS facts it lands in: which role… |
post_v1_ingress_middlewares | POST /v1/ingress/middlewares | PutMiddleware creates or replaces one edge transform and hot-applies it. |
post_v1_ingress_routes | POST /v1/ingress/routes | PutRoute creates or replaces one routing rule and hot-applies the new table — there is no config file and no… |
post_v1_ingress_services | POST /v1/ingress/services | PutService creates or replaces one backend pool and hot-applies it. |
put_v1_ingress_middlewares_id | PUT /v1/ingress/middlewares/{id} | PutMiddleware creates or replaces one edge transform and hot-applies it. |
put_v1_ingress_routes_id | PUT /v1/ingress/routes/{id} | PutRoute creates or replaces one routing rule and hot-applies the new table — there is no config file and no… |
put_v1_ingress_services_id | PUT /v1/ingress/services/{id} | PutService creates or replaces one backend pool and hot-applies it. |
put_v1_ingress_tls | PUT /v1/ingress/tls | PutTLS replaces the caller org's ACME intent and hot-applies what can be hot-applied. |
pubsub
| Tool | Route | Description |
|---|---|---|
delete_v1_pubsub_jetstream_streams_stream | DELETE /v1/pubsub/jetstream/streams/{stream} | DeleteStream removes one stream of the caller's org — its retained messages and its consumers with it — and… |
delete_v1_pubsub_jetstream_streams_stream_consumers_name | DELETE /v1/pubsub/jetstream/streams/{stream}/consumers/{name} | DeleteConsumer removes one consumer — its cursor, not the stream's messages — and answers 204 with no body. |
delete_v1_pubsub_kv_bucket | DELETE /v1/pubsub/kv/{bucket} | DeleteBucket removes one bucket of the caller's org — every key and every revision with it — and answers 204… |
delete_v1_pubsub_kv_bucket_key | DELETE /v1/pubsub/kv/{bucket}/{key} | Delete removes one key — a delete marker in the key's history, so watchers see it and Get answers 404 — and… |
get_v1_pubsub_jetstream_streams | GET /v1/pubsub/jetstream/streams | ListStreams returns the org's streams, sorted by name. |
get_v1_pubsub_jetstream_streams_stream | GET /v1/pubsub/jetstream/streams/{stream} | GetStream returns one stream of the caller's org — its configuration and its live state (messages, bytes,… |
get_v1_pubsub_jetstream_streams_stream_consumers | GET /v1/pubsub/jetstream/streams/{stream}/consumers | ListConsumers returns one stream's consumers, sorted by name. |
get_v1_pubsub_jetstream_streams_stream_consumers_name | GET /v1/pubsub/jetstream/streams/{stream}/consumers/{name} | GetConsumer returns one consumer of one org stream — its configuration and its cursor: delivered and… |
get_v1_pubsub_kv_bucket_key | GET /v1/pubsub/kv/{bucket}/{key} | Get returns one key's current value and revision. |
get_v1_pubsub_kv_bucket_key_history | GET /v1/pubsub/kv/{bucket}/{key}/history | History returns one key's retained revisions, oldest first — every put and every delete marker up to the… |
post_v1_pubsub_jetstream_streams | POST /v1/pubsub/jetstream/streams | CreateStream creates a durable stream capturing the given subjects and returns it. |
post_v1_pubsub_jetstream_streams_stream_consumers | POST /v1/pubsub/jetstream/streams/{stream}/consumers | CreateConsumer creates a durable consumer on one stream and returns it. |
post_v1_pubsub_jetstream_streams_stream_consumers_name_next | POST /v1/pubsub/jetstream/streams/{stream}/consumers/{name}/next | Fetch pulls the next batch from a consumer and acknowledges it — the request/response way to consume a… |
post_v1_pubsub_kv_bucket | POST /v1/pubsub/kv/{bucket} | CreateBucket creates a KV bucket and returns it. |
post_v1_pubsub_publish | POST /v1/pubsub/publish | Publish puts one message on the org's bus. |
post_v1_pubsub_request | POST /v1/pubsub/request | Request sends one request on the org's bus and waits for one reply — the synchronous half of pub/sub, for… |
put_v1_pubsub_jetstream_streams_stream | PUT /v1/pubsub/jetstream/streams/{stream} | UpdateStream rewrites a stream's configuration — subjects, limits, discard — and returns the updated stream. |
put_v1_pubsub_kv_bucket_key | PUT /v1/pubsub/kv/{bucket}/{key} | Put sets one key to one value and returns the revision the write created. |
framework
| Tool | Route | Description |
|---|---|---|
delete_v1_framework_doctype_name | DELETE /v1/framework/{doctype}/{name} | Removes one document, after its on_trash hooks agree. |
delete_v1_framework_doctypes_name | DELETE /v1/framework/doctypes/{name} | Removes a DocType and every document stored under it. |
delete_v1_framework_roles_user_role | DELETE /v1/framework/roles/{user}/{role} | Removes one (user, role) grant in the caller's org. Manager-only. |
get_v1_framework_doctype | GET /v1/framework/{doctype} | Returns the caller org's documents of one DocType, filtered, ordered and projected by the query. |
get_v1_framework_doctype_name | GET /v1/framework/{doctype}/{name} | Returns one document by name, with Password fields redacted. |
get_v1_framework_doctypes | GET /v1/framework/doctypes | Returns every DocType defined in the caller's org. |
get_v1_framework_doctypes_name | GET /v1/framework/doctypes/{name} | Returns one DocType definition — its fields, naming rule, permissions and lifecycle flags. |
get_v1_framework_modules | GET /v1/framework/modules | Returns every app lane compiled into this deployment and the DocTypes each one installs. |
get_v1_framework_modules_module | GET /v1/framework/modules/{module} | Returns one app lane's install state for the caller's org: the DocTypes the lane declares, and which of them… |
get_v1_framework_roles | GET /v1/framework/roles | Returns every (user, role) assignment in the caller's org. |
get_v1_framework_summary | GET /v1/framework/summary | Reports how much of the DocType surface the caller's org uses: how many DocTypes it has defined, and how many… |
post_v1_framework_doctype_name_cancel | POST /v1/framework/{doctype}/{name}/cancel | Moves a submitted document to cancelled (docstatus 1 → 2) after its on_cancel hooks agree. |
post_v1_framework_doctype_name_submit | POST /v1/framework/{doctype}/{name}/submit | Moves a draft to submitted (docstatus 0 → 1) after its on_submit hooks agree. |
post_v1_framework_doctypes | POST /v1/framework/doctypes | Defines a DocType in the caller's org: the metadata that gives a document surface its fields, its naming… |
post_v1_framework_modules_module_install | POST /v1/framework/modules/{module}/install | Creates an app lane's DocTypes in the caller's org. |
post_v1_framework_roles | POST /v1/framework/roles | Grants one user one role in the caller's org — how a member gains rights on a DocType, since permissions name… |
put_v1_framework_doctypes_name | PUT /v1/framework/doctypes/{name} | Replaces a DocType definition wholesale (PUT semantics): the stored definition becomes the body. |
compliance
| Tool | Route | Description |
|---|---|---|
get_v1_compliance_accreditation | GET /v1/compliance/accreditation | ListAccreditation returns the org's tracked accreditation-state records, newest first — evidence entries the… |
get_v1_compliance_accreditation_id | GET /v1/compliance/accreditation/{id} | GetAccreditation returns one tracked accreditation record. |
get_v1_compliance_audit | GET /v1/compliance/audit | AuditRead is the compliance-scoped read of the SHARED tamper-evident audit plane — the SOC 2 posture surface… |
get_v1_compliance_health | GET /v1/compliance/health | Health reports subsystem liveness and the wired verification provider. |
get_v1_compliance_records | GET /v1/compliance/records | ListRecords is the unified compliance-record view for the org: its verifications and accreditation records… |
get_v1_compliance_status | GET /v1/compliance/status | Status is the org's honest posture read: the wired provider and the per-status tally of its verifications. |
get_v1_compliance_subjects | GET /v1/compliance/subjects | ListSubjects returns the org's subjects as PII-MINIMIZED summaries — no name or email, only whether an email… |
get_v1_compliance_subjects_id | GET /v1/compliance/subjects/{id} | GetSubject returns one subject WITH its contact PII — the only surface that returns it, and only to the… |
get_v1_compliance_verifications | GET /v1/compliance/verifications | ListVerifications returns the org's KYC/KYB verifications, newest first — opaque subject references and… |
get_v1_compliance_verifications_id | GET /v1/compliance/verifications/{id} | GetVerification returns one verification — its opaque subject reference and provider-reported status, no… |
post_v1_compliance_accreditation | POST /v1/compliance/accreditation | CreateAccreditation records an ASSERTED accreditation state for a subject — the subject's own assertion, with… |
post_v1_compliance_accreditation_id_decision | POST /v1/compliance/accreditation/{id}/decision | DecideAccreditation records an org reviewer's decision on an accreditation record — a reviewer confirmation,… |
post_v1_compliance_subjects | POST /v1/compliance/subjects | CreateSubject records a party the org is verifying as part of its own onboarding/compliance — a team member,… |
post_v1_compliance_verifications | POST /v1/compliance/verifications | StartVerification begins a KYC/KYB verification of a subject through the wired provider — an existing subject… |
post_v1_compliance_verifications_id_decision | POST /v1/compliance/verifications/{id}/decision | DecideVerification records a privileged reviewer's MANUAL decision on a verification — the human-in-the-loop… |
post_v1_compliance_verifications_id_refresh | POST /v1/compliance/verifications/{id}/refresh | RefreshVerification polls the wired provider for its current decision and records it, ATTRIBUTED to the… |
platform
| Tool | Route | Description |
|---|---|---|
delete_v1_platform_sites_slug | DELETE /v1/platform/sites/{slug} | DeleteProject deletes a project and takes its site off the internet. |
delete_v1_platform_sites_slug_domains_host | DELETE /v1/platform/sites/{slug}/domains/{host} | ReleaseDomain gives a custom hostname back, so the name is free to reuse. |
get_v1_platform_sites | GET /v1/platform/sites | ListProjects returns every project your org owns. |
get_v1_platform_sites_slug | GET /v1/platform/sites/{slug} | GetProject returns one project of yours by slug — its settings, its live URL and the deployment currently… |
get_v1_platform_sites_slug_deployments | GET /v1/platform/sites/{slug}/deployments | ListDeployments returns a project's deploy history, newest version first. |
get_v1_platform_sites_slug_deployments_id | GET /v1/platform/sites/{slug}/deployments/{id} | GetDeployment returns one deployment of a project by id. |
get_v1_platform_sites_slug_domains | GET /v1/platform/sites/{slug}/domains | ListDomains returns every custom hostname this site holds: the live ones, plus any pending claim with the DNS… |
get_v1_platform_sites_slug_releases | GET /v1/platform/sites/{slug}/releases | ListReleases returns a site's releases newest-first, marking the active one — the rollback menu. |
patch_v1_platform_sites_slug | PATCH /v1/platform/sites/{slug} | UpdateProject changes a project's settings, and only the settings you send. |
post_v1_platform_sites | POST /v1/platform/sites | CreateProject creates a project — the handle a site is deployed and served under — and answers 201 with it in… |
post_v1_platform_sites_slug_domains | POST /v1/platform/sites/{slug}/domains | BindDomains attaches one or more CUSTOM public hostnames to this org's site. |
post_v1_platform_sites_slug_domains_host_verify | POST /v1/platform/sites/{slug}/domains/{host}/verify | VerifyDomain checks the DNS challenge for a pending custom hostname and, when it passes, promotes the host so… |
post_v1_platform_sites_slug_publish | POST /v1/platform/sites/{slug}/publish | PublishSite promotes a build output into a new release AND goes live with it — create+activate in one call,… |
post_v1_platform_sites_slug_purge | POST /v1/platform/sites/{slug}/purge | PurgeProject flushes the site's edge cache without redeploying anything. |
post_v1_platform_sites_slug_releases | POST /v1/platform/sites/{slug}/releases | CreateRelease promotes a build output into a new immutable release WITHOUT serving it — the staged half of… |
post_v1_platform_sites_slug_releases_release_activate | POST /v1/platform/sites/{slug}/releases/{release}/activate | ActivateRelease points the site at an existing release — the go-live, and equally the ROLLBACK. |
automations
| Tool | Route | Description |
|---|---|---|
delete_v1_automations_flows_id | DELETE /v1/automations/flows/{id} | DeleteFlow deletes one automation, its versions and its run history. |
get_v1_automations_connectors | GET /v1/automations/connectors | Connectors returns the connector catalogue. |
get_v1_automations_flows | GET /v1/automations/flows | ListFlows returns the caller org's automations, most-recently-updated first. |
get_v1_automations_flows_id | GET /v1/automations/flows/{id} | GetFlow returns one automation and its latest version. |
get_v1_automations_flows_id_versions | GET /v1/automations/flows/{id}/versions | ListVersions returns one flow's versions, newest first. |
get_v1_automations_pieces | GET /v1/automations/pieces | Pieces is the retired-name alias of the connector catalogue. |
get_v1_automations_runs | GET /v1/automations/runs | ListRuns returns the caller org's run history, newest first. |
get_v1_automations_runs_id | GET /v1/automations/runs/{id} | GetRun returns one run. A run that has not reached a terminal status is refreshed from the durable engine… |
patch_v1_automations_flows_id | PATCH /v1/automations/flows/{id} | UpdateFlow updates one automation's metadata in place. |
post_v1_automations_connectors_id_run | POST /v1/automations/connectors/{id}/run | Run executes one connector action in-process and answers the outcome. |
post_v1_automations_flows | POST /v1/automations/flows | CreateFlow creates an automation and its initial DRAFT version in one call. |
post_v1_automations_flows_id_disable | POST /v1/automations/flows/{id}/disable | DisableFlow disarms a flow's trigger and marks it DISABLED. |
post_v1_automations_flows_id_enable | POST /v1/automations/flows/{id}/enable | EnableFlow arms a flow's trigger and marks it ENABLED. |
post_v1_automations_flows_id_run | POST /v1/automations/flows/{id}/run | RunFlow starts one durable run of a flow now. |
post_v1_automations_flows_id_versions | POST /v1/automations/flows/{id}/versions | CreateVersion adds a new DRAFT version to a flow. |
mq
| Tool | Route | Description |
|---|---|---|
delete_v1_mq_streams_name | DELETE /v1/mq/streams/{name} | Removes a stream with all its messages and consumers. |
delete_v1_mq_streams_name_messages_seq | DELETE /v1/mq/streams/{name}/messages/{seq} | Erases one message by sequence; the sequence gap remains. |
delete_v1_mq_streams_stream_consumers_name | DELETE /v1/mq/streams/{stream}/consumers/{name} | Removes a consumer and its delivery state; unacknowledged messages stay in the stream. |
get_v1_mq_health | GET /v1/mq/health | Reports whether the message plane behind this surface answers. |
get_v1_mq_info | GET /v1/mq/info | Returns the broker's identity and the org's stream count. |
get_v1_mq_streams | GET /v1/mq/streams | Returns the org's streams, name-ordered, with their live state. |
get_v1_mq_streams_name | GET /v1/mq/streams/{name} | Returns one stream's configuration and live state. |
get_v1_mq_streams_name_messages | GET /v1/mq/streams/{name}/messages | Reads stored messages without a consumer: by sequence, by newest on a subject, or walking a subject forward… |
get_v1_mq_streams_stream_consumers | GET /v1/mq/streams/{stream}/consumers | Returns a stream's consumers, name-ordered, with delivery state. |
get_v1_mq_streams_stream_consumers_name | GET /v1/mq/streams/{stream}/consumers/{name} | Returns one consumer's configuration and delivery state. |
post_v1_mq_streams | POST /v1/mq/streams | Creates a durable stream in the org's namespace and returns it. |
post_v1_mq_streams_name_purge | POST /v1/mq/streams/{name}/purge | Removes messages from a stream, leaving its consumers in place. |
post_v1_mq_streams_stream_consumers | POST /v1/mq/streams/{stream}/consumers | Creates a durable pull consumer on a stream and returns it. |
post_v1_mq_streams_stream_consumers_name_next | POST /v1/mq/streams/{stream}/consumers/{name}/next | Pulls the consumer's next batch. Delivered messages are acknowledged on delivery — the broker will not… |
put_v1_mq_streams_name | PUT /v1/mq/streams/{name} | Reconfigures an existing stream; the path names the stream, and the immutable fields (storage, retention)… |
plans
| Tool | Route | Description |
|---|---|---|
get_v1_plans | GET /v1/plans | ListCloudPlans returns the Hanzo cloud plan catalog: every cloud tier with its price, included capacity,… |
get_v1_plans_blockchain | GET /v1/plans/blockchain | ListBlockchainPlans returns the blockchain RPC plan catalog: the tiers metered in monthly compute units, with… |
get_v1_plans_cloud | GET /v1/plans/cloud | ListCloudCapacityPlans returns the cloud plan catalog. |
get_v1_plans_dns | GET /v1/plans/dns | ListDNSPlans returns the DNS plan catalog: the tiers priced on zones, records per zone and queries per day. |
get_v1_plans_entitlements_id | GET /v1/plans/entitlements/{id} | GetPlanEntitlements returns what one plan GRANTS and not what it costs: the canonical namespaced entitlement… |
get_v1_plans_gpu | GET /v1/plans/gpu | ListGPUTiers returns the rentable GPU configurations, each with its accelerator count and model, VRAM, vCPUs,… |
get_v1_plans_health | GET /v1/plans/health | Health reports that the plans subsystem is mounted and serving. |
get_v1_plans_policy | GET /v1/plans/policy | GetPricingPolicy returns the published pricing policy: whether pricing is transparent, the revenue-sharing… |
get_v1_plans_regions | GET /v1/plans/regions | ListRegions returns the regions cloud capacity is offered in, each with its display name and physical… |
get_v1_plans_resolve_id | GET /v1/plans/resolve/{id} | ResolvePlan resolves one plan to everything a consumer of the catalog needs at once: its canonical… |
get_v1_plans_schema | GET /v1/plans/schema | GetPlanSchemas returns the two JSON Schema documents this surface speaks: entitlements.schema.json, which… |
get_v1_plans_storage | GET /v1/plans/storage | GetStoragePricing returns the block-storage price block: the price per GB per month and the volume size… |
get_v1_plans_subscriptions | GET /v1/plans/subscriptions | ListSubscriptionPlans returns the subscription ladder — the personal and team tiers a customer buys to use… |
get_v1_plans_tools | GET /v1/plans/tools | ListToolPrices returns the per-use price of every metered tool — web search, code interpreter, image… |
get_v1_plans_vocab | GET /v1/plans/vocab | GetEntitlementVocabulary returns the entitlement key vocabulary: every key with its namespace, JSON type,… |
integrations
| Tool | Route | Description |
|---|---|---|
delete_v1_integrations_github_repos_repo_pages | DELETE /v1/integrations/github/repos/{repo}/pages | Deletes the repo's Pages site. 404 when there is none, so a caller can tell "turned it off" from "there was… |
get_v1_integrations | GET /v1/integrations | Returns every registered integration provider together with THIS org's connection status for it — the catalog… |
get_v1_integrations_github_repos | GET /v1/integrations/github/repos | Lists the org's granted GitHub repositories, each annotated with its native import + sync status from the git… |
get_v1_integrations_github_repos_repo_pages | GET /v1/integrations/github/repos/{repo}/pages | Returns the repo's Pages status, live URL, custom domain and build source. |
get_v1_integrations_provider | GET /v1/integrations/{provider} | Returns ONE provider with this org's connection status — the same view list carries, for a single id. |
post_v1_integrations_github_issues_backfill | POST /v1/integrations/github/issues/backfill | Seeds the native tracker with the EXISTING issues across the org's granted repos (default state=open); the… |
post_v1_integrations_github_repos_import | POST /v1/integrations/github/repos/import | GithubImport imports the selected (or all) granted repos into git.hanzo.ai. |
post_v1_integrations_github_repos_repo_pages | POST /v1/integrations/github/repos/{repo}/pages | Creates the repo's Pages site and answers 201 Created with it. |
post_v1_integrations_github_repos_repo_pages_builds | POST /v1/integrations/github/repos/{repo}/pages/builds | GithubPagesBuild requests a Pages rebuild and returns the queued build's status. |
post_v1_integrations_provider_connect | POST /v1/integrations/{provider}/connect | Acquires the org's credential for one provider. |
post_v1_integrations_provider_disconnect | POST /v1/integrations/{provider}/disconnect | Revokes (best-effort) and forgets an org's connection: it deletes every custodied KMS secret and the… |
post_v1_integrations_provider_verify | POST /v1/integrations/{provider}/verify | Re-checks a CONNECTED apikey connector's stored credential against the provider, live (`hanzo connector… |
post_v1_integrations_telegram_connect | POST /v1/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… |
put_v1_integrations_github_repos_repo_pages | PUT /v1/integrations/github/repos/{repo}/pages | Sets or clears the custom domain (cname) and updates HTTPS enforcement, build type, or source. |
projects
| Tool | Route | Description |
|---|---|---|
delete_v1_projects_slug | DELETE /v1/projects/{slug} | DeleteProject deletes a project and takes its site off the internet. |
delete_v1_projects_slug_domains_host | DELETE /v1/projects/{slug}/domains/{host} | ReleaseDomain gives a custom hostname back, so the name is free to reuse. |
get_v1_projects | GET /v1/projects | ListProjects returns every project your org owns. |
get_v1_projects_slug | GET /v1/projects/{slug} | GetProject returns one project of yours by slug — its settings, its live URL and the deployment currently… |
get_v1_projects_slug_deployments | GET /v1/projects/{slug}/deployments | ListDeployments returns a project's deploy history, newest version first. |
get_v1_projects_slug_deployments_id | GET /v1/projects/{slug}/deployments/{id} | GetDeployment returns one deployment of a project by id. |
get_v1_projects_slug_domains | GET /v1/projects/{slug}/domains | ListDomains returns every custom hostname this site holds: the live ones, plus any pending claim with the DNS… |
patch_v1_projects_slug | PATCH /v1/projects/{slug} | UpdateProject changes a project's settings, and only the settings you send. |
post_v1_projects | POST /v1/projects | CreateProject creates a project — the handle a site is deployed and served under — and answers 201 with it in… |
post_v1_projects_fork | POST /v1/projects/fork | ForkProject creates a project seeded from a PUBLISHED EXAMPLE — either a starter-kit template from the ONE… |
post_v1_projects_slug_deployments_id_complete | POST /v1/projects/{slug}/deployments/{id}/complete | CompleteDeployment is the CI completion hook that flips a queued git deployment to live (or error) once CI… |
post_v1_projects_slug_domains | POST /v1/projects/{slug}/domains | BindDomains attaches one or more CUSTOM public hostnames to this org's site. |
post_v1_projects_slug_domains_host_verify | POST /v1/projects/{slug}/domains/{host}/verify | VerifyDomain checks the DNS challenge for a pending custom hostname and, when it passes, promotes the host so… |
post_v1_projects_slug_purge | POST /v1/projects/{slug}/purge | PurgeProject flushes the site's edge cache without redeploying anything. |
guide
| Tool | Route | Description |
|---|---|---|
delete_v1_guide_curriculum | DELETE /v1/guide/curriculum | DeleteCurriculum clears the caller org's curriculum override and returns the journey it falls back to — the… |
get_v1_guide | GET /v1/guide | Overview returns the caller org's launch journey: the active curriculum's version and title, every step with… |
get_v1_guide_actions | GET /v1/guide/actions | ListActions returns the caller org's Business AI action ledger, most recent first: every "do it for me" tool… |
get_v1_guide_analytics | GET /v1/guide/analytics | Analytics returns the caller org's funnel from the analytics lens plus the GTM recommendations derived from… |
get_v1_guide_blueprint | GET /v1/guide/blueprint | GetBlueprint returns the FULL authored brand blueprint — every principle, section, step, strategy and… |
get_v1_guide_blueprint_versions | GET /v1/guide/blueprint/versions | ListBlueprintVersions returns the brand blueprint's version history — every stored version's number and edit… |
get_v1_guide_curriculum | GET /v1/guide/curriculum | GetCurriculum returns the journey the caller's org is actually running, and whether it comes from the org's… |
get_v1_guide_profile | GET /v1/guide/profile | Profile returns the caller org's OBSERVED growth profile — the signal set, the classified growth stage, and… |
get_v1_guide_strategies | GET /v1/guide/strategies | Strategies returns the ENABLED tactics corpus for the caller's org: the tactics library narrowed by the… |
get_v1_guide_suggest | GET /v1/guide/suggest | Suggest returns the caller org's next-best quests: the available, non-terminal steps of its journey ranked by… |
post_v1_guide_chat | POST /v1/guide/chat | Chat answers a founder's question about their launch journey as the Business AI coach: it grounds the reply… |
post_v1_guide_steps_id_reset | POST /v1/guide/steps/{id}/reset | ResetStep returns one step of the caller org's journey to todo — clearing a manual mark or a skip — and… |
post_v1_guide_steps_id_skip | POST /v1/guide/steps/{id}/skip | SkipStep marks one step of the caller org's journey skipped and returns the refreshed journey. |
auto
| Tool | Route | Description |
|---|---|---|
delete_v1_auto_flows_flow | DELETE /v1/auto/flows/{flow} | FlowDelete deletes one of the caller's flows. |
get_v1_auto_flows | GET /v1/auto/flows | Flows lists the caller's flows, newest first. |
get_v1_auto_flows_flow | GET /v1/auto/flows/{flow} | Flow reads one of the caller's flows — the full record, graph included. |
get_v1_auto_pieces | GET /v1/auto/pieces | Pieces lists the product's built-in piece catalog: the trigger and action types a flow's nodes can use… |
get_v1_auto_runs | GET /v1/auto/runs | Runs lists the caller's run records, newest first — optionally one flow's. |
get_v1_auto_runs_run | GET /v1/auto/runs/{run} | Run reads one run record: status, input, output (each executed node's result keyed by node id once… |
get_v1_auto_status | GET /v1/auto/status | Status reports whether the auto service is reachable — its own health endpoint as an honest lens for "is the… |
patch_v1_auto_flows_flow | PATCH /v1/auto/flows/{flow} | FlowUpdate patches one of the caller's flows: the name, the graph, or both — only the stated fields move. |
post_v1_auto_flows | POST /v1/auto/flows | FlowCreate creates a flow in the caller's org. |
post_v1_auto_flows_flow_publish | POST /v1/auto/flows/{flow}/publish | Publish snapshots the flow's current graph as its next immutable version and arms the flow's triggers. |
post_v1_auto_runs | POST /v1/auto/runs | Start begins one asynchronous run of a flow: the product dispatches the graph to its durable execution engine… |
deploy
| Tool | Route | Description |
|---|---|---|
get_v1_deploy_applications | GET /v1/deploy/applications | ListDeployApplications returns the fleet as an argocd ApplicationList: one projected Application per operator… |
get_v1_deploy_applications_name | GET /v1/deploy/applications/{name} | GetDeployApplication returns ONE projected argocd Application by name, with status.resources filled in from… |
get_v1_deploy_applications_name_resource-tree | GET /v1/deploy/applications/{name}/resource-tree | GetDeployResourceTree returns one application's argocd ApplicationTree: the objects the operator reconciled… |
get_v1_deploy_applications_name_revisions_revision_metadata | GET /v1/deploy/applications/{name}/revisions/{revision}/metadata | GetDeployRevisionMetadata returns the argocd RevisionMetadata for one revision of one application — what the… |
get_v1_deploy_applications_name_syncwindows | GET /v1/deploy/applications/{name}/syncwindows | GetDeploySyncWindows returns one application's argocd ApplicationSyncWindowState — the answer to "is anything… |
get_v1_deploy_clusters | GET /v1/deploy/clusters | ListDeployClusters returns the argocd ClusterList of the destinations the caller's applications reconcile… |
get_v1_deploy_gitops | GET /v1/deploy/gitops | GetDeployGitOps lists every Hanzo CD Application in the cluster: the git source each one polls, the commit it… |
get_v1_deploy_projects | GET /v1/deploy/projects | ListDeployProjects returns the argocd AppProjectList this console groups and filters applications by. |
get_v1_deploy_session_userinfo | GET /v1/deploy/session/userinfo | GetDeploySession answers "is this browser signed in, and if not where does it sign in?" — the dashboard SPA's… |
get_v1_deploy_settings | GET /v1/deploy/settings | GetDeploySettings returns the argocd AuthSettings object the dashboard SPA awaits before its first render. |
get_v1_deploy_version | GET /v1/deploy/version | GetDeployVersion returns the argocd VersionMessage the dashboard SPA reads at bootstrap. |
o11y
| Tool | Route | Description |
|---|---|---|
delete_v1_o11y_reviews_id | DELETE /v1/o11y/reviews/{id} | DeleteAnnotationQueue removes one review queue and every item in it. |
get_v1_o11y_logs | GET /v1/o11y/logs | GetO11yLogs returns a page of one product's logs for the caller's org. |
get_v1_o11y_metrics | GET /v1/o11y/metrics | GetO11yMetrics returns one product's RED series — request rate, errors, p50 and p95 latency — for the… |
get_v1_o11y_reviews | GET /v1/o11y/reviews | ListAnnotationQueues returns a page of the caller org's human-review queues, newest first, narrowed to the… |
get_v1_o11y_reviews_id | GET /v1/o11y/reviews/{id} | GetAnnotationQueue returns one review queue with its pending and completed counts and its first page of… |
get_v1_o11y_reviews_id_items | GET /v1/o11y/reviews/{id}/items | ListAnnotationQueueItems returns a page of one review queue's items, newest first, optionally filtered to… |
get_v1_o11y_status | GET /v1/o11y/status | GetO11yStatus reports whether a product's service is live: an in-cluster health probe with its measured… |
patch_v1_o11y_reviews_id | PATCH /v1/o11y/reviews/{id} | UpdateAnnotationQueue changes a review queue's name, description or score-config set. |
patch_v1_o11y_reviews_id_items_itemId | PATCH /v1/o11y/reviews/{id}/items/{itemId} | UpdateAnnotationQueueItem moves one queue item between PENDING and COMPLETED and sets its assignee. |
post_v1_o11y_reviews | POST /v1/o11y/reviews | CreateAnnotationQueue creates a human-review queue in the caller's org and project. |
post_v1_o11y_reviews_id_items | POST /v1/o11y/reviews/{id}/items | AddAnnotationQueueItems enqueues traces, observations or sessions on a review queue. |
usage
| Tool | Route | Description |
|---|---|---|
get_v1_usage_activity | GET /v1/usage/activity | Activity returns the per-day usage series for ONE authorized subject — the points a contribution heatmap and… |
get_v1_usage_analytics | GET /v1/usage/analytics | Is the entitlement-GATED per-provider breakdown of the caller org's LLM usage — the paid lens over the same… |
get_v1_usage_analytics_access | GET /v1/usage/analytics/access | Echoes a plan's resolved analytics entitlement so a dashboard can configure itself against the LIVE catalog… |
get_v1_usage_leaderboard | GET /v1/usage/leaderboard | Leaderboard ranks AI usage over a window, either the users of the caller's own org or organizations against… |
get_v1_usage_leaderboard_optin | GET /v1/usage/leaderboard/optin | GetOptin returns the caller's own public-listing preference and their org's, each with whether the caller may… |
get_v1_usage_samples | GET /v1/usage/samples | Is the PER-PROVIDER view: one connected account's own consumption of its own plan — "my Claude Max plan is… |
get_v1_usage_summary | GET /v1/usage/summary | Answers GET /v1/usage/summary: the caller's own usage footprint over one window — the categorized spend… |
post_v1_usage | POST /v1/usage | Ingests a batch of account-usage samples — what a developer's OWN AI accounts have consumed of their OWN… |
post_v1_usage_rollup_backfill | POST /v1/usage/rollup/backfill | Backfill seeds the derived usage rollup from ledger history — the rows written before the incremental view… |
put_v1_usage_leaderboard_optin | PUT /v1/usage/leaderboard/optin | PutUserOptin sets the CALLER's own public-listing preference on the leaderboard. |
put_v1_usage_leaderboard_optin_org | PUT /v1/usage/leaderboard/optin/org | PutOrgOptin sets the ORG's listing on the cross-org global board. |
legal
| Tool | Route | Description |
|---|---|---|
get_v1_legal_documents | GET /v1/legal/documents | ListLegalDocuments returns the org's generated documents, newest first, WITHOUT their rendered content —… |
get_v1_legal_documents_id | GET /v1/legal/documents/{id} | GetLegalDocument returns one of the org's documents WITH its rendered body. |
get_v1_legal_filings | GET /v1/legal/filings | ListLegalFilings returns the org's filing records, newest first — which documents were filed where, through… |
get_v1_legal_health | GET /v1/legal/health | LegalHealth reports that the legal subsystem is serving and how many built-in templates its catalog carries. |
get_v1_legal_templates | GET /v1/legal/templates | ListLegalTemplates returns the org's effective template catalog: every built-in template, with any the org… |
get_v1_legal_templates_id | GET /v1/legal/templates/{id} | GetLegalTemplate returns one template resolved for the caller's org — the org's own override if it has saved… |
post_v1_legal_documents | POST /v1/legal/documents | GenerateLegalDocument renders a document from a template and the caller's own merge data, seals it in the… |
post_v1_legal_documents_id_sign | POST /v1/legal/documents/{id}/sign | RequestLegalSignature opens an e-signature request over one document and moves it to out_for_signature,… |
post_v1_legal_filings | POST /v1/legal/filings | CreateLegalFiling records a filing of one or more of the org's documents with a state or agency, and returns… |
put_v1_legal_templates_id | PUT /v1/legal/templates/{id} | SaveLegalTemplateOverride saves the org's own version of a template — a custom NDA, a house MSA — and returns… |
campaign
| Tool | Route | Description |
|---|---|---|
delete_v1_campaign_id | DELETE /v1/campaign/{id} | DeleteCampaign removes one campaign of the caller's org and answers 204 with no body. |
delete_v1_campaign_id_channels_kind | DELETE /v1/campaign/{id}/channels/{kind} | RemoveCampaignChannel drops one channel from a campaign and returns the updated campaign. |
get_v1_campaign | GET /v1/campaign | ListCampaigns returns the org's campaigns, newest first, optionally narrowed to one status. |
get_v1_campaign_id | GET /v1/campaign/{id} | GetCampaign returns one campaign of the caller's org — its name, audience, creatives, channels with their… |
get_v1_campaign_id_metrics | GET /v1/campaign/{id}/metrics | CampaignMetrics returns a campaign's results over a window: the analytics funnel (impressions, clicks,… |
get_v1_campaign_summary | GET /v1/campaign/summary | SummarizeCampaigns returns the org's go-to-market roll-up: how many campaigns exist, how many are live, their… |
post_v1_campaign | POST /v1/campaign | CreateCampaign creates a campaign as a DRAFT and returns it. |
post_v1_campaign_id_channels | POST /v1/campaign/{id}/channels | AddCampaignChannel adds a channel to a campaign, or REPLACES the one it already has of that kind, and returns… |
put_v1_campaign_id | PUT /v1/campaign/{id} | UpdateCampaign rewrites a campaign's core fields — name, audience, creatives, schedule and budget — and… |
flags
| Tool | Route | Description |
|---|---|---|
delete_v1_flags_defs_key | DELETE /v1/flags/defs/{key} | DeleteFlagDefinition removes one flag definition by key and records the deletion in the change log. |
get_v1_flags_activity | GET /v1/flags/activity | ListFlagActivity returns the caller's flag change log newest-first: every create, update and delete, with the… |
get_v1_flags_defs | GET /v1/flags/defs | ListFlagDefinitions returns every flag definition in the caller's (org, project) store, by key, with its… |
get_v1_flags_defs_key | GET /v1/flags/defs/{key} | GetFlagDefinition returns one flag definition by key, or 404 when the caller's store has none under that key. |
get_v1_flags_health | GET /v1/flags/health | Health reports that the flag engine is serving. |
get_v1_flags_waitlist | GET /v1/flags/waitlist | WaitlistMode reports whether ONE host is currently gated by the launch waitlist. |
post_v1_flags | POST /v1/flags | Evaluate runs the caller's flag definitions for one identity and returns the PostHog-shaped verdict: which… |
post_v1_flags_decide | POST /v1/flags/decide | Evaluate runs the caller's flag definitions for one identity and returns the PostHog-shaped verdict: which… |
put_v1_flags_defs_key | PUT /v1/flags/defs/{key} | PutFlagDefinition creates or replaces the flag definition at the path's key and returns the stored row. |
connectors
| Tool | Route | Description |
|---|---|---|
delete_v1_connectors_id | DELETE /v1/connectors/{id} | Forgets a connector: every custodied secret, then the row. |
get_v1_connectors | GET /v1/connectors | Lists the caller's OWN connectors across every provider — the set hanzo connector ls prints. |
get_v1_connectors_id_token | GET /v1/connectors/{id}/token | Hands the custodied access token to its owner — the ONE place custody exits. |
get_v1_connectors_providers | GET /v1/connectors/providers | Lists the user-scoped provider cards — the catalog of what a user can connect, and how. |
post_v1_connectors_id_refresh | POST /v1/connectors/{id}/refresh | Forces a token rotation for a connected connector, ahead of the automatic rotation a token read would do… |
post_v1_connectors_provider_credential | POST /v1/connectors/{provider}/credential | Is the direct intake path: a customer-held token/setup-token (Verify) or an externally obtained OAuth bundle… |
post_v1_connectors_provider_device | POST /v1/connectors/{provider}/device | Begins a device sign-in and returns the code to show the user plus how to poll for completion. |
post_v1_connectors_provider_device_flow_poll | POST /v1/connectors/{provider}/device/{flow}/poll | Advances a device sign-in. Terminal outcomes are DATA, not errors (verifyConn {active:false} discipline) —… |
flow
| Tool | Route | Description |
|---|---|---|
delete_v1_flow_workflows_workflow | DELETE /v1/flow/workflows/{workflow} | WorkflowDelete deletes one of the caller's workflows and its runs. |
get_v1_flow_runs | GET /v1/flow/runs | Runs reads one workflow's recorded runs: every component build with its result, keyed by component. |
get_v1_flow_status | GET /v1/flow/status | Status reports whether the flow service is reachable and which version it runs. |
get_v1_flow_workflows | GET /v1/flow/workflows | Workflows lists the caller's workflows, paged. |
get_v1_flow_workflows_workflow | GET /v1/flow/workflows/{workflow} | Workflow reads one of the caller's workflows — the full record, graph included. |
patch_v1_flow_workflows_workflow | PATCH /v1/flow/workflows/{workflow} | WorkflowUpdate patches one of the caller's workflows: name, description, graph, or the locked flag — only the… |
post_v1_flow_runs | POST /v1/flow/runs | Run executes one of the caller's workflows synchronously: the graph runs in the flow service and the response… |
post_v1_flow_workflows | POST /v1/flow/workflows | WorkflowCreate creates a workflow in the caller's org. |
kb
| Tool | Route | Description |
|---|---|---|
delete_v1_kb_connectors_provider | DELETE /v1/kb/connectors/{provider} | DisconnectConnector revokes a connection: it tombstones the stored credential so a later sync cannot reuse… |
get_v1_kb_connectors | GET /v1/kb/connectors | ListConnectors returns every supported knowledge connector with THIS org's connection state and the REAL… |
get_v1_kb_connectors_catalog | GET /v1/kb/connectors/catalog | ListConnectorCatalog returns the ONE catalog of everything a caller can connect: every first-party connector… |
get_v1_kb_connectors_provider_callback | GET /v1/kb/connectors/{provider}/callback | CompleteConnectorOAuth finishes an OAuth connection: it exchanges the provider's code for a token, seals that… |
get_v1_kb_connectors_provider_connect | GET /v1/kb/connectors/{provider}/connect | StartConnectorOAuth returns the provider authorize URL the console opens to connect this org's account. |
get_v1_kb_graph | GET /v1/kb/graph | GetKnowledgeGraph returns the caller org's knowledge as a node/edge graph shaped for a force-directed… |
post_v1_kb_connectors_provider_sync | POST /v1/kb/connectors/{provider}/sync | SyncConnector pulls the provider's documents for the caller's org and files them as knowledge sources, which… |
post_v1_kb_search | POST /v1/kb/search | SearchKnowledge runs a semantic search over the caller org's own knowledge — its wiki pages, its agent… |
team
| Tool | Route | Description |
|---|---|---|
delete_v1_team_account_cookie | DELETE /v1/team/account/cookie | ClearCookie signs this browser out of team by expiring the HttpOnly account-token cookie the OAuth callback… |
delete_v1_team_files_workspace_filename | DELETE /v1/team/files/{workspace}/{filename} | DeleteBlob removes one blob from a workspace's file store. |
get_v1_team_account_providers | GET /v1/team/account/providers | ListProviders returns the identity providers this deployment starts a login with. |
get_v1_team_billing_plan | GET /v1/team/billing/plan | ReadPlan returns the plan and seat counts for the caller's OWN org, resolved from the VERIFIED team session… |
get_v1_team_bots | GET /v1/team/bots | ListBots returns the caller org's bot members — the org's agents projected as the workspace Employees they… |
get_v1_team_transactor_api_v1_statistics | GET /v1/team/transactor/api/v1/statistics | Statistics returns the transactor's live sessions for the workspace the caller's token names — the endpoint… |
get_v1_team_transactor_statistics | GET /v1/team/transactor/statistics | Statistics returns the transactor's live sessions for the workspace the caller's token names — the endpoint… |
post_v1_team_bots_sync | POST /v1/team/bots/sync | SyncBots re-projects the caller org's agents as workspace members into EVERY workspace of the org, and… |
tools
| Tool | Route | Description |
|---|---|---|
get_v1_tools | GET /v1/tools | ListTools lists every tool the caller's org and project can reach, from every source, each flagged with… |
get_v1_tools_activation | GET /v1/tools/activation | GetActivation reports which tools are switched on for the caller's org and project. |
get_v1_tools_catalog | GET /v1/tools/catalog | ListCatalog lists the MCP servers the public registries publish, as we hold them: our canonical copy of… |
get_v1_tools_catalog_id | GET /v1/tools/catalog/{id} | GetListing returns one catalog entry in full: the publisher's description, its repository and site, every… |
patch_v1_tools_catalog_id | PATCH /v1/tools/catalog/{id} | CurateListing sets what WE say about one catalog entry — hidden, featured, official, logo — and answers with… |
post_v1_tools_call | POST /v1/tools/call | CallTool runs one of the caller's activated tools and answers with its output. |
post_v1_tools_catalog_sync | POST /v1/tools/catalog/sync | SyncCatalog pulls the public MCP registry into our canonical copy and reports what changed. |
put_v1_tools_activation | PUT /v1/tools/activation | PutActivation switches tools on and off for the caller's org and project, and answers with the resulting… |
tracker
| Tool | Route | Description |
|---|---|---|
delete_v1_tracker_projects_key | DELETE /v1/tracker/projects/{key} | DeleteProject removes one tracker project of the caller's org AND every issue filed under it, and answers 204… |
delete_v1_tracker_projects_key_issues_num | DELETE /v1/tracker/projects/{key}/issues/{num} | DeleteIssue removes one issue from a tracker project and answers 204 with no body. |
get_v1_tracker_projects | GET /v1/tracker/projects | ListProjects returns every tracker project in the caller's org, newest first. |
get_v1_tracker_projects_key | GET /v1/tracker/projects/{key} | GetProject returns one tracker project of the caller's org by its key — its name, description and timestamps. |
get_v1_tracker_projects_key_issues | GET /v1/tracker/projects/{key}/issues | ListIssues returns the issues of one tracker project, optionally filtered by status, kind, repo and source. |
get_v1_tracker_projects_key_issues_num | GET /v1/tracker/projects/{key}/issues/{num} | GetIssue returns one issue of one tracker project by its per-project number — title, description, status,… |
patch_v1_tracker_projects_key | PATCH /v1/tracker/projects/{key} | UpdateProject renames a tracker project or rewrites its description, and returns the updated project. |
patch_v1_tracker_projects_key_issues_num | PATCH /v1/tracker/projects/{key}/issues/{num} | UpdateIssue edits one issue in place and returns it — retitle it, rewrite its body, move it between board… |
wallets
| Tool | Route | Description |
|---|---|---|
get_v1_wallets | GET /v1/wallets | Returns the caller org's wallets, newest first, optionally NARROWED within the org by project, agent or… |
get_v1_wallets_accounts | GET /v1/wallets/accounts | Returns the caller org's wallet accounts, newest first. |
get_v1_wallets_id | GET /v1/wallets/{id} | Returns one of the caller org's wallets: its scope, custody kind, tier, chain and on-chain address. |
post_v1_wallets | POST /v1/wallets | Provisions a new signing identity under one of the caller org's accounts and answers the stored wallet… |
post_v1_wallets_accounts | POST /v1/wallets/accounts | Opens a named wallet account for the caller's org. |
post_v1_wallets_id_keys | POST /v1/wallets/{id}/keys | Rolls one wallet's signing material through its own custody backend and answers the wallet with whatever… |
post_v1_wallets_id_sign | POST /v1/wallets/{id}/sign | Produces a secp256k1 signature from one of the caller org's wallets over a 32-byte digest, through whichever… |
post_v1_wallets_id_transactions | POST /v1/wallets/{id}/transactions | Composes a Safe transaction on the MPC ring and answers its EIP-712 hash together with the owner approval the… |
webhooks
| Tool | Route | Description |
|---|---|---|
delete_v1_webhooks_id | DELETE /v1/webhooks/{id} | Removes one of the caller org's webhook endpoints and answers 204 with no body. |
get_v1_webhooks | GET /v1/webhooks | Returns every webhook endpoint the caller's org has registered, newest first, each with its 7-day delivery… |
get_v1_webhooks_id | GET /v1/webhooks/{id} | Returns one of the caller org's webhook endpoints with its 7-day delivery and failure counts, signing secret… |
get_v1_webhooks_id_deliveries | GET /v1/webhooks/{id}/deliveries | Returns one endpoint's per-attempt delivery log, newest first — the record of what was sent, what the… |
post_v1_webhooks | POST /v1/webhooks | Registers a new webhook subscription for the caller's org and answers 201 with the endpoint INCLUDING its… |
post_v1_webhooks_id_secret | POST /v1/webhooks/{id}/secret | Mints a NEW HMAC signing secret for the endpoint and answers the endpoint WITH it — the only other response… |
post_v1_webhooks_id_test | POST /v1/webhooks/{id}/test | Sends ONE signed test event to the endpoint right now and answers the outcome inline, so the console can show… |
put_v1_webhooks_id | PUT /v1/webhooks/{id} | Replaces the editable fields of one of the caller org's endpoints — url, events, status and description — and… |
code
| Tool | Route | Description |
|---|---|---|
get_v1_code_ask | GET /v1/code/ask | Answers a question about the caller org's code with a CITED answer: retrieval packs grounding context, then… |
get_v1_code_file | GET /v1/code/file | Returns the INDEXED content of one file — read_file over the chunks the search tiers hold, for pulling up… |
get_v1_code_search | GET /v1/code/search | Finds code in the caller org's index across three orthogonal retrieval tiers fused by reciprocal-rank fusion:… |
get_v1_code_tree | GET /v1/code/tree | Returns one repository's file structure with a per-file symbol count — get_repo_structure over the org's own… |
post_v1_code_ask | POST /v1/code/ask | Is askGet with the question in the request BODY, for a question too long or too awkward to put in a URL. |
post_v1_code_context | POST /v1/code/context | Packs the most relevant code for a query into a token budget — THE primitive for a coding agent that has to… |
post_v1_code_index | POST /v1/code/index | (re)indexes a repository for the caller's org, incrementally: files whose content hash is unchanged are… |
machines
| Tool | Route | Description |
|---|---|---|
bindMachineAgent | PUT /v1/machines/{id}/agent | Binds a cloud Agent to one of the caller org's machines: the machine is recorded as running that Agent's… |
deleteMachine | DELETE /v1/machines/{id} | Terminates one of the caller org's machines. |
getMachine | GET /v1/machines/{id} | Returns one of the caller org's machines by its org-scoped name. |
getMachineAgent | GET /v1/machines/{id}/agent | Returns the agent binding of one of the caller org's machines, or 404 when the machine runs no bot runtime. |
listMachineAgents | GET /v1/machines/agents | Returns every agent↔machine binding in the caller's org — which machines are running which cloud Agent, with… |
listMachines | GET /v1/machines | Returns every machine the caller's org has — Visor's registry, the live DigitalOcean droplets and the DOKS… |
unbindMachineAgent | DELETE /v1/machines/{id}/agent | Detaches the agent runtime from one of the caller org's machines. |
research
| Tool | Route | Description |
|---|---|---|
get_v1_research_artifacts | GET /v1/research/artifacts | ListResearchArtifacts returns the caller org's research-diary feed newest-first — the snapshots and reports… |
get_v1_research_experiments | GET /v1/research/experiments | ListExperiments returns the caller org's CANONICAL experiments — the deterministic deduped view over the… |
get_v1_research_projects | GET /v1/research/projects | ListResearchProjects returns every research project in the caller's org with its real totals — canonical and… |
get_v1_research_totals | GET /v1/research/totals | GetResearchTotals returns the caller org's headline aggregate plus a per-kind breakdown — the observatory's… |
post_v1_research_artifacts | POST /v1/research/artifacts | RecordResearchArtifact records one research-diary artifact — a board snapshot or a generated report —… |
post_v1_research_experiments | POST /v1/research/experiments | IngestExperiments appends one batch of experiment and attempt versions to the caller org's evidence store,… |
post_v1_research_grants | POST /v1/research/grants | GrantResearchVisibility records the SEPARATE authorization an upload never implies: a record's visibility… |
sites
| Tool | Route | Description |
|---|---|---|
get_v1_sites | GET /v1/sites | ListSites returns the org's deployed sites at the pretty URLs they serve at. |
get_v1_sites_slug_releases | GET /v1/sites/{slug}/releases | ListReleases returns a site's releases newest-first, marking the active one — the rollback menu. |
post_v1_sites | POST /v1/sites | BuildSite generates a self-contained, mobile-responsive static site from a natural-language brief and deploys… |
post_v1_sites_deploy | POST /v1/sites/deploy | DeploySite deploys a caller-supplied file manifest — the deploy_site capability an agent calls — and answers… |
post_v1_sites_slug_publish | POST /v1/sites/{slug}/publish | PublishSite promotes a build output into a new release AND goes live with it — create+activate in one call,… |
post_v1_sites_slug_releases | POST /v1/sites/{slug}/releases | CreateRelease promotes a build output into a new immutable release WITHOUT serving it — the staged half of… |
post_v1_sites_slug_releases_release_activate | POST /v1/sites/{slug}/releases/{release}/activate | ActivateRelease points the site at an existing release — the go-live, and equally the ROLLBACK. |
ads
| Tool | Route | Description |
|---|---|---|
delete_v1_ads_campaigns_id | DELETE /v1/ads/campaigns/{id} | Removes one of the caller org's campaigns and answers 204 with no body. |
get_v1_ads_campaigns | GET /v1/ads/campaigns | Returns the caller org's ad campaigns, most recently updated first, optionally narrowed to one lifecycle… |
get_v1_ads_campaigns_id | GET /v1/ads/campaigns/{id} | Returns one of the caller org's campaigns. |
get_v1_ads_summary | GET /v1/ads/summary | Rolls the caller org's ad campaigns up into four numbers: how many campaigns exist, how many are active, and… |
post_v1_ads_campaigns | POST /v1/ads/campaigns | Registers a new ad campaign for the caller's org and answers 201 with the stored row. |
put_v1_ads_campaigns_id | PUT /v1/ads/campaigns/{id} | Replaces the user-owned fields of one of the caller org's campaigns and answers the stored row. |
channels
| Tool | Route | Description |
|---|---|---|
get_v1_channels | GET /v1/channels | Returns every chat transport channels can talk to — Discord, Slack, Teams and Telegram — with the caller… |
get_v1_channels_allowlist | GET /v1/channels/allowlist | Returns the caller org's access policy for one channel: whether DMs are pairing-gated, allowlisted or open,… |
get_v1_channels_inbox | GET /v1/channels/inbox | Returns the messages people have sent to the caller org's connected chat bots, oldest first, in the portable… |
get_v1_channels_pairing | GET /v1/channels/pairing | Returns the pairing requests waiting for the caller org to approve — one per person who messaged a connected… |
post_v1_channels_pairing_approve | POST /v1/channels/pairing/approve | Turns one pending pairing code into a standing allow entry, so that person can DM the org's bot on that… |
put_v1_channels_allowlist | PUT /v1/channels/allowlist | Edits the caller org's access policy for one channel and answers the policy as GET would, so both verbs… |
clusters
| Tool | Route | Description |
|---|---|---|
attachCluster | POST /v1/clusters | Attaches a BYO cluster to the caller's org — the kubeconfig is validated, KMS-sealed and added to the fleet —… |
createNodePool | POST /v1/clusters/{clusterId}/pools | Adds a node pool to one of the caller org's clusters and answers 201 with the created pool. |
deleteNodePool | DELETE /v1/clusters/{clusterId}/pools/{poolId} | Removes a node pool from one of the caller org's clusters. |
detachCluster | DELETE /v1/clusters/{id} | Removes a BYO cluster from the caller org's fleet. |
listClusters | GET /v1/clusters | Returns the caller org's clusters from both sources: the managed clusters projected from Visor's node pools,… |
scaleNodePool | POST /v1/clusters/{clusterId}/pools/{poolId}/scale | Resizes a node pool to an absolute node count and returns the pool as Visor reports it after the change. |
fleet
| Tool | Route | Description |
|---|---|---|
cancelFleetJob | POST /v1/fleet/jobs/{id}/cancel | Cancels a queued or running render in the caller's org. |
listFleet | GET /v1/fleet | Returns every compute unit the caller's org has, from every source, each carrying its latest utilization:… |
listFleetJobs | GET /v1/fleet/jobs | Returns the caller org's gpu-jobs render queue, each row tagged with the GPU it targets (empty = the shared… |
listFleetSamples | GET /v1/fleet/samples | Returns the caller org's utilization series, oldest first. |
listFleetWorkers | GET /v1/fleet/workers | Returns the caller org's BYO machines — the ones that dialed in via hanzo link — with everything each host… |
recordFleetSample | POST /v1/fleet/samples | Records a BYO worker's live GPU utilization into the SAME series the fleet board overlays. |
marketplace
| Tool | Route | Description |
|---|---|---|
delete_v1_marketplace_listings_id | DELETE /v1/marketplace/listings/{id} | Unpublish withdraws one of the caller org's listings from the marketplace and answers 204. |
get_v1_marketplace | GET /v1/marketplace | Discover lists every tool and agent the caller can reach in their own org and project, enriched with any… |
get_v1_marketplace_listings | GET /v1/marketplace/listings | ListListings returns the listings the caller's own org has published — what this org is offering, not what it… |
post_v1_marketplace_install | POST /v1/marketplace/install | Install activates one tool for the caller's own org and project. |
post_v1_marketplace_listings | POST /v1/marketplace/listings | Publish offers one tool on the marketplace, optionally monetized. |
post_v1_marketplace_uninstall | POST /v1/marketplace/uninstall | Uninstall deactivates one tool for the caller's own org and project, so it stops being dispatchable there. |
prompts
| Tool | Route | Description |
|---|---|---|
delete_v1_prompts_name | DELETE /v1/prompts/{name} | Delete removes one of the caller org's prompts and every version of it, answering 204. |
get_v1_prompts | GET /v1/prompts | List returns the caller org's prompt library as one row per prompt: its name, type, every version number it… |
get_v1_prompts_catalog | GET /v1/prompts/catalog | Catalog returns the read-only starter prompt library shipped with the binary — reference content every tenant… |
get_v1_prompts_metrics | GET /v1/prompts/metrics | Metrics returns real per-prompt statistics for the caller's org: how many versions each prompt has, which one… |
get_v1_prompts_name | GET /v1/prompts/{name} | Get returns one of the caller org's prompts: its CURRENT template text plus the metadata of every version it… |
post_v1_prompts | POST /v1/prompts | Create records a prompt for the caller's org and answers 201 with it. |
registry
| Tool | Route | Description |
|---|---|---|
get_v1_registry_images | GET /v1/registry/images | Images lists the org's container repositories, read live from the OCI catalog and filtered server-side to the… |
get_v1_registry_packages | GET /v1/registry/packages | Packages lists the org's npm packages — <org> and @<org>/… — from the npm registry's search index,… |
get_v1_registry_projects | GET /v1/registry/projects | Projects lists the namespaces the caller can see with what each holds: the org's slug, its repository count… |
get_v1_registry_status | GET /v1/registry/status | Status reports whether the OCI and npm registries are reachable and, when the OCI half is auth-gated, which… |
get_v1_registry_tags | GET /v1/registry/tags | Tags lists one org-owned repository's tags, read live from the OCI registry. |
post_v1_registry_token | POST /v1/registry/token | Token mints a short-lived, pull-only registry token for exactly one of the org's images, through the same IAM… |
sync
| Tool | Route | Description |
|---|---|---|
delete_v1_sync_id | DELETE /v1/sync/{id} | Delete removes one sync and tears down the outbound mirror it derived, answering 204. |
get_v1_sync | GET /v1/sync | List returns every sync link the caller's org has, each with its two endpoints, its direction and trigger… |
get_v1_sync_id | GET /v1/sync/{id} | Get returns one sync by id. It is org-scoped: an id belonging to another tenant is the same 404 an unknown id… |
patch_v1_sync_id | PATCH /v1/sync/{id} | Patch updates one sync's mutable policy — direction, trigger and actor — in place. |
post_v1_sync | POST /v1/sync | Create declares a sync between two endpoints and returns it. |
post_v1_sync_id_run | POST /v1/sync/{id}/run | Run reconciles one sync now — the manual re-sync, and the initial import for a link created without run=true. |
authors
| Tool | Route | Description |
|---|---|---|
get_v1_authors | GET /v1/authors | MyAuthorProgram returns the caller's author-program dashboard: enrolment status, linked forge login, verified… |
get_v1_authors_basis | GET /v1/authors/basis | MyRoyaltyBasis returns the AUDIT TRAIL behind the caller's own royalty: every ledger row with the spend it… |
post_v1_authors_connect | POST /v1/authors/connect | ConnectAuthor enrols the caller's org in the author program at status "connected" and returns its enrolment,… |
post_v1_authors_deploys_record | POST /v1/authors/deploys/record | RecordAuthorDeploy records that the caller's org deployed a project built from a source repository, which is… |
post_v1_authors_repos_verify | POST /v1/authors/repos/verify | VerifyAuthorRepo proves that the caller owns a repository — or a whole OWNER — and records the claim, which… |
cloud
| Tool | Route | Description |
|---|---|---|
delete_v1_cloud_provider_accounts_label | DELETE /v1/cloud/{provider}/accounts/{label} | Forgets one linked cloud account: it detaches every fleet cluster THIS account folded (its own names, in its… |
get_v1_cloud | GET /v1/cloud | Returns the clouds this deployment can link and what linking each one needs — the DigitalOcean token, the AWS… |
get_v1_cloud_accounts | GET /v1/cloud/accounts | Lists the caller org's linked cloud accounts across every provider: which account each one is at the… |
post_v1_cloud_provider_accounts | POST /v1/cloud/{provider}/accounts | Links one of the caller org's cloud accounts and folds the Kubernetes clusters it finds there into the ONE… |
post_v1_cloud_provider_accounts_label_sync | POST /v1/cloud/{provider}/accounts/{label}/sync | Re-discovers one already-linked cloud account and reconciles what it folded: kubeconfigs are refreshed,… |
content
| Tool | Route | Description |
|---|---|---|
get_v1_content_board | GET /v1/content/board | GetBoard aggregates the caller org's marketing content across every publishable content type into ONE queue… |
get_v1_content_channels | GET /v1/content/channels | GetChannels lists the distribution channels the caller's org has connected — the social integrations a… |
get_v1_content_lifecycle | GET /v1/content/lifecycle | GetLifecycle returns the ONE marketing-content state machine: the ordered lifecycle states, which state a… |
post_v1_content_doctype_name_transition | POST /v1/content/{doctype}/{name}/transition | PostTransition moves one content item to a new lifecycle state and, on the move to published, fans it out to… |
post_v1_content_publish | POST /v1/content/publish | Publish distributes one CMS content item to the channels recorded on it and returns the honest per-channel… |
k8s
| Tool | Route | Description |
|---|---|---|
createKubernetesCluster | POST /v1/k8s/clusters | Provisions a DOKS cluster for the caller's org and answers 201. |
deleteKubernetesCluster | DELETE /v1/k8s/clusters/{id} | Destroys a DOKS cluster by id and answers 204. ADMIN-GATED, like create. |
getKubernetesCluster | GET /v1/k8s/clusters/{id} | Returns one cluster's detail: node pools + worker nodes. |
listKubernetesClusters | GET /v1/k8s/clusters | Lists the org's DOKS clusters (Visor, house account) folded with the org's BYO clusters — ONE fleet cluster… |
listKubernetesNodes | GET /v1/k8s/nodes | Returns every DOKS worker node in the org's clusters as a machine — the SAME set the fleet folds in… |
search
| Tool | Route | Description |
|---|---|---|
delete_v1_search_name | DELETE /v1/search/{name} | DropSearch deletes one search index from the shared backend and removes its metadata row. |
get_v1_search | GET /v1/search | ListSearch lists the caller org's search indexes. |
get_v1_search_indexes | GET /v1/search/indexes | Lists the search indexes with their document counts and timestamps. |
get_v1_search_name | GET /v1/search/{name} | GetSearch returns one search index's metadata. |
get_v1_search_stats | GET /v1/search/stats | Totals the documents across every search index. |
templates
| Tool | Route | Description |
|---|---|---|
delete_v1_templates_slug | DELETE /v1/templates/{slug} | Deletes the caller org's OWN starter kit. A slug they do not own is a 404, never a delete: the DELETE binds… |
get_v1_templates | GET /v1/templates | Lists the public starter-kit catalog plus, for a validated caller, that org's own private kits. |
get_v1_templates_slug | GET /v1/templates/{slug} | Returns one starter kit: the caller org's own by that slug, else the public catalog's. |
post_v1_templates | POST /v1/templates | Creates a starter kit PRIVATE to the caller's org and answers 201 with the stored kit. |
put_v1_templates_slug | PUT /v1/templates/{slug} | Overwrites the caller org's OWN starter kit at the path slug, answering the stored kit. |
vector
| Tool | Route | Description |
|---|---|---|
delete_v1_vector_name | DELETE /v1/vector/{name} | DropVector deletes one vector collection from the shared backend and removes its metadata row. |
get_v1_vector | GET /v1/vector | ListVector lists the caller org's vector collections. |
get_v1_vector_collections | GET /v1/vector/collections | Lists the vector collections with their size and geometry. |
get_v1_vector_name | GET /v1/vector/{name} | GetVector returns one vector collection's metadata. |
get_v1_vector_stats | GET /v1/vector/stats | Totals the collections, vectors and storage across the vector store. |
balancers
| Tool | Route | Description |
|---|---|---|
delete_v1_balancers_id | DELETE /v1/balancers/{id} | DeleteLoadBalancer removes one of the caller org's load balancers and answers 204. |
get_v1_balancers | GET /v1/balancers | ListLoadBalancers returns every load balancer the caller's org owns, under the friendly names the org created… |
get_v1_balancers_id | GET /v1/balancers/{id} | GetLoadBalancer returns one of the caller org's load balancers by id. |
post_v1_balancers | POST /v1/balancers | CreateLoadBalancer creates a load balancer in the caller's org namespace and answers 201 with it. |
destinations
| Tool | Route | Description |
|---|---|---|
delete_v1_destinations_platform | DELETE /v1/destinations/{platform} | Forgets a destination for the caller's org: every credential held in KMS, then the stored config. |
get_v1_destinations | GET /v1/destinations | Reports every destination this deployment can forward to, each with the caller org's connection state:… |
get_v1_destinations_platform | GET /v1/destinations/{platform} | Reports one destination's card for the caller's org — its config fields, its connection state, and whether a… |
post_v1_destinations_platform_test | POST /v1/destinations/{platform}/test | Sends ONE synthetic pageview through the connected destination end to end and reports what the platform said. |
engine
| Tool | Route | Description |
|---|---|---|
get_v1_engine_model | GET /v1/engine/model | Model reads one model's load state — loaded, unloading, or not_found, as the engine itself reports it. |
get_v1_engine_models | GET /v1/engine/models | Models lists the models the engine serves, each with its load state — the server's own model table (its… |
get_v1_engine_status | GET /v1/engine/status | Status reports whether the engine deployment is reachable and which build revision it runs — an honest lens… |
get_v1_engine_system | GET /v1/engine/system | System reads the engine host's inventory: OS, CPU, memory, every accelerator device with its VRAM and compute… |
help
| Tool | Route | Description |
|---|---|---|
get_v1_help_articles | GET /v1/help/articles | Returns the public knowledge base: the help center's Published, publicly-visible articles as cards. |
get_v1_help_articles_slug | GET /v1/help/articles/{slug} | Returns one public article by slug, with its body. |
get_v1_help_categories | GET /v1/help/categories | Returns the knowledge-base sections for the public center's navigation — but ONLY the sections that front at… |
post_v1_help_tickets | POST /v1/help/tickets | Files a customer support ticket into the public help center. |
skills
| Tool | Route | Description |
|---|---|---|
delete_v1_skills_id | DELETE /v1/skills/{id} | DeleteSkill removes one of the caller org's authored skills. |
get_v1_skills | GET /v1/skills | ListSkills lists the skills the caller's org can reach — the brand's embedded catalogue plus the org's own… |
get_v1_skills_authored | GET /v1/skills/authored | ListAuthoredSkills lists the caller org's OWN skills with their SKILL.md bodies. |
post_v1_skills | POST /v1/skills | PutSkill adds or revises one of the caller org's own skills, and answers 201 with the stored record. |
validators
| Tool | Route | Description |
|---|---|---|
get_v1_validators | GET /v1/validators | Returns the validator slots the caller's org has claimed. |
get_v1_validators_challenge | GET /v1/validators/challenge | Issues the single-use nonce and the exact message a wallet must sign to claim a validator slot. |
get_v1_validators_tokenId | GET /v1/validators/{tokenId} | Returns one claimed validator slot, scoped to the caller's org. |
post_v1_validators | POST /v1/validators | Claims a validator slot and provisions its node, after proving the caller's wallet owns the slot's NFT. |
vpcs
| Tool | Route | Description |
|---|---|---|
delete_v1_vpcs_id | DELETE /v1/vpcs/{id} | DeleteVpc removes one of the caller org's VPCs and answers 204. |
get_v1_vpcs | GET /v1/vpcs | ListVpcs returns every VPC the caller's org owns, under the friendly names the org created them with. |
get_v1_vpcs_id | GET /v1/vpcs/{id} | GetVpc returns one of the caller org's VPCs by id. |
post_v1_vpcs | POST /v1/vpcs | CreateVpc creates a VPC in the caller's org namespace and answers 201 with it. |
world
| Tool | Route | Description |
|---|---|---|
get_v1_world_limits | GET /v1/world/limits | Echoes a World plan's rate limits, alert quota and model-API grant, read straight from the live @hanzo/plans… |
get_v1_world_news | GET /v1/world/news | Returns the caller's merged world-news feed: every source their project's pipeline names — GDELT once per… |
get_v1_world_pipeline | GET /v1/world/pipeline | Returns the caller project's news pipeline: which feeds it reads and how the merged result is filtered. |
put_v1_world_pipeline | PUT /v1/world/pipeline | Replaces the caller project's news pipeline and returns what was stored. |
analytics
| Tool | Route | Description |
|---|---|---|
get_v1_analytics_overview | GET /v1/analytics/overview | Overview returns the caller org's analytics KPIs for one time window. |
get_v1_analytics_timeseries | GET /v1/analytics/timeseries | Timeseries returns the caller org's LLM usage over time as an evenly-spaced series. |
get_v1_analytics_top | GET /v1/analytics/top | Top returns the caller org's ranked lenses for one window, five of them at once. |
compute
| Tool | Route | Description |
|---|---|---|
deleteBot | DELETE /v1/compute/bots/{id} | Tears down both halves of a bot: it unbinds the agent (best-effort — a bot with no binding still deletes),… |
getBot | GET /v1/compute/bots/{id} | Returns one of the caller org's bot machines with its agent binding. |
listBots | GET /v1/compute/bots | Returns the caller org's bot machines — the kind=bot machines — each joined with the agent binding that says… |
datastore
| Tool | Route | Description |
|---|---|---|
delete_v1_datastore_name | DELETE /v1/datastore/{name} | DropDatastore deprovisions one Hanzo Datastore warehouse. |
get_v1_datastore | GET /v1/datastore | ListDatastore lists the caller org's Hanzo Datastore warehouses. |
get_v1_datastore_name | GET /v1/datastore/{name} | GetDatastore returns one Hanzo Datastore warehouse's metadata. |
docdb
| Tool | Route | Description |
|---|---|---|
delete_v1_docdb_name | DELETE /v1/docdb/{name} | DropDocDB deprovisions one Hanzo DocDB database. |
get_v1_docdb | GET /v1/docdb | ListDocDB lists the caller org's Hanzo DocDB document databases. |
get_v1_docdb_name | GET /v1/docdb/{name} | GetDocDB returns one Hanzo DocDB database's metadata. |
enablement
| Tool | Route | Description |
|---|---|---|
get_v1_enablement | GET /v1/enablement | GetEnablement returns what the caller's org can actually use: every managed item with its global state,… |
post_v1_enablement_optin | POST /v1/enablement/optin | OptIntoBeta opts the caller's OWN org into a beta item. |
post_v1_enablement_optout | POST /v1/enablement/optout | OptOutOfBeta removes the caller's OWN org from a beta item's grant list, the reverse of OptIntoBeta and… |
iam
| Tool | Route | Description |
|---|---|---|
get_v1_iam_keys | GET /v1/iam/keys | GetKey returns the caller's own API keys — every type they hold, read AUTHORITATIVELY from IAM rather than… |
post_v1_iam_keys | POST /v1/iam/keys | MintKey creates — or rotates — the caller's API key of the requested type and returns it ONCE. |
post_v1_iam_onboard | POST /v1/iam/onboard | Onboard creates the caller's organization. |
keys
| Tool | Route | Description |
|---|---|---|
delete_v1_keys | DELETE /v1/keys | RevokeKey revokes the caller's own API key of the requested class. |
get_v1_keys | GET /v1/keys | GetKey returns the caller's own API keys — every type they hold, read AUTHORITATIVELY from IAM rather than… |
post_v1_keys | POST /v1/keys | MintKey creates — or rotates — the caller's API key of the requested type and returns it ONCE. |
kv
| Tool | Route | Description |
|---|---|---|
delete_v1_kv_name | DELETE /v1/kv/{name} | DropKV deprovisions one Hanzo KV store. It reverts any app instance bound to it back to Base BEFORE tearing… |
get_v1_kv | GET /v1/kv | ListKV lists the caller org's Hanzo KV stores. |
get_v1_kv_name | GET /v1/kv/{name} | GetKV returns one Hanzo KV store's metadata. |
mcp
| Tool | Route | Description |
|---|---|---|
delete_v1_mcp_servers_id | DELETE /v1/mcp/servers/{id} | DeleteServer deregisters one of the caller org's external MCP servers, so its tools leave the registry. |
get_v1_mcp_servers | GET /v1/mcp/servers | ListServers lists the external MCP servers the caller's org has registered. |
post_v1_mcp_servers | POST /v1/mcp/servers | CreateServer gives the caller's org one more external MCP server, so its tools join the org's tool plane and… |
ml
| Tool | Route | Description |
|---|---|---|
delete_v1_ml_models_name | DELETE /v1/ml/models/{name} | DeleteModel deletes a deployed inference model. |
get_v1_ml_models | GET /v1/ml/models | ListModels lists the inference models deployed in the caller's org. |
get_v1_ml_models_name | GET /v1/ml/models/{name} | GetModel returns one deployed inference model. |
plugins
| Tool | Route | Description |
|---|---|---|
delete_v1_plugins_authored_id | DELETE /v1/plugins/authored/{id} | DeleteAuthoredPlugin removes one of the caller org's built plugins, so the runtime can no longer load it. |
get_v1_plugins | GET /v1/plugins | ListPlugins reports what this deployment actually mounted: every subsystem the composition root declared and… |
get_v1_plugins_authored | GET /v1/plugins/authored | ListAuthoredPlugins lists the plugins the caller's org BUILT, newest first, each with the TypeScript as… |
s3
| Tool | Route | Description |
|---|---|---|
delete_v1_s3_name | DELETE /v1/s3/{name} | DropS3 deletes one bucket from the shared object store and removes its metadata row. |
get_v1_s3 | GET /v1/s3 | ListS3 lists the caller org's object-storage buckets. |
get_v1_s3_name | GET /v1/s3/{name} | GetS3 returns one bucket's metadata. It carries the bucket's status and the gateway address it is reached at,… |
sql
| Tool | Route | Description |
|---|---|---|
delete_v1_sql_name | DELETE /v1/sql/{name} | DropSQL deprovisions one Hanzo SQL database. |
get_v1_sql | GET /v1/sql | ListSQL lists the caller org's Hanzo SQL databases. |
get_v1_sql_name | GET /v1/sql/{name} | GetSQL returns one Hanzo SQL database's metadata. |
blueprint
| Tool | Route | Description |
|---|---|---|
get_v1_blueprint | GET /v1/blueprint | Returns every deployable blueprint with its service count and estimated monthly compute cost. |
get_v1_blueprint_health | GET /v1/blueprint/health | Reports blueprint liveness and echoes the compute rate card in force. |
bots
| Tool | Route | Description |
|---|---|---|
get_v1_bots | GET /v1/bots | List returns the caller org's live bot runs, read from the bot runtime and projected into the console… |
post_v1_bots_runId_stop | POST /v1/bots/{runId}/stop | Stop terminates one of the caller org's own bot runs and reports its terminal state. |
finance
| Tool | Route | Description |
|---|---|---|
get_v1_finance_accounts | GET /v1/finance/accounts | ListFinanceAccounts returns the ledger accounts the caller may see, with their balances. |
get_v1_finance_treasury | GET /v1/finance/treasury | GetTreasury returns the reserve fund's health and the current revenue-share policy for any validated caller. |
gateway
| Tool | Route | Description |
|---|---|---|
get_v1_gateway_config | GET /v1/gateway/config | Read returns the EFFECTIVE edge policy the caller is subject to: the platform CORS allowlist and pre-auth… |
put_v1_gateway_config | PUT /v1/gateway/config | Write updates one policy scope and returns the policy in force after the write. |
gpus
| Tool | Route | Description |
|---|---|---|
listGpuAlerts | GET /v1/gpus/alerts | Is an HONEST empty surface: Visor exposes no GPU alert inventory, so this returns [] rather than fabricating… |
listGpus | GET /v1/gpus | Returns one row per physical accelerator the caller's org has, derived from its real GPU machines (the size… |
insights
| Tool | Route | Description |
|---|---|---|
get_v1_insights_events | GET /v1/insights/events | InsightsEvents returns the caller org's most recent product events, newest first. |
get_v1_insights_health | GET /v1/insights/health | InsightsHealth reports that the unified insights surface is serving. |
networks
| Tool | Route | Description |
|---|---|---|
get_v1_networks | GET /v1/networks | Returns the caller's org overlay network on the Zero Trust fabric. |
get_v1_networks_id | GET /v1/networks/{id} | Returns one overlay network by id, scoped to the caller's org. |
orgs
| Tool | Route | Description |
|---|---|---|
get_v1_orgs_org_entitlements | GET /v1/orgs/{org}/entitlements | Get lists the products an org has ENABLED — its own intent, which the console's paid-product sidebar reads to… |
post_v1_orgs_org_entitlements | POST /v1/orgs/{org}/entitlements | Post turns products on or off for an org and returns the enabled set afterwards. |
referrals
| Tool | Route | Description |
|---|---|---|
get_v1_referrals | GET /v1/referrals | Returns the caller's referral code, share link and the referrals they have made. |
post_v1_referrals_claim | POST /v1/referrals/claim | Records that the caller's org signed up through a referral code. |
sbom
| Tool | Route | Description |
|---|---|---|
get_v1_sbom_health | GET /v1/sbom/health | Health is a pure liveness probe: the service is up; datastore reflects whether the datastore store is… |
post_v1_sbom | POST /v1/sbom | Ingest persists a CycloneDX SBOM's components keyed by image digest. |
settings
| Tool | Route | Description |
|---|---|---|
get_v1_settings_product | GET /v1/settings/{product} | GetSettings reads the caller org's configuration for one product, with every secret field MASKED — only the… |
put_v1_settings_product | PUT /v1/settings/{product} | PutSettings writes the caller org's configuration for one product and answers the stored result, secrets… |
share
| Tool | Route | Description |
|---|---|---|
get_v1_share | GET /v1/share | ListShares returns the tunnel shares the caller's org currently has open, across every environment that org… |
post_v1_share_enable | POST /v1/share/enable | Enable provisions the caller org's tunnel account and returns the credential the hanzo share CLI needs to… |
translate
| Tool | Route | Description |
|---|---|---|
get_v1_translate_memory | GET /v1/translate/memory | List returns the org's own translation-memory entries, newest first, optionally narrowed to one target… |
put_v1_translate_memory | PUT /v1/translate/memory | Review records a human decision on one translation-memory entry, and returns the entry as stored. |
audit
| Tool | Route | Description |
|---|---|---|
get_v1_audit | GET /v1/audit | List reads the caller's OWN org audit trail, newest first, with the total the filter matched so a console can… |
base
| Tool | Route | Description |
|---|---|---|
get_v1_base_health | GET /v1/base/health | BaseHealth reports that the base subsystem is serving. |
bot
| Tool | Route | Description |
|---|---|---|
get_v1_bot_nodes | GET /v1/bot/nodes | Returns the caller org's currently connected bot nodes: what each one calls itself, the platform it runs on,… |
catalog
| Tool | Route | Description |
|---|---|---|
get_v1_catalog | GET /v1/catalog | Browse searches AND browses the cross-org catalog: every project, app and site the fleet has built, whichever… |
csrf
| Tool | Route | Description |
|---|---|---|
get_v1_csrf | GET /v1/csrf | IssueCSRFToken mints the anti-CSRF token a browser echoes as X-CSRF-Token on every money write (mint/revoke a… |
embed
| Tool | Route | Description |
|---|---|---|
get_v1_embed | GET /v1/embed | EmbedStatus reports whether one of this brand's shared embedded apps (cms, erp, help) may be framed by the… |
entitlements
| Tool | Route | Description |
|---|---|---|
get_v1_entitlements | GET /v1/entitlements | Projection reports which console apps the CALLER's org may open, and the plan slug that decides it. |
errors
| Tool | Route | Description |
|---|---|---|
get_v1_errors | GET /v1/errors | Errors returns the caller org's most recently captured errors, newest first. |
indexers
| Tool | Route | Description |
|---|---|---|
get_v1_indexers | GET /v1/indexers | ListIndexers reports the deployment's chain indexer(s) and how far each has indexed. |
mesh
| Tool | Route | Description |
|---|---|---|
get_v1_mesh_services | GET /v1/mesh/services | Returns the Zero Trust edge services the caller's org owns. |
notify
| Tool | Route | Description |
|---|---|---|
get_v1_notify_health | GET /v1/notify/health | Reports that the notify send surface is mounted. |
oracles
| Tool | Route | Description |
|---|---|---|
get_v1_oracles | GET /v1/oracles | ListOracles reports the on-chain price/data oracles from the graph's O-Chain PriceFeed registry. |
post
| Tool | Route | Description |
|---|---|---|
post_collaborator_rpc_documentId | POST /collaborator/rpc/{documentId} | CollabRPC is the collaborative-markup snapshot plane the Team front's editor speaks: createContent stores a… |
prefs
| Tool | Route | Description |
|---|---|---|
get_v1_prefs | GET /v1/prefs | GetPrefs returns the signed-in caller's OWN preference document — the theme, density and pinned nav that… |
summary
| Tool | Route | Description |
|---|---|---|
get_v1_summary | GET /v1/summary | GetSummary reports whether the platform is up. |
x402
| Tool | Route | Description |
|---|---|---|
get_v1_x402_settlements_id | GET /v1/x402/settlements/{id} | Settlement reads one x402 payment receipt by id. |
unmapped
| Tool | Route | Description |
|---|---|---|
adminCreateCredit | — | Mints credit for one org. It is the ONE admin mint surface, and it does NOT mint in-process: it forwards the… |
delete_v1_iam_keys | — | RevokeKey revokes the caller's own API key of the requested class. |
delete_v1_train_experiments_name | — | DeleteExperiment deletes a hyperparameter-tuning experiment. |
delete_v1_train_jobs_name | — | DeleteJob deletes a training job. Kubernetes garbage-collects the pods the trainer operator created under it,… |
get_v1_commerce_topup_rails | — | TopupRails lists the accepted (chain, token, treasury) triples, so a browser can render "send USDC here"… |
get_v1_edge_nodes | — | Returns the Zero Trust edge-routers the caller's org owns. |
get_v1_train_experiments | — | ListExperiments lists the caller org's tuning experiments. |
get_v1_train_experiments_name | — | GetExperiment returns one hyperparameter-tuning experiment. |
get_v1_train_experiments_name_trials | — | ListTrials lists the katib Trials one experiment owns. |
get_v1_train_jobs | — | ListJobs lists the training jobs in the caller's org. |
get_v1_train_jobs_name | — | GetJob returns one training job. Its spec comes with it, and the trainer operator's live status, which is… |
post_v1_commerce_topup_wallet | — | WalletTopup credits the caller's org for a stablecoin transfer they already sent to the treasury. |
Generated from tools/list on https://api.hanzo.ai/v1/mcp — 833 tools captured 2026-08-01, of which 755 are documented here (the operator surface is not published) (this build read the vendored copy; the door was unreachable).
How is this guide?