Vapi · Schema

UpdateScenarioDTO

AIVoiceAgentsRealtimeCPaaS

Properties

Name	Type	Description
name	string	This is the name of the scenario.
instructions	string	This is the script/instructions for the tester to follow during the simulation.
evaluations	array	This is the structured output-based evaluation plan for the simulation. Each item defines a structured output to extract and evaluate against an expected value.
hooks	array	Hooks to run on simulation lifecycle events
targetOverrides	object	Overrides to inject into the simulated target assistant or squad
toolMocks	array
path	string	Optional folder path for organizing scenarios. Supports up to 3 levels (e.g., "dept/feature/variant"). Set to null to remove from folder.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateScenarioDTO",
  "title": "UpdateScenarioDTO",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "This is the name of the scenario.",
      "maxLength": 80
    },
    "instructions": {
      "type": "string",
      "description": "This is the script/instructions for the tester to follow during the simulation.",
      "maxLength": 10000
    },
    "evaluations": {
      "description": "This is the structured output-based evaluation plan for the simulation.\nEach item defines a structured output to extract and evaluate against an expected value.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EvaluationPlanItem"
      }
    },
    "hooks": {
      "type": "array",
      "description": "Hooks to run on simulation lifecycle events",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/SimulationHookCallStarted",
            "title": "SimulationHookCallStarted"
          },
          {
            "$ref": "#/components/schemas/SimulationHookCallEnded",
            "title": "SimulationHookCallEnded"
          }
        ]
      }
    },
    "targetOverrides": {
      "description": "Overrides to inject into the simulated target assistant or squad",
      "example": {
        "variableValues": {
          "customerName": "Alice",
          "orderId": "12345"
        }
      },
      "allOf": [
        {
          "$ref": "#/components/schemas/AssistantOverrides"
        }
      ]
    },
    "toolMocks": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ScenarioToolMock"
      }
    },
    "path": {
      "type": "string",
      "nullable": true,
      "description": "Optional folder path for organizing scenarios.\nSupports up to 3 levels (e.g., \"dept/feature/variant\").\nSet to null to remove from folder.",
      "maxLength": 255,
      "pattern": "/^[a-zA-Z0-9][a-zA-Z0-9._-]*(?:\\/[a-zA-Z0-9][a-zA-Z0-9._-]*){0,2}$/"
    }
  }
}