> ## Documentation Index
> Fetch the complete documentation index at: https://docs.empirical.run/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancel a test run

> Cancels an in-progress test run, recording an optional reason and the cancelling user. Returns 412 when the run is already in a terminal state.



## OpenAPI

````yaml /api-reference/openapi.generated.json post /api/test-runs/{id}/cancel
openapi: 3.1.0
info:
  title: Empirical API
  version: 1.0.0
  description: Programmatic access to Empirical test runs, snoozes, and more.
  contact:
    name: Empirical
    url: https://empirical.run
servers:
  - url: https://api.empirical.run
security:
  - Bearer: []
tags:
  - name: Test Runs
    description: Trigger, list, and inspect end-to-end test runs.
  - name: Test Cases
    description: >-
      Browse the Playwright test cases synced from a project's repository and
      manage their tags.
  - name: Environments
    description: >-
      Named deployment targets (slug + Playwright project filters) a project's
      tests run against.
  - name: Snoozes
    description: Temporarily suppress known test failures for specific Playwright tests.
  - name: Analytics
    description: Aggregated test-run, test-count and test-case analytics for a project.
  - name: Resources
    description: >-
      Project file resources — uploads stored in R2 and external link-type files
      (e.g. Google Sheets).
  - name: Badges
    description: Public README status badge images (SVG) for project environments.
paths:
  /api/test-runs/{id}/cancel:
    post:
      tags:
        - Test Runs
      summary: Cancel a test run
      description: >-
        Cancels an in-progress test run, recording an optional reason and the
        cancelling user. Returns 412 when the run is already in a terminal
        state.
      operationId: cancelTestRun
      parameters:
        - schema:
            type: integer
            minimum: 1
            description: Database ID of the test run.
          required: true
          description: Database ID of the test run.
          name: id
          in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelTestRunRequest'
      responses:
        '200':
          description: The test run was cancelled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelTestRunResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Test run not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '412':
          description: The test run could not be cancelled (already terminal).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelTestRunFailureResponse'
components:
  schemas:
    CancelTestRunRequest:
      type: object
      properties:
        reason:
          type: string
          description: >-
            Optional reason for cancelling the test run. Recorded for auditing
            purposes.
    CancelTestRunResponse:
      type: object
      properties:
        message:
          type: string
          description: Confirmation message indicating the test run was cancelled.
      required:
        - message
    ErrorResponse:
      type: object
      properties:
        data:
          nullable: true
          description: Always null for error responses.
        error:
          type: object
          properties:
            message:
              type: string
              description: Human-readable error message.
          required:
            - message
          description: Error details.
      required:
        - data
        - error
    CancelTestRunFailureResponse:
      type: object
      properties:
        message:
          type: string
          description: Reason the test run could not be cancelled.
      required:
        - message
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer

````