Skip to main content
POST
Create test plan

Body

application/json
name
string
required

Plan name, unique among the project's test plans

Required string length: 1 - 200
description
string
Maximum string length: 2000
reviewInstructions
string

Guidance given to the PR review agent when this plan is used for PR checks

Maximum string length: 4000
testCaseIds
string[]

Project test case IDs to put in the plan. Only published test cases can be added.

Maximum array length: 500
projectShortId
string

Target a specific project by its prefixed short ID (proj-slug_shortId or proj_shortId), as returned by the projects API. Required for organization-scoped API keys; project-scoped keys may only pass their own project's short ID.

Pattern: ^proj(-.+_.+|_.+)$

Response

200 - application/json

The request has succeeded.

success
boolean
required
testPlan
object
required