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

# Create a pronunciation group

> Manage groups belonging to the authenticated user. Does not consume credits or require a positive credit balance.



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/tts/intervention/groups
openapi: 3.0.0
info:
  title: VoxNexus API
  version: 1.0.0
  description: VoxNexus API Documentation
  contact:
    name: API Support
    url: https://voxnexus.ai/support
    email: support@voxnexus.ai
servers:
  - url: https://api.voxnexus.ai
security: []
paths:
  /v1/tts/intervention/groups:
    post:
      tags:
        - tts-intervention
      summary: Create a pronunciation group
      description: >-
        Manage groups belonging to the authenticated user. Does not consume
        credits or require a positive credit balance.
      operationId: createInterventionGroup
      parameters:
        - in: query
          name: model_id
          required: true
          schema:
            type: string
          description: >-
            Used only to resolve an intervention-compatible provider; groups
            belong to the authenticated user.
        - in: query
          name: voice_id
          required: true
          schema:
            type: string
          description: >-
            Used only to resolve an intervention-compatible provider; groups
            belong to the authenticated user.
        - in: query
          name: language
          required: false
          schema:
            type: string
          description: >-
            Used only to resolve an intervention-compatible provider; groups
            belong to the authenticated user.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InterventionGroupInput'
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterventionGroup'
        '400':
          description: >-
            Invalid parameters, invalid group ID format, or intervention not
            supported
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Group does not exist or belongs to another user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: >-
            Group name already exists for this user, or the limit of 100 groups
            including default has been reached.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Request rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Intervention service unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    InterventionGroupInput:
      type: object
      additionalProperties: false
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 100
          description: >-
            Display name; surrounding whitespace is trimmed. Must be unique
            within the authenticated user and must not be blank. Renaming does
            not change the group ID.
          example: Product names
      required:
        - name
    InterventionGroup:
      type: object
      additionalProperties: false
      properties:
        id:
          $ref: '#/components/schemas/InterventionGroupID'
        name:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - name
        - created_at
        - updated_at
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message
          example: Invalid request parameters
        code:
          type: string
          description: Error code
          example: INVALID_REQUEST
        details:
          type: string
          description: Detailed error information (optional)
          example: Detailed error information
        request_id:
          type: string
          description: Request ID (optional)
          example: req_1234567890
      required:
        - error
    InterventionGroupID:
      type: string
      minLength: 1
      maxLength: 64
      pattern: ^[A-Za-z0-9_-]+$
      description: >-
        Opaque group ID owned by the authenticated user; default is the built-in
        group. Use the ID returned by group creation.
      example: default
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: Authenticate using X-Api-Key header

````

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