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

# Create Configuration

> Create a new configuration template that defines how audio/video files will be processed.

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

<Warning>
  Each account has a maximum of **20 configurations**. Plan your templates to cover multiple use cases — you cannot exceed this limit.
</Warning>

<Note>
  `tag` is permanent — it cannot be changed after creation. Choose a clear, descriptive name.
</Note>

<Tip>
  The more specific the `description` on each extraction field, the more accurate the AI extraction will be. See [Best Practices for Extraction Fields](/core/configuration#best-practices-for-extraction-fields).
</Tip>


## OpenAPI

````yaml api-reference/openapi-configurations.json POST /create-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:
  /create-configuration:
    post:
      summary: Create a Configuration
      description: >-
        Creates a new, reusable configuration template that specifies settings
        for processing audio/video files.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewConfiguration'
            examples:
              CustomerSupportExample:
                summary: Customer Support with extraction and summary
                value:
                  tag: Customer Support - Technical Issues
                  vocabulary:
                    - firewall
                    - VPN
                    - authentication
                  extraction_fields:
                    - name: ticket_id
                      type: string
                      description: The support ticket number mentioned in the conversation
                    - name: issue_resolved
                      type: boolean
                      description: Whether the technical issue was resolved during the call
                  webhooks:
                    success_url: https://myservice.com/webhooks/transcription/success
                    error_url: https://myservice.com/webhooks/transcription/error
                  summary: true
                  custom_summary: >-
                    Focus on the technical issue reported and the resolution
                    steps taken.
                  summary_language: en
                  analytics_language: en
      responses:
        '201':
          description: Configuration created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateConfigurationResponse'
              examples:
                SuccessResponse:
                  value:
                    data:
                      message: Configuration created successfully
                      configuration_id: a1b2c3d4-e5f6-7890-1234-567890abcdef
components:
  schemas:
    NewConfiguration:
      type: object
      properties:
        tag:
          type: string
          description: >-
            A descriptive name for the configuration (e.g., `"Sales Call
            Analysis"`). **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. Example: `["Heify", "NLP", "SLA"]`.
        extraction_fields:
          type: array
          description: >-
            Structured data fields for the AI to extract from the transcript.
            Maximum 10 fields. Field names are auto-normalized on creation:
            lowercased and special characters replaced with `_` (e.g. `"Customer
            ID"` → `"customer_id"`).
          maxItems: 10
          items:
            $ref: '#/components/schemas/ExtractionField'
        webhooks:
          $ref: '#/components/schemas/Webhooks'
        summary:
          type: boolean
          default: false
          description: If `true`, an AI summary of the transcription will be generated.
        custom_summary:
          type: string
          maxLength: 300
          description: >-
            A custom prompt that guides how the AI generates the summary (e.g.,
            `"Focus on customer complaints and resolution steps"`). Only takes
            effect when `summary` is `true`.
        summary_language:
          type: string
          default: df
          description: >-
            Language for the generated summary. Use `"df"` for automatic
            detection based on the audio language. See [Supported
            Languages](/core/transcription#supported-languages).
        analytics_language:
          type: string
          default: df
          description: >-
            Language for analytics reports. Use `"df"` for automatic detection.
            See [Supported Languages](/core/transcription#supported-languages).
      required:
        - tag
    CreateConfigurationResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            message:
              type: string
              description: Confirmation message.
            configuration_id:
              type: string
              format: uuid
              description: >-
                The unique identifier of the created configuration. Use this ID
                in future requests.
    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

````