API regression testing

Set it up

Create a test plan

Pick the tests, then copy the plan short ID (pln_…).

POST /v1/run with testPlanShortId, plus URL or device overrides.

Poll the run and fail the job when the result is not passed.

qatech run calls the same API. qatech status waits for the result.

API key setup and the short IDs are on Other CI (API).

What works over the API

Capability	API
Review on a preview URL, before merge	Not this endpoint. A test plan run does not post a review. See the pull request API.
Review after merge, with no preview URL	Not this endpoint.
Run a regression test plan from CI	Yes. `POST /v1/run` with `testPlanShortId`. You can override the URL or device for that run.
Run that plan against a mobile build	Yes. Upload the build, then pass `applicationBuildShortId`. See Application builds.
Block the pipeline until the plan finishes	Yes. Poll Get run and fail the job when the result is not passed.
Schedule	On the test plan, with Manage Schedules. The API does not store a cron.

What you can override on a run

Preview or staging URL: set applications[].environment.url. See Preview Environments.

Environment custom headers: attach auth or protection-bypass headers with customHeaders. See Environment custom headers.

Device preset: pass devicePresetShortId to test mobile, tablet, or desktop without another test plan. See Start Run API.

Slack channel: send results for one run to a different channel. See Per-run overrides.

Post-run automation: poll Get run to update a status page, call a webhook, or send an alert when the run finishes.

What this does not do

It does not post a pull request review. Use API pull request testing for that.

It does not require GitHub, GitLab, Bitrise, or Envoyer. Those guides are convenience wrappers around this call.

It does not schedule itself. Manage Schedules on the test plan runs it with no CI at all. See Manual and scheduled runs.