Analytics1

Assistants5

Board6

Calls12

Campaigns11

Chats5

Eval9

Files5

Insight7

Knowledge Bases V29

Observability/Scorecard5

Phone Numbers6

Provider Resources5

Sessions5

Simulation Personalities5

Simulation Runs8

Simulation Scenarios5

Simulation Suites9

Simulations6

Squads5

Structured Outputs6

Tools5

Traffic Allocations5

Simulation Scenarios

Update Scenario

Changed on Nov 4, 2026

patch/eval/simulation/scenario/{id}

Request

Base URL
https://api.vapi.ai
Auth
HTTP bearer

Path parameters

idstring uuid required

The unique identifier for the resource.

Request body

namestring

This is the name of the scenario.

instructionsstring

This is the script/instructions for the tester to follow during the simulation.

pathstring nullable

Optional folder path for organizing scenarios. Supports up to 3 levels (e.g., "dept/feature/variant"). Set to null to remove from folder.

Response

idstring uuid required

This is the unique identifier for the scenario.

orgIdstring uuid required

This is the unique identifier for the organization this scenario belongs to.

createdAtstring date-time required

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

updatedAtstring date-time required

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

namestring required

This is the name of the scenario.

instructionsstring required

This is the script/instructions for the tester to follow during the simulation.

pathstring nullable

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

Changes

Nov 4, 2026d73a715574fb Revision changes
- breaking
  added to the ////// response property oneOf list for the response status
- breaking
  added to the ///////////// response property oneOf list for the response status
- breaking
  added to the /////////////////////// response property oneOf list for the response status
- breaking
  added to the /////////////////////// response property oneOf list for the response status
- breaking
  added to the /////////////////////// response property oneOf list for the response status
- breaking
  added to the /////////////////////// response property oneOf list for the response status
- breaking
  added to the /////////////////////// response property oneOf list for the response status
- breaking
  added to the /////////////////////// response property oneOf list for the response status
- breaking
  added to the /////////////////////// response property oneOf list for the response status
- breaking
  added to the /////////////////////// response property oneOf list for the response status
- breaking
  added to the /////////////////////// response property oneOf list for the response status
- breaking
  added to the /////////////////////// response property oneOf list for the response status
- breaking
  added to the /////////////////////// response property oneOf list for the response status
- breaking
  added to the /////////////////////// response property oneOf list for the response status
- breaking
  added to the /////////////////////// response property oneOf list for the response status
- breaking
  added to the //////////////////// response property oneOf list for the response status
- breaking
  added to the //////////////////// response property oneOf list for the response status
- breaking
  added to the //////////////////// response property oneOf list for the response status
- breaking
  added to the //////////////////// response property oneOf list for the response status
- breaking
  added to the //////////////////// response property oneOf list for the response status
- breaking
  added to the //////////////////// response property oneOf list for the response status
- breaking
  added to the //////////////////// response property oneOf list for the response status
- breaking
  added to the //////////////////// response property oneOf list for the response status
- breaking
  added to the //////////////////// response property oneOf list for the response status
- breaking
  added to the //////////////////// response property oneOf list for the response status
- breaking
  added to the //////////////////// response property oneOf list for the response status
- breaking
  added to the //////////////////// response property oneOf list for the response status
- breaking
  added to the //////////////////// response property oneOf list for the response status
- breaking
  added to the ///////////// response property oneOf list for the response status
- breaking
  added to the ///////////// response property oneOf list for the response status
- breaking
  added to the ///////////// response property oneOf list for the response status
- breaking
  added to the ///////////// response property oneOf list for the response status
- breaking
  added to the ///////////// response property oneOf list for the response status
- breaking
  added to the ///////////// response property oneOf list for the response status
- breaking
  added to the ///////////// response property oneOf list for the response status
- breaking
  added to the ///////////// response property oneOf list for the response status
- breaking
  added to the ///////////// response property oneOf list for the response status
- breaking
  added to the ///////////// response property oneOf list for the response status
- breaking
  added to the ///////////// response property oneOf list for the response status
- breaking
  added to the ///////////// response property oneOf list for the response status
- breaking
  added to the ///////////// response property oneOf list for the response status
- breaking
  added to the /////////////// response property oneOf list for the response status
- breaking
  added to the //////////// response property oneOf list for the response status
- breaking
  added to the ///// response property oneOf list for the response status
This list may be incomplete.
Oct 30, 20263572576b853f Revision changes
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the //////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////// request property oneOf list
- breaking
  removed from the /////////////////////// request property oneOf list
- breaking
  removed from the //////////////////// request property oneOf list
- breaking
  removed from the //////////////////// request property oneOf list
- breaking
  removed from the //////////////////// request property oneOf list
- breaking
  removed from the //////////////////// request property oneOf list
- breaking
  removed from the //////////////////// request property oneOf list
- breaking
  removed from the //////////////////// request property oneOf list
- breaking
  removed from the //////////////////// request property oneOf list
- breaking
  removed from the //////////////////// request property oneOf list
- breaking
  removed from the //////////////////// request property oneOf list
- breaking
  removed from the //////////////////// request property oneOf list
- breaking
  removed from the //////////////////// request property oneOf list
- breaking
  removed from the //////////////////// request property oneOf list
- breaking
  removed from the //////////////////// request property oneOf list
- breaking
  removed from the //////////////////// request property oneOf list
- breaking
  removed from the //////////////////// request property oneOf list
- breaking
  removed from the //////////////////// request property oneOf list
- breaking
  removed from the //////////////////// request property oneOf list
- breaking
  removed from the //////////////////// request property oneOf list
- breaking
  removed from the ///////////// request property oneOf list
- breaking
  removed from the ///////////// request property oneOf list
- breaking
  removed from the ///////////// request property oneOf list
- breaking
  removed from the ///////////// request property oneOf list
- breaking
  removed from the ///////////// request property oneOf list
- breaking
  removed from the ///////////// request property oneOf list
- breaking
  removed from the ///////////// request property oneOf list
- breaking
  removed from the ///////////// request property oneOf list
- breaking
  removed from the ///////////// request property oneOf list
- breaking
  removed from the ///////////// request property oneOf list
- breaking
  removed from the ///////////// request property oneOf list
- breaking
  removed from the ///////////// request property oneOf list
- breaking
  removed from the ///////////// request property oneOf list
- breaking
  removed from the ///////////// request property oneOf list
- breaking
  removed from the ///////////// request property oneOf list
- breaking
  removed from the ///////////// request property oneOf list
- breaking
  removed from the ///////////// request property oneOf list
- breaking
  removed from the ///////////// request property oneOf list
- breaking
  removed from the //////// request property oneOf list
- breaking
  removed from the //////// request property oneOf list
- breaking
  removed from the /////////////////// request property oneOf list
- breaking
  removed from the /////////////////// request property oneOf list
- breaking
  removed from the /////////////// request property oneOf list
- breaking
  removed from the //////////// request property oneOf list
- breaking
  removed from the ///// request property oneOf list
This list may be incomplete.

Some revisions have not been checked yet.

Operation history (10 revisions)