VAvapiai
Simulations

Create Simulation

Changed on
post/eval/simulation

Request

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

Request body

namestring

This is an optional friendly name for the simulation.

scenarioIdstring uuid required

This is the ID of the scenario to use for this simulation.

personalityIdstring uuid required

This is the ID of the personality to use for this simulation.

pathstring nullable

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

Example request

{
  "name": "Eligible Path with Confused User"
}

Response

idstring uuid required

This is the unique identifier for the simulation.

orgIdstring uuid required

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

createdAtstring date-time required

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

updatedAtstring date-time required

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

namestring

This is an optional friendly name for the simulation.

scenarioIdstring uuid required

This is the ID of the scenario to use for this simulation.

personalityIdstring uuid required

This is the ID of the personality to use for this simulation.

pathstring nullable

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

Example response

{
  "name": "Eligible Path with Confused User"
}

Changes

  • 74c487628c18Revision changes
    • warning

      deleted the header request parameter x-client-source

    • warning

      deleted the header request parameter x-simulation-entry-point

    This list may be incomplete.

Some revisions have not been checked yet.