> ## 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.

# Get run

> Retrieve a specific run by ID



## OpenAPI

````yaml GET /api/dataframer/runs/{run_id}/
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}/:
    parameters:
      - name: run_id
        in: path
        required: true
        description: Unique identifier of the run to delete
        schema:
          type: string
    get:
      tags:
        - Runs
      summary: Get run
      description: >-
        Get run details including status, progress
        (samples_completed/samples_failed), and generated_files when complete.
      operationId: api_dataframer_runs_retrieve
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Run'
        '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
            });

            const run = await client.dataframer.runs.retrieve('run_id');

            console.log(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
            )
            run = client.dataframer.runs.retrieve(
                "run_id",
            )
            print(run.id)
components:
  schemas:
    Run:
      type: object
      description: Detailed run information
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: Unique identifier for the run
        status:
          type: string
          enum:
            - PENDING
            - PROCESSING
            - SUCCEEDED
            - FAILED
            - CANCELED
          description: Current status of the run
        spec_id:
          type: string
          format: uuid
          readOnly: true
          description: ID of the spec used
        spec_name:
          type: string
          readOnly: true
          description: Name of the spec
        spec_version:
          type: integer
          readOnly: true
          description: Version number of the spec used
        dataset_id:
          type: string
          format: uuid
          readOnly: true
          nullable: true
          description: ID of the seed dataset (null for seedless specs)
        dataset_name:
          type: string
          readOnly: true
          nullable: true
          description: Name of the seed dataset (null for seedless specs)
        dataset_type:
          type: string
          readOnly: true
          enum:
            - SINGLE_FILE
            - MULTI_FILE
            - MULTI_FOLDER
          description: Type of dataset
        samples_completed:
          type: integer
          readOnly: true
          description: Number of samples successfully generated
        samples_failed:
          type: integer
          readOnly: true
          description: Number of samples that failed to generate
        total_cost:
          type: number
          readOnly: true
          nullable: true
          description: Total cost of the run in dollars
        created_at:
          type: string
          format: date-time
          readOnly: true
          description: When the run was created
        created_by_email:
          type: string
          readOnly: true
          description: Email of the user who created the run
        completed_at:
          type: string
          format: date-time
          nullable: true
          readOnly: true
          description: When the run completed (null if not finished)
        runtime_params:
          $ref: '#/components/schemas/RunRuntimeParams'
        generated_files:
          type: array
          readOnly: true
          description: List of generated files (populated when run completes)
          items:
            $ref: '#/components/schemas/GeneratedFile'
    RunRuntimeParams:
      type: object
      description: Generation parameters used for the run
      properties:
        number_of_samples:
          type: integer
          description: Number of samples requested
        generation_model:
          type: string
          description: Model used for generation
        outline_model:
          type: string
          description: Model used for outline generation
        revision_model:
          type: string
          nullable: true
          description: Model used for revisions (null if revisions disabled)
        revision_types:
          type: array
          items:
            type: string
          description: Revision types that were applied
        filtering_types:
          type: array
          items:
            type: string
          description: Filtering types that were applied
        max_revision_cycles:
          type: integer
          nullable: true
          description: Max revision cycles (null if revisions disabled)
        seed_shuffling_level:
          type: string
          enum:
            - none
            - sample
            - field
            - prompt
          description: Seed shuffling level used
        max_examples_in_prompt:
          type: integer
          nullable: true
          description: Max examples in prompt (null if not set)
        unified_multifield:
          type: boolean
          description: Whether unified multifield generation was used
        generation_thinking_budget:
          type: integer
          nullable: true
          description: >-
            Thinking budget used for generation model (null if not a thinking
            model)
        outline_thinking_budget:
          type: integer
          nullable: true
          description: >-
            Thinking budget used for outline model (null if not a thinking
            model)
        revision_thinking_budget:
          type: integer
          nullable: true
          description: >-
            Thinking budget used for revision model (null if not a thinking
            model)
        skip_outline:
          type: boolean
          nullable: true
          description: Whether outline and part-by-part generation was skipped
        tools:
          type: array
          items:
            type: string
          nullable: true
          description: Tools that were available to the LLM during generation
    GeneratedFile:
      type: object
      description: A generated file from a run
      properties:
        id:
          type: string
          description: File identifier for download
        path:
          type: string
          description: File path within the run output
        file_type:
          type: string
          description: MIME type of the file
        size_bytes:
          type: integer
          description: File size in bytes
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'API Key authentication. Format: "Bearer YOUR_API_KEY"'

````