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

# Cancel run

> Cancel a running or pending generation job



## OpenAPI

````yaml POST /api/dataframer/runs/{run_id}/cancel/
openapi: 3.0.0
info:
  title: DataFramer API
  version: 0.1.0
  description: ''
  termsOfService: https://www.aimon.ai/docs/privacy-policy.pdf
  contact:
    name: DataFramer Support
    email: info@dataframer.ai
  license:
    name: Proprietary
  x-logo:
    url: https://dataframer.ai/logo.png
    altText: DataFramer AI
  x-stainless:
    package-name: aimon-dataframer
    namespace:
      - aimon
      - dataframer
servers:
  - url: https://df-api.dataframer.ai
    description: Production server
security:
  - BearerAuth: []
tags:
  - name: Seed Datasets
    description: Manage seed datasets for generation
  - name: Specs
    description: Data specifications for sample generation
  - name: Runs
    description: Generation runs and results
  - name: Evaluations
    description: Evaluate generated sample quality
  - name: Red Teaming
    description: Security testing and adversarial prompts
  - name: Spec Creation
    description: Create specs from datasets or from scratch (seedless)
  - name: Generation
    description: Synthetic data generation
  - name: API Keys
    description: API key management and rotation
  - name: Health
    description: Health check endpoints
  - name: Models
    description: Available AI models
externalDocs:
  description: Complete API Guide
  url: https://docs.dataframer.ai/dataframer
paths:
  /api/dataframer/runs/{run_id}/cancel/:
    parameters:
      - name: run_id
        in: path
        required: true
        description: Unique identifier of the run to cancel
        schema:
          type: string
    post:
      tags:
        - Runs
      summary: Cancel run
      description: >-
        Cancel a running generation job. Only PENDING or PROCESSING runs can be
        canceled.
      operationId: api_dataframer_runs_cancel
      responses:
        '204':
          description: >-
            Run canceled successfully. If any samples were already completed,
            they are preserved.
        '400':
          description: Bad Request - Job cannot be canceled (already completed/failed)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                not_cancelable:
                  value:
                    error: >-
                      Cannot cancel job. Only PROCESSING or PENDING jobs can be
                      canceled.
        '401':
          description: Unauthorized
        '404':
          description: Run not found
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Dataframer from 'dataframer';

            const client = new Dataframer({
              apiKey: process.env['DATAFRAMER_API_KEY'], // This is the default and can be omitted
            });

            await client.dataframer.runs.cancel('run_id');
        - lang: Python
          source: |-
            import os
            from dataframer import Dataframer

            client = Dataframer(
                api_key=os.environ.get("DATAFRAMER_API_KEY"),  # This is the default and can be omitted
            )
            client.dataframer.runs.cancel(
                "run_id",
            )
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'API Key authentication. Format: "Bearer YOUR_API_KEY"'

````