Simulations

Delete Simulation

Deletes the specified simulation.

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

idstringRequiredformat: "uuid"
The unique identifier of the simulation.

Headers

x-client-sourcestringOptional
Identifies the product surface making the request
x-simulation-entry-pointstringOptional
Identifies the dashboard simulation flow

Response

idstringformat: "uuid"
This is the unique identifier for the simulation.
orgIdstringformat: "uuid"
This is the unique identifier for the organization this simulation belongs to.
createdAtdatetime

This is the ISO 8601 date-time string of when the simulation was created.

updatedAtdatetime

This is the ISO 8601 date-time string of when the simulation was last updated.

scenarioIdstringformat: "uuid"
This is the ID of the scenario to use for this simulation.
personalityIdstringformat: "uuid"
This is the ID of the personality to use for this simulation.
namestringOptional<=80 characters
This is an optional friendly name for the simulation.
pathstring or nullOptionalformat: "/^[a-zA-Z0-9][a-zA-Z0-9._-]*(?:\/[a-zA-Z0-9][a-zA-Z0-9._-]*){0,2}$/"<=255 characters

Optional folder path for organizing simulations. Supports up to 3 levels (e.g., “dept/feature/variant”). Maps to GitOps resource folder structure.