Skip to navigation
Simulations

Draft simulation requirements

Drafts the behaviours an assistant must get right, as numbered requirements plus open questions, from its prompt, tools and handoffs. This is the first step of building a simulation suite.

  1. Show the draft to your user and ask its open questions.
  2. To revise it, call again with previousDraft set to the draft and feedback set to what the user said, verbatim. Repeat until they agree.
  3. Generate the suite from the agreed requirements with POST /eval/simulation/onboarding/suite.

Takes up to 2 minutes. Each org can draft 60 times per UTC day, shared with the dashboard. On a 429 SIMULATION_ONBOARDING_QUOTA_EXCEEDED, don’t retry: tell your user the limit resets at 00:00 UTC.

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

What your user wants changed in previousDraft, in the user’s own words. Send it with previousDraft.

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
The requirements, for your user to review.
openQuestionslist of objects
Questions to ask your user before they agree.
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