Generate Scenarios with AI

POST

https://api.vapi.ai/eval/simulation/scenario/generate

Generates scenarios for an assistant or squad by analyzing its configuration with AI.

Authentication

AuthorizationBearer

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the Vapi Dashboard and send it in the Authorization header as Bearer <token>. Keep private API keys out of client-side code and public repositories.

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the [Vapi Dashboard](https://dashboard.vapi.ai) and send it in the `Authorization` header as `Bearer <token>`. Keep private API keys out of client-side code and public repositories.

Request

This endpoint expects an object.

assistantIdstringOptional

ID of the assistant to generate scenarios for

squadIdstringOptional

ID of the squad to generate scenarios for

Response

scenarioslist of objects

Generated scenarios

coverageNotesstring

Summary of test coverage

$	curl -X POST https://api.vapi.ai/eval/simulation/scenario/generate \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"scenarios": [
3	{
4	"name": "string",
5	"instructions": "string",
6	"category": "happy_path",
7	"reasoning": "string"
8	}
9	],
10	"coverageNotes": "string"
11	}

Authentication

Headers

Request

Response