Skip to main content
POST
Run Test Scenario

Headers

string
required
Your API key for authentication.

Path Parameters

string
required
The scenario ID to run.

Body

integer
Pathway version to test. Defaults to the current production version.
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.
string
URL to receive a webhook when the run completes. The webhook payload will include the full run result.

Response

string
The unique identifier for the test run.
string
The current status of the run. Will be RUNNING immediately after creation.
This endpoint is rate limited per organization. If you need to run multiple scenarios at once, consider using the Batch Run endpoint instead.

Docs for agents: llms.txt