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

# Voice Design

> Design and generate custom voices using text prompts and voice descriptions.

## Request

Make a `POST` request to below endpoint and pass the required parameters as a request body.

```curl curl theme={null}
--request POST 'https://modelslab.com/api/v6/voice/voice_design' \
```

## Body

```json json theme={null}
{
    "key": "your_api_key",
    "prompt": "Greetings, my friend. What brings you to Mount Olympus today? Here to gaze at my beautiful muscles again?",
    "voice_description": "The friendly mythical God, Zeus, with a huge deep powerful voice. Charming, proud, strong and theatrical.",
    "language": "english",
    "webhook": null,
    "track_id": null
}
```

<Note>
  Both `prompt` and `voice_description` have a maximum limit of 1000 characters each.
</Note>

## Supported Languages

| Language   | Value        |
| ---------- | ------------ |
| Chinese    | `chinese`    |
| English    | `english`    |
| Japanese   | `japanese`   |
| Korean     | `korean`     |
| German     | `german`     |
| French     | `french`     |
| Russian    | `russian`    |
| Portuguese | `portuguese` |
| Spanish    | `spanish`    |
| Italian    | `italian`    |


## OpenAPI

````yaml POST /voice/voice_design
openapi: 3.1.0
info:
  title: ModelsLab Voice API
  description: >-
    A comprehensive API for AI-driven voice and audio generation including
    text-to-speech, voice cloning, music generation, and audio processing
    capabilities
  license:
    name: MIT
  version: 6.0.0
servers:
  - url: https://modelslab.com/api/v6
security: []
paths:
  /voice/voice_design:
    post:
      summary: Design and generate custom voices
      description: >-
        Design and generate custom voices using text prompts and voice
        descriptions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VoiceDesignRequest'
      responses:
        '200':
          description: Voice design response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    VoiceDesignRequest:
      type: object
      required:
        - prompt
        - voice_description
      properties:
        key:
          type: string
          description: Your API Key used for request authorization
        prompt:
          type: string
          description: The text content to be spoken by the designed voice
        voice_description:
          type: string
          description: >-
            A detailed description of the voice characteristics (tone, accent,
            gender, age, style)
        language:
          type: string
          enum:
            - chinese
            - english
            - japanese
            - korean
            - german
            - french
            - russian
            - portuguese
            - spanish
            - italian
          description: Language for the voice
        webhook:
          type: string
          format: uri
          description: URL to receive POST notification upon completion
        track_id:
          type: integer
          description: ID for webhook identification
    VoiceResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
            - processing
            - error
          description: Status of the voice generation
        generationTime:
          type: number
          description: Time taken to generate the audio in seconds
        id:
          type: integer
          description: Unique identifier for the voice generation
        output:
          type: array
          items:
            type: string
            format: uri
          description: Array of generated audio URLs
        proxy_links:
          type: array
          items:
            type: string
            format: uri
          description: Array of proxy audio URLs
        future_links:
          type: array
          items:
            type: string
            format: uri
          description: Array of future audio URLs for queued requests
        links:
          type: array
          items:
            type: string
            format: uri
          description: Array of audio URLs (voice cover response)
        meta:
          type: object
          description: Metadata about the audio generation including all parameters used
        eta:
          type: integer
          description: Estimated time for completion in seconds (processing status)
        message:
          type: string
          description: Status message or additional information
        tip:
          type: string
          description: Additional information or tips for the user
        fetch_result:
          type: string
          format: uri
          description: URL to fetch the result when processing
        audio_time:
          type: number
          description: Duration of the generated audio in seconds
    Error:
      type: object
      required:
        - status
        - message
      properties:
        status:
          type: string
          enum:
            - error
        message:
          type: string
          description: Error message description

````