Create flows

Saves a graph as a flow of yours.

POST /v1/studio/flows

Studio → · All API references → · Get started →

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

Saves a graph as a flow of yours. Start it with POST /v1/studio/runs {"flow": id}.

Request

14 fields, body application/json (required).

Field	In	Type	Required	Description
`description`	body	string	—
`graph`	body	studio.Graph	—
`graph.steps`	body	studio.Spec[]	—	Steps are the graph's steps, 1 to 64 of them.
`graph.steps[].each`	body	string	—	Each fans the step out: a {{path}} naming an array, run once per item (at most 64), its outputs the items' outputs in order.
`graph.steps[].id`	body	string	—	ID names the step within its graph: a lowercase letter, then up to 31 lowercase letters, digits or underscores.
`graph.steps[].op`	body	string	—	Op is what the step does: chat, image.generate, image.edit, voice.speak, music.generate, video.generate, model.generate, studio.render, render.html, render.document, render.slides, render.composition or video.edit.
`graph.steps[].title`	body	string	—	Title is what a person sees for the step.
`graph.steps[].with`	body	object	—	With are the op's parameters.
`graph.steps[].with.*`	body	any	—
`inputs`	body	object	—
`inputs.*`	body	any	—
`kind`	body	string	—
`name`	body	string	—
`shared`	body	boolean	—

Response

Status	Body	Meaning
`201`	studio.Flow	created
`default`	problem-details	refused

201 body — 19 fields.

Field	In	Type	Always	Description
`created`	body	string	—
`creator`	body	string	—
`description`	body	string	—
`graph`	body	studio.Graph	—
`graph.steps`	body	studio.Spec[]	—	Steps are the graph's steps, 1 to 64 of them.
`graph.steps[].each`	body	string	—	Each fans the step out: a {{path}} naming an array, run once per item (at most 64), its outputs the items' outputs in order.
`graph.steps[].id`	body	string	—	ID names the step within its graph: a lowercase letter, then up to 31 lowercase letters, digits or underscores.
`graph.steps[].op`	body	string	—	Op is what the step does: chat, image.generate, image.edit, voice.speak, music.generate, video.generate, model.generate, studio.render, render.html, render.document, render.slides, render.composition or video.edit.
`graph.steps[].title`	body	string	—	Title is what a person sees for the step.
`graph.steps[].with`	body	object	—	With are the op's parameters.
`graph.steps[].with.*`	body	any	—
`id`	body	string	—
`inputs`	body	object	—
`inputs.*`	body	any	—
`kind`	body	string	—
`name`	body	string	—
`org`	body	string	—
`shared`	body	boolean	—
`updated`	body	string	—

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo studio flows create

.ts

.py

.go

.rs

.java

import { Configuration, StudioApi } from 'hanzoai';

const api = new StudioApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postStudioFlows({ description: "<description>", graph: {"steps":[{"each":"<each>","id":"<id>","op":"<op>","title":"<title>"}]} });

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = StudioApi(client).post_studio_flows(description="<description>", graph={"steps":[{"each":"<each>","id":"<id>","op":"<op>","title":"<title>"}]})

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

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

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

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

let result = studio_api::post_studio_flows(&cfg, Default::default()).await?;

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

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

var result = new StudioApi(client).postStudioFlows();

curl -X POST https://api.hanzo.ai/v1/studio/flows \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "description": "<description>",
       "graph": {
         "steps": [
           {
             "each": "<each>",
             "id": "<id>",
             "op": "<op>",
             "title": "<title>"
           }
         ]
       }
     }'

MCP reaches studio through the studio tool, which names its 32 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_studio_brands"
         }
       }
     }'

Studio API · All Hanzo APIs · Interactive reference

Was this page useful?

Broken link or missing step? Drop it in #docs on Discord or open a PR.

PreviousCreate estimate NextCancel runs