Skip to main content
POST
/
v1
/
projects
/
{projectId}
/
runs
Start a test run
curl --request POST \
  --url https://api.stably.ai/v1/projects/{projectId}/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "playwrightProjectName": "<string>",
  "runGroupName": "<string>",
  "envOverrides": {},
  "environment": "<string>",
  "environmentName": "<string>",
  "autofix": true,
  "branch": "staging/dev"
}
'
{
  "runId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
projectId
string
required

Body

application/json
​
playwrightProjectName

Playwright project name(s) to run. Maps to --project CLI flag.

​
runGroupName
deprecated

Deprecated. Use playwrightProjectName instead.

​
envOverrides
object
​
environment
string

Name of the environment to use for this run (e.g. "Staging", "Production"). When omitted, falls back to the project's default environment.

​
environmentName
string
deprecated

Deprecated. Use environment instead.

​
autofix
boolean

When true, automatically attempt to fix failing tests after the run completes.

​
branch
string

Git branch to run tests against. When omitted, uses the project's default branch.

Required string length: 1 - 255
Example:

"staging/dev"

Response

Default Response

​
runId
string
required

ID to use for polling the run status and results