Create flows

Creates an automation and its initial DRAFT version in one call.

POST /v1/auto/flows

Auto → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/auto/flows`
Method	`POST`
Operation	`post_auto_flows`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Creates an automation and its initial DRAFT version in one call. The new flow is DISABLED — creating it does not arm its trigger; POST /v1/auto/flows/{id}/enable does that.

Request

30 fields, body application/json (required).

Field	In	Type	Required	Description
`displayName`	body	string	—	DisplayName names the flow's initial draft version.
`externalId`	body	string	—	ExternalID is the caller's own id for this flow.
`folderId`	body	string	—	FolderID groups the flow in the builder's tree.
`trigger`	body	auto.FlowTrigger	—
`trigger.displayName`	body	string	—
`trigger.name`	body	string	—
`trigger.nextAction`	body	auto.FlowAction	—
`trigger.nextAction.displayName`	body	string	—
`trigger.nextAction.name`	body	string	—
`trigger.nextAction.nextAction`	body	auto.FlowAction	—
`trigger.nextAction.settings`	body	auto.StepSettings	—
`trigger.nextAction.settings.actionName`	body	string	—
`trigger.nextAction.settings.input`	body	object	—
`trigger.nextAction.settings.input.*`	body	any	—
`trigger.nextAction.settings.pieceName`	body	string	—
`trigger.nextAction.settings.pieceVersion`	body	string	—
`trigger.nextAction.settings.triggerName`	body	string	—
`trigger.nextAction.skip`	body	boolean	—
`trigger.nextAction.type`	body	string	—	PIECE \| CODE \| ROUTER \| LOOP_ON_ITEMS
`trigger.nextAction.valid`	body	boolean	—
`trigger.settings`	body	auto.StepSettings	—
`trigger.settings.actionName`	body	string	—
`trigger.settings.input`	body	object	—
`trigger.settings.input.*`	body	any	—
`trigger.settings.pieceName`	body	string	—
`trigger.settings.pieceVersion`	body	string	—
`trigger.settings.triggerName`	body	string	—
`trigger.strategy`	body	string	—
`trigger.type`	body	string	—	PIECE_TRIGGER \| EMPTY
`trigger.valid`	body	boolean	—

Response

Status	Body	Meaning
`201`	auto.populatedFlow	created
`default`	problem-details	refused

201 body — 45 fields.

Field	In	Type	Always	Description
`created`	body	integer (int64)	—	Created and Updated are unix milliseconds.
`externalId`	body	string	—	ExternalID is the caller's own id for this flow, if it set one.
`folderId`	body	string	—	FolderID groups the flow in the builder's tree.
`id`	body	string	—	ID is the flow's id.
`metadata`	body	any	—	Metadata is the caller's opaque JSON, stored and returned verbatim.
`projectId`	body	string	—	Org is the owning org, which this surface names projectId.
`publishedVersionId`	body	string	—	PublishedVersionID is the version a run executes when set; empty means the latest version runs.
`status`	body	string	—	Status is ENABLED or DISABLED — whether the flow's trigger is armed.
`updated`	body	integer (int64)	—
`version`	body	auto.FlowVersion	—
`version.created`	body	integer (int64)	—
`version.displayName`	body	string	—
`version.flowId`	body	string	—
`version.id`	body	string	—
`version.schemaVersion`	body	string	—
`version.state`	body	string	—
`version.trigger`	body	auto.FlowTrigger	—
`version.trigger.displayName`	body	string	—
`version.trigger.name`	body	string	—
`version.trigger.nextAction`	body	auto.FlowAction	—
`version.trigger.nextAction.displayName`	body	string	—
`version.trigger.nextAction.name`	body	string	—
`version.trigger.nextAction.nextAction`	body	auto.FlowAction	—
`version.trigger.nextAction.settings`	body	auto.StepSettings	—
`version.trigger.nextAction.settings.actionName`	body	string	—
`version.trigger.nextAction.settings.input`	body	object	—
`version.trigger.nextAction.settings.input.*`	body	any	—
`version.trigger.nextAction.settings.pieceName`	body	string	—
`version.trigger.nextAction.settings.pieceVersion`	body	string	—
`version.trigger.nextAction.settings.triggerName`	body	string	—
`version.trigger.nextAction.skip`	body	boolean	—
`version.trigger.nextAction.type`	body	string	—	PIECE \| CODE \| ROUTER \| LOOP_ON_ITEMS
`version.trigger.nextAction.valid`	body	boolean	—
`version.trigger.settings`	body	auto.StepSettings	—
`version.trigger.settings.actionName`	body	string	—
`version.trigger.settings.input`	body	object	—
`version.trigger.settings.input.*`	body	any	—
`version.trigger.settings.pieceName`	body	string	—
`version.trigger.settings.pieceVersion`	body	string	—
`version.trigger.settings.triggerName`	body	string	—
`version.trigger.strategy`	body	string	—
`version.trigger.type`	body	string	—	PIECE_TRIGGER \| EMPTY
`version.trigger.valid`	body	boolean	—
`version.updated`	body	integer (int64)	—
`version.valid`	body	boolean	—

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo auto flows create

.ts

.py

.go

.rs

.java

import { Configuration, AutoApi } from 'hanzoai';

const api = new AutoApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postAutoFlows({ displayName: "<displayName>", externalId: "<externalId>" });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import AutoApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = AutoApi(client).post_auto_flows(display_name="<displayName>", external_id="<externalId>")

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.AutoAPI.PostAutoFlows(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, auto_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = auto_api::post_auto_flows(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.AutoApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new AutoApi(client).postAutoFlows();

curl -X POST https://api.hanzo.ai/v1/auto/flows \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "displayName": "<displayName>",
       "externalId": "<externalId>"
     }'

MCP reaches auto through the auto tool, which names its 14 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_auto_flows"
         }
       }
     }'

Auto API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousCreate versions NextCreate hooks