Run flows

Starts one durable run of a flow now.

POST /v1/auto/flows/{id}/run

Auto → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/auto/flows/{id}/run`
Method	`POST`
Operation	`post_auto_flows_by_id_run`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Starts one durable run of a flow now. It runs the flow's published version if one is pinned, else its latest, and answers the run record it created. The run is bounded by the org's per-minute run-start budget and its in-flight concurrency ceiling; over either, or with the engine not ready, no run is started and no run id is burned.

Request

1 field.

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the flow to act on, from the path.

Response

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

201 body — 8 fields.

Field	In	Type	Always
`created`	body	integer (int64)	—
`finishTime`	body	integer (int64)	—
`flowId`	body	string	—
`flowVersionId`	body	string	—
`id`	body	string	—
`startTime`	body	integer (int64)	—
`status`	body	string	—
`updated`	body	integer (int64)	—

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo auto flows run <id>

.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.postAutoFlowsByIdRun({ id: 'id' });

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_by_id_run(id='id')

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

resp, _, err := client.AutoAPI.PostAutoFlowsByIdRun(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_by_id_run(&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).postAutoFlowsByIdRun();

curl -X POST https://api.hanzo.ai/v1/auto/flows/<id>/run \
  -H "Authorization: Bearer $HANZO_API_KEY"

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 operations NextCreate versions