Skip to main content
POST
/
v1
/
agent-testing
/
scenarios
/
{id}
/
run
Run Test Scenario
curl --request POST \
  --url https://api.bland.ai/v1/agent-testing/scenarios/{id}/run \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '
{
  "version_number": 123,
  "request_data_override": {},
  "webhook_url": "<string>"
}
'
{
  "run_id": "a3f1b2c4-5d6e-7f8a-9b0c-1d2e3f4a5b6c",
  "status": "RUNNING"
}

​
Headers

​
authorization
string
required
Your API key for authentication.

​
Path Parameters

​
id
string
required
The scenario ID to run.

​
Body

​
version_number
integer
Pathway version to test. Defaults to the current production version.
​
request_data_override
object
Override the scenario’s request_data for this run. Any keys provided here will replace the corresponding keys in the scenario’s default request data.
​
webhook_url
string
URL to receive a webhook when the run completes. The webhook payload will include the full run result.

​
Response

​
run_id
string
The unique identifier for the test run.
​
status
string
The current status of the run. Will be RUNNING immediately after creation.
{
  "run_id": "a3f1b2c4-5d6e-7f8a-9b0c-1d2e3f4a5b6c",
  "status": "RUNNING"
}
This endpoint is rate limited per organization. If you need to run multiple scenarios at once, consider using the Batch Run endpoint instead.