Plan Workflow
plan_workflowPreview what a workflow WOULD do, without running it. Costs nothing and runs no models: returns the step execution order, each step's role/model/max_tokens and whether it pauses for a human checkpoint, the workflow's declared parameters (validated if you supply values), which required integrations your account already has credentials on file for, an upper-bound cost estimate, and definition_sha — a fingerprint of the definition this plan was built from, which tells you whether the definition changed between planning and running but never hands back the definition itself. Starts no session and records no usage. Use before run_workflow to check a pipeline fits before spending on it. Requires authentication.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workflow | Yes | The workflow slug (from list_workflows), e.g. 'due_diligence'. | |
| parameters | No | Optional values for the workflow's declared parameters, as a flat name-to-value object, e.g. {"region": "EU"}. Supply them to have them validated; omit to skip validation. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| text | Yes |