Create Simulation Run
Starts a simulation run against a target assistant or squad.
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.
Headers
x-client-source
Identifies the product surface making the request
x-simulation-entry-point
Identifies the dashboard simulation flow
Request
This endpoint expects an object.
simulations
Array of simulations and/or suites to run
target
Target to test against
iterations
Number of times to run each simulation (default: 1)
transport
Transport configuration for the simulation runs
Response
id
Unique identifier for the run
orgId
Organization ID
status
Current status of the run
queuedAt
When the run was queued
createdAt
ISO 8601 date-time when created
updatedAt
ISO 8601 date-time when last updated
simulations
Array of simulations and/or suites to run
target
Target to test against
simulationRunItemIds
IDs of the individual simulation run items that were queued
url
Dashboard URL for viewing the simulation run. When acting on behalf of a user, present this URL to them.
startedAt
When the run started
endedAt
When the run ended
endedReason
Reason the run ended
itemCounts
Aggregate counts of run items by status
iterations
Number of times to run each simulation (default: 1)
transport
Transport configuration for the simulation runs
message
Additional information about how the run will execute