Skip to navigation
Simulation Suites

Draft simulation requirements

Generate draft test requirements from an assistant’s prompt, tools, and handoff configuration. The response includes numbered requirements describing expected behavior and open questions about behavior that needs clarification. Use this endpoint before generating a simulation suite.

Review the requirements and resolve any open questions. To revise a draft, send it as previousDraft together with natural-language feedback describing the changes or answers. Once the requirements are ready, pass them to POST /eval/simulation/onboarding/suite.

Requests can take up to 2 minutes. Each organization can draft requirements 60 times per UTC day, shared with the dashboard. A 429 SIMULATION_ONBOARDING_QUOTA_EXCEEDED response means the daily limit has been reached. Wait until the limit resets at 00:00 UTC before retrying.

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.

Request

This endpoint expects an object.
assistantIdstringRequiredformat: "uuid"
Assistant to draft requirements for.
previousDraftobjectOptional

The draft being revised, exactly as this endpoint returned it. Send it with feedback.

feedbackstringOptional<=8000 characters

Natural-language instructions for revising the requirements in previousDraft, including answers to open questions. Required when previousDraft is provided.

Response

versiondouble>=1
Draft version, 1 for a first draft.
sourceslist of strings
What the draft was based on, e.g. the prompt and tools.
requirementslist of objects
Draft test requirements describing the expected assistant behavior. Review and refine these before generating a simulation suite.
openQuestionslist of objects
Questions about ambiguous or missing assistant behavior to resolve before generating a simulation suite.
changeNotestringOptional<=1000 characters
What changed since the previous draft.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error