Skip to content

execute_workflow

Execute a workflow run to produce images or videos via a multi-step pipeline.

Returns immediately with a run ID. Poll with `get_workflow_run` for results.

Call `get_workflow_instructions` first for full workflow lifecycle guidance.

Parameters

ParameterTypeDefaultDescription
workflow_idrequiredstring (uuid)ID of the workflow to execute.
inputsstring{}A JSON object STRING mapping each of the workflow's input parameter keys to its value — e.g. '{"prompt": "a red panda astronaut"}'. This is a string: serialize the object yourself. Pass '{}' when the workflow takes no inputs. Use the input schema from `list_workflows` to build it.
workspace_idrequiredstring (uuid)The user's workspace id.
session_idstring (uuid)The Session ID to attach the results to.
session_namestringCreates a new session with this name. One of `session_name` or `session_id` must specified, but not both.