Hanzo
API Reference

Hanzo Cloud API

Hanzo Cloud Backend API — AI model management, inference, and usage tracking.

Hanzo Cloud Backend API — AI model management, inference, and usage tracking.

Hanzo Cloud API · Guide & examples → · All API references →

Base URLhttps://api.hanzo.ai
Version1.0.0
Operations177
GuideHanzo Cloud API guide

Authentication

  • BearerAuth — HTTP bearer

All Hanzo APIs share one bearer credential and common error and pagination conventions. See API conventions.

curl -H "Authorization: Bearer $HANZO_API_KEY" https://api.hanzo.ai

Endpoints

Account API

MethodEndpointDescription
GET/v1/cloud/get-accountApi Controller Get Account
POST/v1/cloud/signinApi Controller Signin
POST/v1/cloud/signoutApi Controller Signout

Activity API

MethodEndpointDescription
GET/v1/cloud/get-activitiesApi Controller Get Activities

Agent Sessions API

MethodEndpointDescription
GET/v1/agents/sessionsAgentSessionsController.List
POST/v1/agents/sessionsAgentSessionsController.Register
GET/v1/agents/sessions/streamAgentSessionsController.Stream
GET/v1/agents/sessions/{id}AgentSessionsController.Get
PATCH/v1/agents/sessions/{id}AgentSessionsController.Patch
GET/v1/agents/sessions/{id}/treeAgentSessionsController.Tree
POST/v1/agents/sessions/{id}/eventsAgentSessionsController.AppendEvent
POST/v1/agents/sessions/{id}/pauseAgentSessionsController.Pause
POST/v1/agents/sessions/{id}/resumeAgentSessionsController.Resume
POST/v1/agents/sessions/{id}/stopAgentSessionsController.Stop
POST/v1/agents/sessions/{id}/messageAgentSessionsController.Message

Agents API

MethodEndpointDescription
GET/v1/agentsAgentsController.List
POST/v1/agentsAgentsController.Create
GET/v1/agents/{ref}AgentsController.Get
PATCH/v1/agents/{ref}AgentsController.Update
DELETE/v1/agents/{ref}AgentsController.Delete
POST/v1/agents/{ref}/runAgentsController.Run
GET/v1/agents/{ref}/runsAgentsController.Runs
GET/v1/agents/metricsAgentsController.Metrics
GET/v1/agents/activityAgentsController.Activity

Application API

MethodEndpointDescription
POST/v1/cloud/add-applicationApi Controller Add Application
POST/v1/cloud/delete-applicationApi Controller Delete Application
POST/v1/cloud/deploy-applicationApi Controller Deploy Application
GET/v1/cloud/get-applicationApi Controller Get Application
GET/v1/cloud/get-application-statusApi Controller Get Application Status
GET/v1/cloud/get-applicationsApi Controller Get Applications
POST/v1/cloud/undeploy-applicationApi Controller Undeploy Application
POST/v1/cloud/update-applicationApi Controller Update Application

Article API

MethodEndpointDescription
POST/v1/cloud/add-articleApi Controller Add Article
POST/v1/cloud/delete-articleApi Controller Delete Article
GET/v1/cloud/get-articleApi Controller Get Article
GET/v1/cloud/get-articlesApi Controller Get Articles
GET/v1/cloud/get-global-articlesApi Controller Get Global Articles
POST/v1/cloud/update-articleApi Controller Update Article

Chat API

MethodEndpointDescription
POST/v1/cloud/add-chatApi Controller Add Chat
POST/v1/cloud/delete-chatApi Controller Delete Chat
GET/v1/cloud/get-chatApi Controller Get Chat
GET/v1/cloud/get-chatsApi Controller Get Chats
GET/v1/cloud/get-global-chatsApi Controller Get Global Chats
POST/v1/cloud/update-chatApi Controller Update Chat

Connection API

MethodEndpointDescription
POST/v1/cloud/add-connectionApi Controller Add Connection
GET/v1/cloud/add-node-tunnelApi Controller Add Node Tunnel
POST/v1/cloud/delete-connectionApi Controller Delete Connection
GET/v1/cloud/get-connectionApi Controller Get Connection
GET/v1/cloud/get-connectionsApi Controller Get Connections
GET/v1/cloud/get-node-tunnelApi Controller Get Node Tunnel
POST/v1/cloud/start-connectionApi Controller Start Connection
POST/v1/cloud/stop-connectionApi Controller Stop Connection
POST/v1/cloud/update-connectionApi Controller Update Connection

Container API

MethodEndpointDescription
POST/v1/cloud/add-containerApi Controller Add Container
POST/v1/cloud/delete-containerApi Controller Delete Container
GET/v1/cloud/get-containerApi Controller Get Container
GET/v1/cloud/get-containersApi Controller Get Containers
POST/v1/cloud/update-containerApi Controller Update Container

Deployment API

MethodEndpointDescription
GET/v1/cloud/get-k8s-statusApi Controller Get K8s Status

File API

MethodEndpointDescription
POST/v1/cloud/activate-fileApi Controller Activate File
POST/v1/cloud/add-fileApi Controller Add File
POST/v1/cloud/delete-fileApi Controller Delete File
GET/v1/cloud/get-active-fileApi Controller Get Active File
POST/v1/cloud/update-fileApi Controller Update File
POST/v1/cloud/upload-fileApi Controller Upload File

Form API

MethodEndpointDescription
POST/v1/cloud/add-formApi Controller Add Form
POST/v1/cloud/delete-formApi Controller Delete Form
GET/v1/cloud/get-formApi Controller Get Form
GET/v1/cloud/get-form-dataApi Controller Get Form Data
GET/v1/cloud/get-formsApi Controller Get Forms
GET/v1/cloud/get-global-formsApi Controller Get Global Forms
POST/v1/cloud/update-formApi Controller Update Form

Image API

MethodEndpointDescription
POST/v1/cloud/add-imageApi Controller Add Image
POST/v1/cloud/delete-imageApi Controller Delete Image
GET/v1/cloud/get-imageApi Controller Get Image
GET/v1/cloud/get-imagesApi Controller Get Images
POST/v1/cloud/update-imageApi Controller Update Image

Machine API

MethodEndpointDescription
POST/v1/cloud/add-machineApi Controller Add Machine
POST/v1/cloud/delete-machineApi Controller Delete Machine
GET/v1/cloud/get-machineApi Controller Get Machine
GET/v1/cloud/get-machinesApi Controller Get Machines
POST/v1/cloud/update-machineApi Controller Update Machine

Message API

MethodEndpointDescription
POST/v1/cloud/add-messageApi Controller Add Message
POST/v1/cloud/delete-messageApi Controller Delete Message
GET/v1/cloud/get-MessagesApi Controller Get Messages
GET/v1/cloud/get-answerApi Controller Get Answer
GET/v1/cloud/get-global-messagesApi Controller Get Global Messages
GET/v1/cloud/get-messageApi Controller Get Message
GET/v1/cloud/get-message-answerApi Controller Get Message Answer
POST/v1/cloud/update-messageApi Controller Update Message

Node API

MethodEndpointDescription
POST/v1/cloud/add-nodeApi Controller Add Node
POST/v1/cloud/delete-nodeApi Controller Delete Node
GET/v1/cloud/get-nodeApi Controller Get Node
GET/v1/cloud/get-nodesApi Controller Get Nodes
POST/v1/cloud/update-nodeApi Controller Update Node

Permission API

MethodEndpointDescription
POST/v1/cloud/add-permissionApi Controller Add Permission
POST/v1/cloud/delete-permissionApi Controller Delete Permission
GET/v1/cloud/get-permissionApi Controller Get Permission
GET/v1/cloud/get-permissionsApi Controller Get Permissions
POST/v1/cloud/update-permissionApi Controller Update Permission

Pod API

MethodEndpointDescription
POST/v1/cloud/add-podApi Controller Add Pod
POST/v1/cloud/delete-podApi Controller Delete Pod
GET/v1/cloud/get-podApi Controller Get Pod
GET/v1/cloud/get-podsApi Controller Get Pods
POST/v1/cloud/update-podApi Controller Update Pod

Provider API

MethodEndpointDescription
POST/v1/cloud/add-providerApi Controller Add Provider
POST/v1/cloud/delete-providerApi Controller Delete Provider
GET/v1/cloud/get-global-providersApi Controller Get Global Providers
GET/v1/cloud/get-providerApi Controller Get Provider
GET/v1/cloud/get-providersApi Controller Get Providers
POST/v1/cloud/refresh-mcp-toolsApi Controller Refresh Mcp Tools
POST/v1/cloud/update-providerApi Controller Update Provider

Record API

MethodEndpointDescription
POST/v1/cloud/add-recordApi Controller Add Record
POST/v1/cloud/add-recordsApi Controller Add Records
POST/v1/cloud/commit-recordApi Controller Commit Record
POST/v1/cloud/commit-record-secondApi Controller Commit Record Second
POST/v1/cloud/delete-recordApi Controller Delete Record
GET/v1/cloud/get-recordApi Controller Get Record
GET/v1/cloud/get-recordsApi Controller Get Records
GET/v1/cloud/query-recordApi Controller Query Record
GET/v1/cloud/query-record-secondApi Controller Query Record Second
POST/v1/cloud/update-recordApi Controller Update Record

STT API

MethodEndpointDescription
POST/v1/cloud/process-speech-to-textApi Controller Process Speech To Text

Search API

MethodEndpointDescription
POST/v1/search-docsProductController.SearchDocs
GET/v1/search-docs/indexesProductController.SearchIndexes
GET/v1/search-docs/statsProductController.SearchStats
POST/v1/chat-docsProductController.ChatDocs
POST/v1/index-docsProductController.IndexDocs

Storage Provider API

MethodEndpointDescription
GET/v1/cloud/get-storage-providersApi Controller Get Storage Providers

Store API

MethodEndpointDescription
POST/v1/cloud/add-storeApi Controller Add Store
POST/v1/cloud/delete-storeApi Controller Delete Store
GET/v1/cloud/get-global-storesApi Controller Get Global Stores
GET/v1/cloud/get-storeApi Controller Get Store
GET/v1/cloud/get-storesApi Controller Get Stores
POST/v1/cloud/refresh-store-vectorsApi Controller Refresh Store Vectors
POST/v1/cloud/update-storeApi Controller Update Store

System API

MethodEndpointDescription
GET/v1/cloud/get-prometheus-infoApi Controller Get Prometheus Info
GET/v1/cloud/get-system-infoApi Controller Get System Info
GET/v1/cloud/get-version-infoApi Controller Get Version Info
GET/healthApi Controller Health

TTS API

MethodEndpointDescription
POST/v1/cloud/generate-text-to-speech-audioApi Controller Generate Text To Speech Audio
GET/v1/cloud/generate-text-to-speech-audio-streamApi Controller Generate Text To Speech Audio Stream

Task API

MethodEndpointDescription
POST/v1/cloud/add-taskApi Controller Add Task
POST/v1/cloud/delete-taskApi Controller Delete Task
GET/v1/cloud/get-global-tasksApi Controller Get Global Tasks
GET/v1/cloud/get-taskApi Controller Get Task
GET/v1/cloud/get-tasksApi Controller Get Tasks
POST/v1/cloud/update-taskApi Controller Update Task

Template API

MethodEndpointDescription
POST/v1/cloud/add-templateApi Controller Add Template
POST/v1/cloud/delete-templateApi Controller Delete Template
GET/v1/cloud/get-templateApi Controller Get Template
GET/v1/cloud/get-templatesApi Controller Get Templates
POST/v1/cloud/update-templateApi Controller Update Template

Usage API

MethodEndpointDescription
GET/v1/cloud/get-range-usagesApi Controller Get Range Usages
GET/v1/cloud/get-usagesApi Controller Get User Table Infos
GET/v1/cloud/get-usersApi Controller Get Users

Vector API

MethodEndpointDescription
POST/v1/cloud/add-vectorApi Controller Add Vector
POST/v1/cloud/delete-all-vectorsApi Controller Delete All Vectors
POST/v1/cloud/delete-vectorApi Controller Delete Vector
GET/v1/cloud/get-global-vectorsApi Controller Get Global Vectors
GET/v1/cloud/get-vectorsApi Controller Get Vectors
POST/v1/cloud/update-vectorApi Controller Update Vector
GET/v1/vector/collectionsProductController.VectorCollections
GET/v1/vector/statsProductController.VectorStats

Video API

MethodEndpointDescription
POST/v1/cloud/add-videoApi Controller Add Video
POST/v1/cloud/delete-videoApi Controller Delete Video
GET/v1/cloud/get-global-videosApi Controller Get Global Videos
GET/v1/cloud/get-videoApi Controller Get Video
GET/v1/cloud/get-videosApi Controller Get Videos
POST/v1/cloud/update-videoApi Controller Update Video
POST/v1/cloud/upload-videoApi Controller Upload Video

Workflow API

MethodEndpointDescription
POST/v1/cloud/add-workflowApi Controller Add Workflow
POST/v1/cloud/delete-workflowApi Controller Delete Workflow
GET/v1/cloud/get-global-workflowsApi Controller Get Global Workflows
GET/v1/cloud/get-workflowApi Controller Get Workflow
GET/v1/cloud/get-workflowsApi Controller Get Workflows
POST/v1/cloud/update-workflowApi Controller Update Workflow

Hanzo Cloud API guide · All Hanzo APIs · OpenAPI spec

How is this guide?

On this page

AuthenticationEndpointsAccount APIActivity APIAgent Sessions APIAgents APIApplication APIArticle APIChat APIConnection APIContainer APIDeployment APIFile APIForm APIImage APIMachine APIMessage APINode APIPermission APIPod APIProvider APIRecord APISTT APISearch APIStorage Provider APIStore APISystem APITTS APITask APITemplate APIUsage APIVector APIVideo APIWorkflow API