Cancel Simulation Run
Cancels the specified simulation run.
Authentication
AuthorizationBearer
Authenticate server-side requests with a private Vapi API key. Create or copy a key from the [Vapi Dashboard](https://dashboard.vapi.ai) and send it in the `Authorization` header as `Bearer <token>`. Keep private API keys out of client-side code and public repositories.
Path parameters
id
The unique identifier of the simulation run.
Headers
x-client-source
Identifies the product surface making the request
x-simulation-entry-point
Identifies the dashboard simulation flow
Response
id
Unique identifier for the run
orgId
Organization ID
status
The run’s current status. One of queued, running, or ended.
queuedAt
When the run was queued
createdAt
ISO 8601 date-time when created
updatedAt
ISO 8601 date-time when last updated
simulations
The simulations and suites included in the run.
target
The assistant or squad the run was tested against.
startedAt
When the run started
endedAt
When the run ended
endedReason
Why the run ended, when applicable.
itemCounts
Aggregate counts of the run's items by status.
iterations
The number of times each simulation was run. Defaults to 1.
transport
The transport used for the run, either voice or chat.