Hanzo Auto API

Hanzo Auto is a workflow automation platform for building trigger-based

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


Base URL	`https://auto.hanzo.ai`
Version	1.0.0
Operations	69
Guide	Hanzo Auto 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://auto.hanzo.ai

Endpoints

ai-providers

Method	Endpoint	Description
`GET`	`/v1/auto/ai-providers`	List configured AI providers
`POST`	`/v1/auto/ai-providers`	Add or update an AI provider
`DELETE`	`/v1/auto/ai-providers/{provider}`	Delete an AI provider

api-keys

Method	Endpoint	Description
`GET`	`/v1/auto/api-keys`	List API keys (EE)
`POST`	`/v1/auto/api-keys`	Create an API key (EE)
`DELETE`	`/v1/auto/api-keys/{id}`	Delete an API key (EE)

app-connections

Method	Endpoint	Description
`GET`	`/v1/auto/app-connections`	List app connections
`POST`	`/v1/auto/app-connections`	Upsert an app connection
`POST`	`/v1/auto/app-connections/{id}`	Update an app connection
`DELETE`	`/v1/auto/app-connections/{id}`	Delete an app connection

audit-events

Method	Endpoint	Description
`GET`	`/v1/auto/audit-events`	List audit log events (EE)

authentication

Method	Endpoint	Description
`POST`	`/v1/auto/authentication/sign-up`	Sign up a new user
`POST`	`/v1/auto/authentication/sign-in`	Sign in with credentials

fields

Method	Endpoint	Description
`GET`	`/v1/auto/fields`	List fields for a table
`POST`	`/v1/auto/fields`	Create a field in a table

flags

Method	Endpoint	Description
`GET`	`/v1/auto/flags`	Get feature flags and configuration

flow-runs

Method	Endpoint	Description
`GET`	`/v1/auto/flow-runs`	List flow runs
`GET`	`/v1/auto/flow-runs/{id}`	Get a flow run by id
`POST`	`/v1/auto/flow-runs/{id}/requests/{requestId}`	Resume a paused flow run with human input
`POST`	`/v1/auto/flow-runs/{id}/retry`	Retry a failed flow run

flows

Method	Endpoint	Description
`GET`	`/v1/auto/flows`	List flows
`POST`	`/v1/auto/flows`	Create a flow
`GET`	`/v1/auto/flows/count`	Count flows
`GET`	`/v1/auto/flows/{id}`	Get a flow by id
`POST`	`/v1/auto/flows/{id}`	Apply an operation to a flow
`DELETE`	`/v1/auto/flows/{id}`	Delete a flow
`GET`	`/v1/auto/flows/{id}/template`	Export flow as template

folders

Method	Endpoint	Description
`GET`	`/v1/auto/folders`	List folders
`POST`	`/v1/auto/folders`	Create a folder
`GET`	`/v1/auto/folders/{id}`	Get a folder by id
`POST`	`/v1/auto/folders/{id}`	Update a folder
`DELETE`	`/v1/auto/folders/{id}`	Delete a folder

git-repos

Method	Endpoint	Description
`GET`	`/v1/auto/git-repos`	List connected git repos (EE)
`POST`	`/v1/auto/git-repos`	Connect a git repo for sync (EE)

global-connections

Method	Endpoint	Description
`GET`	`/v1/auto/global-connections`	List platform-wide connections (EE)

health

Method	Endpoint	Description
`GET`	`/v1/auto/health`	Health check
`GET`	`/v1/auto/docs`	Get auto-generated OpenAPI documentation

mcp

Method	Endpoint	Description
`GET`	`/v1/auto/projects/{projectId}/mcp-server`	Get MCP server configuration for a project

pieces

Method	Endpoint	Description
`GET`	`/v1/auto/pieces`	List available pieces
`GET`	`/v1/auto/pieces/categories`	List piece categories
`GET`	`/v1/auto/pieces/versions`	List available versions of a piece
`POST`	`/v1/auto/pieces/options`	Get dynamic property options for a piece action/trigger
`GET`	`/v1/auto/pieces/{name}`	Get piece metadata by name

platform

Method	Endpoint	Description
`GET`	`/v1/auto/platforms/{id}`	Get platform settings
`POST`	`/v1/auto/platforms/{id}`	Update platform settings

project-members

Method	Endpoint	Description
`GET`	`/v1/auto/project-members`	List project members (EE)

project-roles

Method	Endpoint	Description
`GET`	`/v1/auto/project-roles`	List project roles (EE)

projects

Method	Endpoint	Description
`GET`	`/v1/auto/projects`	List projects
`GET`	`/v1/auto/projects/{id}`	Get a project by id
`POST`	`/v1/auto/projects/{id}`	Update project settings

records

Method	Endpoint	Description
`GET`	`/v1/auto/records`	List records in a table
`POST`	`/v1/auto/records`	Create a record

sample-data

Method	Endpoint	Description
`GET`	`/v1/auto/sample-data`	Get sample data for a flow step

store-entries

Method	Endpoint	Description
`GET`	`/v1/auto/store-entries`	List store entries
`POST`	`/v1/auto/store-entries`	Create or update a store entry
`GET`	`/v1/auto/store-entries/{key}`	Get a store entry by key
`DELETE`	`/v1/auto/store-entries/{key}`	Delete a store entry

tables

Method	Endpoint	Description
`GET`	`/v1/auto/tables`	List tables
`POST`	`/v1/auto/tables`	Create a table

templates

Method	Endpoint	Description
`GET`	`/v1/auto/templates`	List flow templates

todos

Method	Endpoint	Description
`GET`	`/v1/auto/todos`	List todos

triggers

Method	Endpoint	Description
`GET`	`/v1/auto/trigger-events`	List trigger events for a flow
`POST`	`/v1/auto/test-trigger`	Test a trigger and get sample data
`GET`	`/v1/auto/trigger-runs`	List trigger run history

user-invitations

Method	Endpoint	Description
`GET`	`/v1/auto/user-invitations`	List pending invitations
`POST`	`/v1/auto/user-invitations`	Invite a user to a project

users

Method	Endpoint	Description
`GET`	`/v1/auto/users`	List platform users

webhooks

Method	Endpoint	Description
`POST`	`/v1/auto/webhooks/{flowId}`	Receive incoming webhook for a flow trigger
`POST`	`/v1/auto/webhooks/{flowId}/sync`	Receive webhook and wait for flow run result

Hanzo Auto API guide · All Hanzo APIs · OpenAPI spec

On this page