Skip to main content
POST
/
v1
/
release-checks
Start release check
curl --request POST \
  --url https://api.qa.tech/v1/release-checks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "releaseName": "<string>",
  "releaseSummary": "<string>",
  "context": "<string>",
  "changes": [
    {
      "summary": "<string>",
      "details": "<string>",
      "reference": "<string>",
      "diff": "<string>"
    }
  ],
  "regression": {
    "testPlanShortId": "<string>",
    "testCaseIds": [
      "<string>"
    ]
  },
  "prUrl": "<string>",
  "applicationOverrides": [
    {
      "applicationShortId": "<string>",
      "environment": {
        "url": "<string>",
        "name": "<string>"
      },
      "devicePresetShortId": "<string>"
    }
  ],
  "projectShortId": "<string>"
}
'
{
  "shortId": "<string>",
  "url": "<string>",
  "reviewShortId": "<string>"
}

Body

application/json

Request body for starting a release check.

The calling agent describes the release and its intended changes; QA.tech runs an autonomous launch-review agent that tests the current state of the app against an end-user launch checklist, verifies the intended changes, and synthesizes an informational launch-readiness report (Lighthouse-style: it scores the app and highlights what needs attention, it does not block a release). All testing and analysis runs on QA.tech and does not consume the caller's tokens.

Provide at least one of changes, regression, or prUrl so the agent has something concrete to review.

​
releaseName
string

Human-readable name for this release, e.g. 'v2.3.0' or 'June checkout revamp'.

​
releaseSummary
string

Short description of what this release contains.

​
context
string

Free-text focus areas, risk areas, or instructions for the review.

​
changes
object[]

The intended changes in this release (user prompts, PR descriptions, tickets). The review agent verifies each one behaves as described.

​
regression
object

Regression baseline to run as part of the check.

​
prUrl
string<uri>

Optional pull request URL to enrich the review with diffs and deployment info. Requires vcsProviderId.

​
vcsProviderId
enum<string>

VCS provider for prUrl.

Available options:
github,
gitlab
​
applicationOverrides
object[]

Per-application environment overrides identifying the build/URL under review.

​
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

202 - application/json

The request has been accepted for processing, but processing has not yet completed.

Lightweight response returned immediately after starting a release check.

​
shortId
string
required
Pattern: ^rc(-.+_.+|_.+)$
​
url
string
required

Dashboard URL for the release check's launch-readiness report.

​
status
enum<string>
required

Lifecycle status of a release check.

Available options:
pending,
running,
completed,
failed
​
reviewShortId
string

Short ID of the launch-review conversation driving this check.

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