Simulation Suites

Draft simulation requirements

Changed on

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.

post/eval/simulation/onboarding/requirements

Request

  • Base URL
    https://api.vapi.ai
  • Auth
    HTTP bearer

Request body

assistantIdstring uuid required

Assistant to draft requirements for.

feedbackstring

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

Response

versionnumber required

Draft version, 1 for a first draft.

changeNotestring

What changed since the previous draft.

sourcesstring[] required

What the draft was based on, e.g. the prompt and tools.

Changes

Some revisions have not been checked yet.