run_playbook
Tests a Cognigy.AI flow by running a playbook scenario with assertions. Supports dry run validation before executing, returns pass/fail results.
Instructions
Runs a Cognigy.AI playbook test scenario against a flow. MUTATING: This executes test assertions. Use dryRun=true (default) to validate first. Returns pass/fail results with assertion details.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dryRun | No | If true (default), validates without running. Set to false to actually run the playbook. | |
| flowId | Yes | The reference ID of the flow to test | |
| localeId | Yes | The reference ID of the locale | |
| timeoutMs | No | Maximum time to wait for playbook completion (5-300 seconds, default 120) | |
| entrypoint | Yes | The snapshot or project ID to run against | |
| playbookId | Yes | The playbook ID to run | |
| pollIntervalMs | No | How often to check task status (1-10 seconds, default 3) |