Run workflow
run_workflowStart a run. Spends credits, so the user must approve the cost first.
Needs estimate_run's run_token and the SAME script_text. Without confirm=true it starts nothing and returns the price to show the user; call again with confirm=true once they agree. Returns run_id and status; then poll get_run_status.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | No | false returns the price and starts nothing. true SPENDS credits — only after the user agrees. | |
| run_token | Yes | From estimate_run, bound to that workflow, graph and script_text. Expires in 10 minutes and is spent by the first run that starts. | |
| script_text | No | Replaces the workflow's stored script. estimate_run and run_workflow must get the SAME text. | |
| workflow_id | Yes | The workflow_id from list_workflows. Never invent one. | |
| dictionary_mode | No | Which dictionary entries this run applies. Omit to use the workflow's setting. | |
| source_language | No | Locale of script_text, e.g. `ko-kr`. Must match the one given to estimate_run. | |
| dictionary_entry_ids | No | Entry ids from scan_script_for_dictionary_entries. Only with dictionary_mode='selected'. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| run_id | No | ||
| status | No | ||
| created | No | ||
| next_step | No | ||
| max_credits | No | ||
| workflow_name | No | ||
| workspace_slug | No | ||
| current_balance | No | ||
| run_console_url | No | ||
| expected_credits | No | ||
| workflow_summary | No | ||
| requires_confirmation | No | ||
| estimated_overage_cents | No |