Vapi · Schema

GeneratedScenario

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
name string Short descriptive name
instructions string Instructions for the tester
category string Scenario category
reasoning string Why this scenario is valuable
View JSON Schema on GitHub

JSON Schema

vapi-generatedscenario-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GeneratedScenario",
  "title": "GeneratedScenario",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Short descriptive name"
    },
    "instructions": {
      "type": "string",
      "description": "Instructions for the tester"
    },
    "category": {
      "type": "string",
      "enum": [
        "happy_path",
        "edge_case",
        "failure_mode"
      ],
      "description": "Scenario category"
    },
    "reasoning": {
      "type": "string",
      "description": "Why this scenario is valuable"
    }
  },
  "required": [
    "name",
    "instructions",
    "category",
    "reasoning"
  ]
}