Start a simulation run
start_simulation_runStart a run of a simulation suite. This SPENDS the workspace's budget -- every attempt is metered, and a voice attempt costs synthesis and transcription too. preview_simulation_run returns the estimate without starting anything. idempotency_key is required and is what makes a retry safe: the same key returns the same run instead of starting a second one.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| agent_id | Yes | ||
| suite_id | Yes | ||
| scenario_ids | No | Run only these scenarios. Omit to run them all. This is how one run is confined to the offline scenarios and another to the spoken ones. | |
| pinned_source | No | ||
| idempotency_key | Yes | Required, and never generated for you: a key the caller chooses is the only thing that makes a retried start return the first run instead of paying for a second one. | |
| organization_id | No | Optional. Defaults to the authenticated workspace; when supplied it must be that workspace's id. |