Create Simulation Run
Authentication
Authenticate server-side requests with a private Vapi API key. Create or copy a key from the Vapi Dashboard and send it in the Authorization header as Bearer <token>. Keep private API keys out of client-side code and public repositories.
Headers
Makes the request safe to retry. A retry with the same key and the same body returns the run the first request created, with reused: true, instead of starting another. Reusing a key with a different body returns 409. Up to 255 printable ASCII characters, scoped to your organization; a key stays bound to its run while the run exists.
Request
Array of simulations and/or suites to run
Number of times to run each simulation (default: 1)
Response
ISO 8601 date-time when created
ISO 8601 date-time when last updated
Array of simulations and/or suites to run
Number of times to run each simulation (default: 1)
True when the request carried an Idempotency-Key that an earlier request already used with the same body: this is the run that request created, and no new run was started. False or absent when this request created the run.