Vapi · Schema

CreateSimulationDTO

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
name string This is an optional friendly name for the simulation.
scenarioId string This is the ID of the scenario to use for this simulation.
personalityId string This is the ID of the personality to use for this simulation.
path string Optional folder path for organizing simulations. Supports up to 3 levels (e.g., "dept/feature/variant"). Maps to GitOps resource folder structure.
View JSON Schema on GitHub

JSON Schema

vapi-createsimulationdto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateSimulationDTO",
  "title": "CreateSimulationDTO",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "This is an optional friendly name for the simulation.",
      "maxLength": 80,
      "example": "Eligible Path with Confused User"
    },
    "scenarioId": {
      "type": "string",
      "description": "This is the ID of the scenario to use for this simulation.",
      "format": "uuid"
    },
    "personalityId": {
      "type": "string",
      "description": "This is the ID of the personality to use for this simulation.",
      "format": "uuid"
    },
    "path": {
      "type": "string",
      "nullable": true,
      "description": "Optional folder path for organizing simulations.\nSupports up to 3 levels (e.g., \"dept/feature/variant\").\nMaps to GitOps resource folder structure.",
      "maxLength": 255,
      "pattern": "/^[a-zA-Z0-9][a-zA-Z0-9._-]*(?:\\/[a-zA-Z0-9][a-zA-Z0-9._-]*){0,2}$/"
    }
  },
  "required": [
    "scenarioId",
    "personalityId"
  ]
}