Hanzo
API Reference

Hanzo Automations API

Connectors + Automations engine for Hanzo Cloud — the `/v1/automations/*`

Connectors + Automations engine for Hanzo Cloud — the /v1/automations/*

Hanzo Automations API · All API references →

Base URLhttps://api.hanzo.ai
Version1.0.0
Operations16

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

Flows

MethodEndpointDescription
GET/v1/automations/flowsList flows
POST/v1/automations/flowsCreate a flow (with an initial draft version)
GET/v1/automations/flows/{id}Get a flow and its latest version
PATCH/v1/automations/flows/{id}Update flow metadata
DELETE/v1/automations/flows/{id}Delete a flow (with its versions and runs)
GET/v1/automations/flows/{id}/versionsList a flow's versions
POST/v1/automations/flows/{id}/versionsCreate a draft version
POST/v1/automations/flows/{id}/operationsApply a flow operation to the latest version
POST/v1/automations/flows/{id}/enableEnable a flow (POLLING triggers create a schedule)
POST/v1/automations/flows/{id}/disableDisable a flow (removes any POLLING schedule)

MCP

MethodEndpointDescription
POST/v1/automations/mcpJSON-RPC 2.0 tool surface over connector actions

Pieces

MethodEndpointDescription
GET/v1/automations/piecesList the connector/piece catalogue

Runs

MethodEndpointDescription
POST/v1/automations/flows/{id}/runStart a durable run of a flow's runnable version
GET/v1/automations/runsList runs
GET/v1/automations/runs/{id}Get a run (non-terminal status is refreshed from the engine)
POST/v1/automations/runs/{id}/resumeResume a paused run

All Hanzo APIs · OpenAPI spec

How is this guide?

On this page