VAvapiai
Simulation Suites

Edit a generated simulation suite

Changed on

Revise a suite created by POST /eval/simulation/onboarding/suite. Remove simulations, rewrite scenarios using natural-language instructions, or set retryFailed to regenerate scenarios that failed or exceeded generation limits. The response includes the updated suite and requirement coverage.

Requests can take up to 2 minutes.

Send a new patchKey for each edit. Replaying an applied key changes nothing and returns the current suite, with failedEditSimulationIds listing the simulations that edit could not rewrite, so retry a timeout or a 5xx with the same key. A suite remembers its last 50 keys, so never reuse one.

Each organization can make 60 edits per UTC day, shared with the dashboard. Requests that only remove simulations and replays of applied edits do not count toward this limit. On a 429 SIMULATION_ONBOARDING_QUOTA_EXCEEDED, wait until the daily limit resets at 00:00 UTC before retrying.

patch/eval/simulation/onboarding/suite/{suiteId}

Request

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

Path parameters

suiteIdstring required

Request body

patchKeystring required

A new key for each edit. Replaying an applied key changes nothing and returns the current suite. A suite remembers its last 50 keys, so never reuse one.

removeSimulationIdsstring[]

Simulations to take out of the suite. They are unlinked, not deleted.

retryFailedboolean

Regenerate the scenarios that failed or did not fit when the suite was generated.

Response

assistantIdstring required

Assistant the suite is assigned to.

reusedboolean required

True when the request matched one already applied (same idempotencyKey or patchKey) and nothing changed.

failedEditSimulationIdsstring[]

Simulations an edit asked to rewrite that were not rewritten, for example because the rewrite did not generate in time. Retry them with a new patchKey.

Changes

Some revisions have not been checked yet.