[scott-lowe-vapi]

Description

Draft: merge when VapiAI/vapi#23422 (TEST-200) deploys. That PR publishes the onboarding endpoints and lists this guide as a merge gate. Linear: TEST-203. Stacked on #1342.

• New page Generate a simulation suite with the API (/observability/simulations-generate-api), added to the nav after Advanced. It covers:
  • beta key access, and the 404 for orgs without it
  • the five-step flow with cURL: draft, revise, generate with idempotencyKey, edit with patchKey, run with Idempotency-Key
  • request and response field tables
  • coverage and tool gap reasons
  • idempotency and retries: the in-progress and key-reused 409s
  • daily limits: 60 drafts, 20 generations and 60 edits per UTC day, at most 2 generating at once, with what doesn't count
  • the error table
• Advanced: troubleshooting rows for the TEST-192 run-create 400 (VapiAI/vapi#23407) and the Failed to create target call failure reason (VapiAI/vapi#23400).
• Composer: a Limitations bullet on the shared daily allowance.

Sources are the open stack's diffs (#23400, #23407, #23418–#23422). The 524 in the retry list comes from the endpoint's own operation description.

Before merge:

• Re-check every value against the merged code.
• Limits were verified against the code: they apply to all organizations, including Enterprise; no request field raises them.
• Confirm "contact support" is the right path for beta key access.
• Link the API reference pages once fern api update pulls the routes in.

What's New blurb:

Generate a simulation suite with the API (beta). Three new endpoints under /eval/simulation/onboarding run the same test-generation flow as Composer: draft numbered requirements from an assistant's prompt, tools, and handoffs, revise them with your feedback, then generate a saved suite whose simulations mock every tool that would reach an external system. The response reports which requirements are covered, which aren't and why, and any handoffs or transfers the simulations don't exercise. Edit the suite in place, then run it with POST /eval/simulation/run; an idempotencyKey makes every retry safe. Private API keys work for organizations enabled during the beta. Contact support to ask about beta access; and generation shares a free daily allowance per organization with Composer that resets at 00:00 UTC. Read Generate a test suite with the API.

Testing Steps

• fern check (5.151.1) passes: 0 errors. The 15 warnings match the untouched main baseline.
• Check the preview deployment once the endpoints are live on staging

[github-actions]

🌿 Preview your docs: https://vapi-preview-01a1526d-5544-7429-b82e-095836bfb9eb.docs.buildwithfern.com

[scott-lowe-vapi]

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

• TEST-203 docs: add the Simulations onboarding API guide #1344 👈 (View in Graphite)
• TEST-201 docs: bring Simulations pages up to date with Composer test generation and the run API #1342 : 1 other dependent PR (#1343 )
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[github-actions]

🌿 Preview your docs: https://vapi-preview-01a1527c-90fc-733c-869a-5f48d4798f2d.docs.buildwithfern.com

[github-actions]

🌿 Preview your docs: https://vapi-preview-01a1527c-d56f-7645-8012-59af756e398c.docs.buildwithfern.com

[stephenvapiai]

A few edit-pass notes inline: a reminder about the TODO comment, some terminology and wording fixes, and one question about patch keys. Most are suggestion blocks you can apply directly.

[github-actions]

🌿 Preview your docs: https://vapi-preview-01a1625d-dabc-75a3-ae61-e7a0f3ec11bc.docs.buildwithfern.com

[github-actions]

🌿 Preview your docs: https://vapi-preview-01a16261-1164-74d1-84bf-8d2c6b49e137.docs.buildwithfern.com