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

# List specs

> Retrieve information about all existing specs



## OpenAPI

````yaml GET /api/dataframer/specs/
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: []
externalDocs:
  description: Complete API Guide
  url: https://docs.dataframer.ai/dataframer
paths:
  /api/dataframer/specs/:
    get:
      summary: List specs
      description: >-
        List all specs for your company. Shows name, status, dataset info, and
        creation time.
      operationId: api_dataframer_specs_list
      responses:
        '200':
          description: List of specs
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SpecListItem'
              examples:
                specs_list:
                  value:
                    - id: 550e8400-e29b-41d4-a716-446655440000
                      name: Customer Support Conversations Spec
                      description: >-
                        Spec for generating synthetic customer support
                        conversations
                      status: SUCCEEDED
                      created_at: '2025-01-15T10:30:00Z'
                      dataset_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                      dataset_name: Customer Support Dataset
                      dataset_type: SINGLE_FILE
                    - id: 661f9511-f30c-52e5-b827-557766551111
                      name: Product Reviews Spec
                      description: Spec for synthetic product review generation
                      status: PROCESSING
                      created_at: '2025-01-15T11:00:00Z'
                      dataset_id: b2c3d4e5-f6a7-8901-bcde-f12345678901
                      dataset_name: Product Reviews Dataset
                      dataset_type: MULTI_FILE
                    - id: 772f0622-g41d-63f6-c938-668877662222
                      name: Seedless QA Pairs Spec
                      description: Generate QA pairs without seed data
                      status: SUCCEEDED
                      created_at: '2025-01-15T12:00:00Z'
                      dataset_id: null
                      dataset_name: null
                      dataset_type: MULTI_FILE
        '401':
          description: Unauthorized - Invalid or missing authentication token
      x-codeSamples:
        - 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
            )
            specs = client.dataframer.specs.list()
            print(specs)
        - lang: cURL
          source: |-
            curl https://df-api.dataframer.ai/api/dataframer/specs/ \
                -H "Authorization: Bearer $DATAFRAMER_API_KEY"
components:
  schemas:
    SpecListItem:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the spec
        name:
          type: string
          description: >-
            Spec name, unique within its dataset (or unique among seedless
            specs)
        description:
          type: string
          nullable: true
          description: Human-readable description of what data this spec generates
        status:
          type: string
          enum:
            - PROCESSING
            - SUCCEEDED
            - FAILED
          description: >-
            Current status of the spec. PROCESSING: spec is being generated.
            SUCCEEDED: spec is ready for generation. FAILED: spec generation
            failed.
        created_at:
          type: string
          format: date-time
          description: Timestamp when the spec was created
        dataset_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            ID of the seed dataset this spec was created from. Null for seedless
            specs.
        dataset_name:
          type: string
          nullable: true
          description: >-
            Name of the seed dataset this spec was created from. Null for
            seedless specs.
        dataset_type:
          type: string
          enum:
            - SINGLE_FILE
            - MULTI_FILE
            - MULTI_FOLDER
          description: Type of dataset. MULTI_FILE for seedless specs.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'API Key authentication. Format: "Bearer YOUR_API_KEY"'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.