Adds a new DRAFT version to a flow.
Adds a new DRAFT version to a flow. The version is created invalid unless it carries a trigger, and it does not become the running version until it is…
POST /v1/auto/flows/{id}/versions
| Address | https://api.hanzo.ai/v1/auto/flows/{id}/versions |
| Method | POST |
| Operation | post_auto_flows_by_id_versions |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Adds a new DRAFT version to a flow. The version is created invalid unless it carries a trigger, and it does not become the running version until it is published (PATCH the flow's publishedVersionId) or becomes the latest.
Request
30 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID is the flow to add a version to, from the path. |
displayName | body | string | — | DisplayName names the new version. |
id | body | string | — | ID is the flow to add a version to, from the path. |
trigger | body | FlowTrigger | — | |
trigger.displayName | body | string | — | |
trigger.name | body | string | — | |
trigger.nextAction | body | FlowAction | — | |
trigger.nextAction.displayName | body | string | — | |
trigger.nextAction.name | body | string | — | |
trigger.nextAction.nextAction | body | FlowAction | — | |
trigger.nextAction.settings | body | StepSettings | — | |
trigger.nextAction.settings.actionName | body | string | — | |
trigger.nextAction.settings.input | body | object | — | |
trigger.nextAction.settings.input.* | body | object | — | |
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 | StepSettings | — | |
trigger.settings.actionName | body | string | — | |
trigger.settings.input | body | object | — | |
trigger.settings.input.* | body | object | — | |
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 | FlowVersion | created |
201 body — 35 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
created | body | integer | — | |
displayName | body | string | — | |
flowId | body | string | — | |
id | body | string | — | |
schemaVersion | body | string | — | |
state | body | string | — | |
trigger | body | FlowTrigger | — | |
trigger.displayName | body | string | — | |
trigger.name | body | string | — | |
trigger.nextAction | body | FlowAction | — | |
trigger.nextAction.displayName | body | string | — | |
trigger.nextAction.name | body | string | — | |
trigger.nextAction.nextAction | body | FlowAction | — | |
trigger.nextAction.settings | body | StepSettings | — | |
trigger.nextAction.settings.actionName | body | string | — | |
trigger.nextAction.settings.input | body | object | — | |
trigger.nextAction.settings.input.* | body | object | — | |
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 | StepSettings | — | |
trigger.settings.actionName | body | string | — | |
trigger.settings.input | body | object | — | |
trigger.settings.input.* | body | object | — | |
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 | — | |
updated | body | integer | — | |
valid | body | boolean | — |
Failure carries the platform error shape — see Errors.
Examples
hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.
import { Configuration, AutoApi } from 'hanzoai';
const api = new AutoApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postAutoFlowsByIdVersions({ id: 'id', displayName: "<displayName>", 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_versions(id='id', display_name="<displayName>", id="<id>")cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.AutoAPI.PostAutoFlowsByIdVersions(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::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_versions(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.AutoApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new AutoApi(client).postAutoFlowsByIdVersions();The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl -X POST https://api.hanzo.ai/v1/auto/flows/<id>/versions \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"displayName": "<displayName>",
"id": "<id>"
}'The door reaches auto through the auto tool, which names its 11 operations with its own verbs — this one among them, under a name only the door 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"
}
}
}'How is this guide?