VAvapiai
Simulation Suites

Create Simulation Suite

Changed on
post/eval/simulation/suite

Request

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

Request body

namestring required

This is the name of the simulation suite.

slackWebhookUrlstring

This is the Slack webhook URL for notifications.

simulationIdsstring[] required

This is the list of simulation IDs to include in the suite.

pathstring nullable

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

Example request

{
  "name": "Checkout Flow Tests"
}

Response

idstring uuid required

This is the unique identifier for the simulation suite.

orgIdstring uuid required

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

createdAtstring date-time required

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

updatedAtstring date-time required

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

namestring required

This is the name of the simulation suite.

slackWebhookUrlstring

This is the Slack webhook URL for notifications.

pathstring nullable

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

simulationIdsstring[] required

This is the list of simulation IDs in this suite.

Example response

{
  "name": "Checkout Flow Tests"
}

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.