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

# Get Configuration

> Retrieve a single configuration by its ID.

<Info>
  For full details on all Configuration fields, see [Configuration](/core/configuration).
</Info>

<Note>
  Returns `404` if the configuration is not found.
</Note>


## OpenAPI

````yaml api-reference/openapi-configurations.json POST /get-configuration
openapi: 3.1.0
info:
  title: Heify API — Configurations
  description: Endpoints for creating, retrieving, and deleting Configurations.
  version: 1.0.0
servers:
  - url: https://api.heify.com
security:
  - apiKeyAuth: []
paths:
  /get-configuration:
    post:
      summary: Get a Configuration
      description: >-
        Retrieves a single configuration by its ID. The configuration must
        belong to the authenticated client.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetConfigurationRequest'
            examples:
              GetSingle:
                summary: Get a single configuration
                value:
                  configuration_id: a1b2c3d4-e5f6-7890-1234-567890abcdef
      responses:
        '200':
          description: Configuration retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSingleConfigurationResponse'
              examples:
                SingleConfigResponse:
                  summary: Single configuration response
                  value:
                    data:
                      configuration:
                        client_id: client-12345
                        configuration_id: a1b2c3d4-e5f6-7890-1234-567890abcdef
                        tag: Customer Support - Technical Issues
                        vocabulary:
                          - firewall
                          - VPN
                        extraction_fields:
                          - name: ticket_id
                            type: string
                            description: The support ticket number mentioned.
                        webhooks:
                          success_url: https://myservice.com/webhooks/success
                          error_url: https://myservice.com/webhooks/error
                        summary: true
                        custom_summary: Focus on the technical issue and resolution.
                        summary_language: en
                        analytics_language: en
                        created_at: '2025-01-15T10:00:00.000000+00:00'
components:
  schemas:
    GetConfigurationRequest:
      type: object
      properties:
        configuration_id:
          type: string
          format: uuid
          description: The unique identifier of the configuration to retrieve.
      required:
        - configuration_id
    GetSingleConfigurationResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            configuration:
              $ref: '#/components/schemas/Configuration'
    Configuration:
      type: object
      properties:
        client_id:
          type: string
          description: The client identifier associated with the configuration.
        configuration_id:
          type: string
          format: uuid
          description: The unique identifier for the configuration.
        tag:
          type: string
          description: >-
            A descriptive name for the configuration. Permanent — cannot be
            changed after creation.
          maxLength: 255
        vocabulary:
          type: array
          items:
            type: string
          description: >-
            Custom terms (brand names, acronyms, technical words) that improve
            transcription accuracy.
        extraction_fields:
          type: array
          items:
            $ref: '#/components/schemas/ExtractionField'
          description: AI extraction field definitions (max 10).
        webhooks:
          oneOf:
            - $ref: '#/components/schemas/Webhooks'
            - type: 'null'
        summary:
          type: boolean
          description: Whether to generate an AI summary.
        custom_summary:
          type: string
          nullable: true
          maxLength: 300
          description: >-
            Custom prompt guiding the AI summary. Only applies when `summary` is
            `true`.
        summary_language:
          type: string
          description: Language for the summary. `"df"` = auto-detect.
        analytics_language:
          type: string
          description: Language for analytics reports. `"df"` = auto-detect.
        created_at:
          type: string
          format: date-time
          description: Timestamp of when the configuration was created (UTC).
    ExtractionField:
      type: object
      properties:
        name:
          type: string
          description: >-
            Field identifier. Auto-normalized on creation: lowercased, accents
            removed, special characters replaced with `_`. Example: `"Customer
            ID"` → `"customer_id"`.
          maxLength: 50
        type:
          type: string
          description: >-
            Expected data type of the extracted value. **Immutable after
            creation.**
          enum:
            - string
            - number
            - boolean
            - array
        description:
          type: string
          description: >-
            Instructions for the AI on what to extract. The more specific, the
            better the accuracy. Example: `"Classify the overall sentiment. Must
            be one of: POSITIVE, NEGATIVE, or NEUTRAL."`
          maxLength: 1000
      additionalProperties: false
      required:
        - name
        - type
        - description
    Webhooks:
      type: object
      description: URLs for receiving completion/failure notifications via POST requests.
      properties:
        success_url:
          type: string
          format: uri
          description: >-
            Receives a POST request with the full transcription result on
            success.
        error_url:
          type: string
          format: uri
          description: Receives a POST request with error details on failure.
      additionalProperties: false
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````