DOCS
Reference

API: Test plans

Test plans: Draft or revise a plan.

Draft or revise a plan

POST/api/v1/plan

Have the assistant draft a test from a plain-language description, or revise a plan, without saving anything. Returns the proposed steps, checks, values to record, assumptions and any questions only the requester can answer. Show the plan to the requester; to change it, call again with plan and change; to answer questions, pass answers. Once they confirm, pass the plan to create_test. When no question is open the plan has passed the planning review (review.ok). Pass projectId so the assistant knows the project's sign-in accounts and endpoints. Each call uses one assistant draft of the workspace's daily allowance.

MCP tool: plan_test. Needs a key that can also create and edit tests.

Body (JSON)
descriptionstringrequired
What to test, as you would brief a colleague
urlstring
Start address (https://…); omit for app tests
projectIdstring
Project id (p_…), optional
platformweb | android | ios
web (default), android or ios
appIdstring
Apps: package name or bundle id
planobject
A plan from an earlier plan_test call, to revise
changestring
With plan: what to change, for example "also check the price on the cart page"
answersobject
Answers to the questions of an earlier plan_test call, keyed by question id

Returns { plan: { title, startUrl, steps, checks, record, assumptions, credentials, questions }, requirement, reply, questions, review, draftsLeftToday }

Request
curl -X POST https://app.testsy.dev/api/v1/plan \
  -H "Authorization: Bearer $QA_AI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"description":"Add a shirt to the cart and check the total matches its price."}'