Vapi Simulations

Build realistic conversation tests in five layers: a personality controls the AI tester, a scenario defines its intent and measurable outcomes, a simulation pairs them, a suite groups simulations, and a run executes them against an assistant or squad.

Source and Safety Rules

• Verify live payloads against the current Vapi documentation MCP, API reference, or public OpenAPI before sending them. Simulations use the /eval/simulation API family.
• Never print, request in chat, or embed API keys, provider secrets, credential values, private webhook URLs, or real customer data.
• Treat running a simulation as an external action. It can consume credits, use concurrency, send webhooks, and call the target's real tools unless they are mocked.
• Do not run, cancel, update, or delete resources unless the user clearly requests that operation. Draft configurations when mutation is not requested.
• Resolve every assistant, squad, personality, scenario, simulation, suite, tool, structured-output, and credential ID from user input or the API. Never invent an ID.
• Do not create legacy Test Suites. Use Evals for deterministic turn-by-turn checks and Simulations for dynamic conversations over chat or voice.

Procedure

1. Choose the test type and execution mode.
   • Use Simulations for multi-turn behavior, personality variation, squad handoffs, realistic tool paths, or audio behavior.
   • Use Evals instead when the requirement is an exact response, regex, fixed mock conversation, or precise tool-call argument check.
   • Return a test plan or payload when the user asks to design, draft, review, or explain. Perform live mutations only when explicitly requested and VAPI_API_KEY is available.