Workflows v2 (Plays) / CLI
Compile workflow from prompt
Turn a natural-language description into a runnable workflow plan. The compiler reads the workspace context (ICP, integrations, available plays) and emits { plan, definition } where plan is a human-readable summary and definition is a WorkflowDefinition DAG ready to feed into update-workflow. Pass playIds to constrain the compiler to specific plays - otherwise it picks freely from the system catalogue.
pipeline compile-workflow-from-promptBackend AI, consent requiredParameters
workspaceIdRequired · string- Workspace UUID for compiler context (ICP, integrations, credentials). Required even with API key auth.
promptRequired · string- Plain-language description of the workflow you want. Example: "Every Monday, find 50 lookalikes of acme.com, enrich emails, push to my Q3 outreach campaign as drafts."
playIdsOptional · array- Optional. Restrict the compiler to these system play ids.
allowHostedAiOptional · boolean- Must be true when this operation uses Pipeline hosted inference.
pipeline compile-workflow-from-prompt \
--workspace-id "00000000-0000-4000-8000-000000000000" \
--prompt "example" \
--allow-hosted-aiFull input schema
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"description": "Workspace UUID for compiler context (ICP, integrations, credentials). Required even with API key auth."
},
"prompt": {
"type": "string",
"description": "Plain-language description of the workflow you want. Example: \"Every Monday, find 50 lookalikes of acme.com, enrich emails, push to my Q3 outreach campaign as drafts.\""
},
"playIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional. Restrict the compiler to these system play ids."
},
"allowHostedAi": {
"type": "boolean",
"description": "Must be true when this operation uses Pipeline hosted inference."
}
},
"required": [
"workspaceId",
"prompt"
]
}