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

# Get Voices

> Retrieve a list of available timbres with filtering options.
Supports pagination and various filters including gender, language, age, and use case.


Retrieve the list of available voices for text-to-speech. JoggAI offers natural-sounding voices in 40+ languages.

## Example Usage

```bash theme={null}
curl --request GET \
  --url 'https://api.jogg.ai/v2/voices' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Query Parameters

* `language` - Filter by language code (e.g., "en-US")
* `gender` - Filter by gender ("Male" or "Female")


## OpenAPI

````yaml GET /v2/voices
openapi: 3.0.1
info:
  title: JoggAI OpenAPI v2
  description: >
    JoggAI OpenAPI v2 provides a comprehensive suite of endpoints for creating
    and managing AI-powered video content.


    ## Authentication

    All API requests require authentication using an API key provided in the
    `x-api-key` header.


    ## Base URL

    Production: https://api.jogg.ai/v2


    ## Rate Limiting

    API calls are subject to rate limiting based on your subscription plan.


    ## Error Handling

    All endpoints return standard HTTP status codes along with detailed error
    messages in the response body.
  version: 2.0.0
  license:
    name: MIT
servers:
  - url: https://api.jogg.ai
    description: Production server
security:
  - apiKeyAuth: []
tags:
  - name: Video
    description: Video creation and management operations
  - name: Avatar
    description: Avatar management and creation operations
  - name: Voice
    description: Voice and timbre management operations
  - name: Asset
    description: Asset management including music, scripts, and uploads
  - name: Template
    description: Template management operations
  - name: Product
    description: Product management operations
  - name: User
    description: User account operations
  - name: Webhook
    description: Webhook endpoint management for event notifications
paths:
  /v2/voices:
    get:
      tags:
        - Voice
      summary: Get Timbre List
      description: >
        Retrieve a list of available timbres with filtering options.

        Supports pagination and various filters including gender, language, age,
        and use case.
      parameters:
        - $ref: '#/components/parameters/PageParam'
        - $ref: '#/components/parameters/PageSizeParam'
        - name: gender
          in: query
          description: Filter by gender
          schema:
            type: string
            enum:
              - female
              - male
        - name: language
          in: query
          description: Filter by language
          schema:
            type: string
            example: english
        - name: age
          in: query
          description: Filter by age group
          schema:
            type: string
            enum:
              - young
              - middle_aged
              - old
        - name: use_case
          in: query
          description: Filter by use case
          schema:
            type: string
            example: narrative_story
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/BaseResponse'
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          voices:
                            type: array
                            description: List of voices
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: Voice name
                                  example: Christopher
                                voice_id:
                                  type: string
                                  description: Voice identifier
                                  example: en-US-ChristopherNeural
                                audio_url:
                                  type: string
                                  description: Voice sample audio URL
                                  format: uri
                                  example: https://res.jogg.ai/voice-sample.mp3
                                language:
                                  type: string
                                  description: Voice language
                                  example: english
                                gender:
                                  type: string
                                  description: Voice gender
                                  enum:
                                    - female
                                    - male
                                  example: male
                                age:
                                  type: string
                                  description: Voice age group
                                  enum:
                                    - young
                                    - middle_aged
                                    - old
                                  example: young
                                accent:
                                  type: string
                                  description: Voice accent
                                  example: american
                                use_case:
                                  type: string
                                  description: Recommended use case
                                  example: narrative_story
                          has_more:
                            type: boolean
                            description: Whether there are more results
                            example: true
components:
  parameters:
    PageParam:
      name: page
      in: query
      description: Page number for pagination
      schema:
        type: integer
        minimum: 1
        default: 1
        example: 1
    PageSizeParam:
      name: page_size
      in: query
      description: Number of items per page
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 10
        example: 10
  schemas:
    BaseResponse:
      type: object
      required:
        - code
        - msg
      properties:
        code:
          type: integer
          description: |
            Business status code:
            * 0 - Success
            * 10104 - Record not found
            * 10105 - Invalid API key
            * 18020 - Insufficient credit
            * 18025 - No permission to call APIs
            * 40000 - Parameter error
            * 50000 - System error
          example: 0
        msg:
          type: string
          description: Response message
          example: Success
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Obtain your key from the JoggAI dashboard.

````