> ## Documentation Index > Fetch the complete documentation index at: https://docs.qa.tech/llms.txt > Use this file to discover all available pages before exploring further. # Get release check > Fetch the compiled release check report by its short ID. Poll until `status` is `completed`. ## OpenAPI ````yaml /api-reference/api.json get /v1/release-checks/{shortId} openapi: 3.0.0 info: title: QA.tech API version: 1.0.0 contact: name: QA.tech url: https://qa.tech email: support@qa.tech description: API for triggering and managing AI-powered test runs servers: - url: https://api.qa.tech description: Production variables: {} security: - BearerAuth: [] tags: - name: Runs - name: Infrastructure - name: Test Cases - name: Application Builds - name: Status badge - name: Remote Tunnels - name: Chat - name: Applications - name: Features - name: Metrics - name: Release Checks - name: Projects paths: /v1/release-checks/{shortId}: get: tags: - Release Checks summary: Get release check description: >- Fetch the compiled release check report by its short ID. Poll until `status` is `completed`. operationId: GetReleaseCheck parameters: - name: shortId in: path required: true schema: $ref: '#/components/schemas/ReleaseCheckShortId' - name: query in: query required: true schema: $ref: '#/components/schemas/ProjectScopedRequest' explode: false responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ReleaseCheckReport' components: schemas: ReleaseCheckShortId: type: string pattern: ^rc(-.+_.+|_.+)$ ProjectScopedRequest: type: object properties: projectShortId: allOf: - $ref: '#/components/schemas/ProjectShortId' description: >- 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. description: >- Mixin for project-scoped requests: an optional per-call project override. ReleaseCheckReport: type: object required: - shortId - url - releaseName - status - verdict - summary - progress - categories - overallScore - findings - intentVerification - pagesTested - checklistCoverage - healthSignals - manualFollowUps - automatedTestSummary - markdown - createdAt - updatedAt properties: shortId: $ref: '#/components/schemas/ReleaseCheckShortId' url: type: string description: Dashboard URL for the release check's launch-readiness report. releaseName: type: string nullable: true status: $ref: '#/components/schemas/ReleaseCheckStatus' verdict: allOf: - $ref: '#/components/schemas/ReleaseCheckVerdict' nullable: true description: Overall launch verdict. Null while the review is still running. summary: type: string nullable: true description: >- Narrative summary of the release's readiness. Null until the agent finishes. progress: type: object allOf: - $ref: '#/components/schemas/ReleaseCheckProgress' nullable: true description: >- Rolling latest progress while the check is running. Null once it finishes or before the first update. categories: type: array items: $ref: '#/components/schemas/ReleaseCheckCategory' description: >- Scored categories, each aggregating its checks. Empty until the agent finishes. overallScore: type: integer format: int32 nullable: true description: >- Overall 0-100 score (weighted average of scored categories). Null while running or when nothing was scored. findings: type: array items: $ref: '#/components/schemas/ReleaseCheckFinding' intentVerification: type: array items: $ref: '#/components/schemas/ReleaseCheckIntentVerification' pagesTested: type: array items: $ref: '#/components/schemas/ReleaseCheckPageTested' description: Key pages exercised during the review, with screenshots. checklistCoverage: type: array items: $ref: '#/components/schemas/ReleaseCheckCoverageItem' healthSignals: $ref: '#/components/schemas/ReleaseCheckHealthSignals' manualFollowUps: type: array items: type: string automatedTestSummary: type: object allOf: - $ref: '#/components/schemas/ReleaseCheckTestSummary' nullable: true description: Automated test totals. Null until tests have run. markdown: type: string description: Human-readable Markdown rendering of the report. createdAt: type: string format: date-time updatedAt: type: string format: date-time description: Compiled launch-readiness report, synthesized by the review agent. ProjectShortId: type: string pattern: ^proj(-.+_.+|_.+)$ ReleaseCheckStatus: type: string enum: - pending - running - completed - failed description: Lifecycle status of a release check. ReleaseCheckVerdict: type: string enum: - ready - needs_attention - not_ready description: Overall launch verdict, set once the review agent finishes. ReleaseCheckProgress: type: object required: - message - updatedAt properties: message: type: string description: >- Short, user-facing status line for what the agent is doing right now. testsRun: type: integer format: int32 description: How many tests have finished running so far this run. changesVerified: type: integer format: int32 description: How many intended changes have been verified so far. changesTotal: type: integer format: int32 description: Total intended changes to verify (denominator for changesVerified). updatedAt: type: string format: date-time description: When this progress was last updated. description: >- Rolling latest progress reported by the review agent while the check runs. Overwritten on each update (no history). Null until the agent posts its first update or once the check has finished. Counters are advisory live values; final numbers come from automatedTestSummary / intentVerification. ReleaseCheckCategory: type: object required: - key - label - score - checks - scoredCount - passedCount - failedCount - manualCount - naCount - unverifiedCount properties: key: $ref: '#/components/schemas/ReleaseCheckCategoryKey' label: type: string score: type: integer format: int32 nullable: true checks: type: array items: $ref: '#/components/schemas/ReleaseCheckCheck' scoredCount: type: integer format: int32 passedCount: type: integer format: int32 failedCount: type: integer format: int32 manualCount: type: integer format: int32 naCount: type: integer format: int32 unverifiedCount: type: integer format: int32 description: >- A scored category aggregating its checks. Score is a 0-100 severity-weighted pass rate, or null when no checks were scored (all manual/na/unverified). ReleaseCheckFinding: type: object required: - title - severity - category - description - isBlocker properties: title: type: string severity: $ref: '#/components/schemas/ReleaseCheckSeverity' category: type: string description: >- Checklist category this finding belongs to, e.g. 'Signup and onboarding'. description: type: string recommendation: type: string description: Recommended fix or next step. evidence: type: string description: 'Evidence: a test link, screenshot URL, or short observation.' isBlocker: type: boolean description: >- Whether this finding is critical (highlighted as a top issue to fix). Informational only; it does not block a release. description: A single issue the review agent found, classified by severity. ReleaseCheckIntentVerification: type: object required: - changeSummary - status properties: changeSummary: type: string status: type: string enum: - verified - failed - not_verified notes: type: string description: Verification of one intended change against the live app. ReleaseCheckPageTested: type: object required: - label - screenshotUrl properties: label: type: string url: type: string screenshotUrl: type: string description: >- A page the review exercised, with a screenshot, for the 'pages tested' filmstrip. ReleaseCheckCoverageItem: type: object required: - section - coverage properties: section: type: string coverage: type: string enum: - automated - partial - manual - skipped notes: type: string description: How well a checklist section was covered by this check. ReleaseCheckHealthSignals: type: object required: - consoleErrors - networkFailures - openIssues properties: consoleErrors: type: array items: type: string networkFailures: type: array items: type: string openIssues: type: array items: type: string description: >- Currently open project issues (console/failed-test) surfaced alongside the run. description: >- Technical health signals observed while testing. Extension point for future static checks and issue reporters. ReleaseCheckTestSummary: type: object required: - passed - failed - total - runShortIds properties: passed: type: integer format: int32 failed: type: integer format: int32 total: type: integer format: int32 runShortIds: type: array items: type: string description: Aggregate of the automated tests run during the check. ReleaseCheckCategoryKey: type: string enum: - functional - ux_content - accessibility - trust_legal - ecommerce - compatibility_health - brand description: User-facing category a launch check belongs to. ReleaseCheckCheck: type: object required: - id - title - status - automatable properties: id: type: string description: Stable catalog id, e.g. 'functional.signup'. title: type: string status: $ref: '#/components/schemas/ReleaseCheckCheckStatus' automatable: type: boolean description: Whether QA.tech can evaluate this check today (vs. human-only). severity: allOf: - $ref: '#/components/schemas/ReleaseCheckSeverity' description: Severity of the issue when status is 'fail'. evidence: type: string description: 'Evidence: a short observation backing the status.' recommendation: type: string screenshotUrl: type: string description: Durable screenshot URL evidencing the finding (mainly on fails). testRunShortId: type: string description: >- Short id of the run that produced the evidence, for a 'view run' link. description: A single launch check evaluated during the review. ReleaseCheckSeverity: type: string enum: - critical - high - medium - low description: Severity of a release finding, per the launch checklist severity guide. ReleaseCheckCheckStatus: type: string enum: - pass - fail - na - manual - unverified description: >- Status of a single launch check. pass/fail are scored; na is excluded; manual/unverified are surfaced but not scored. securitySchemes: BearerAuth: type: http scheme: Bearer ````