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

# Voices

> Every voice you can put in `voice.voice_id`.

`languages` is the set a voice is certified for, and it is what decides whether an agent saves: a
provider handed a language it cannot speak fails while the call is being set up, so the call dies
before the caller hears anything.

```http theme={"dark"}
GET /v1/voices?provider=vocily&language=hi-IN
```

Filter by either. Vocily publishes per-voice locales; the other providers certify per **provider**,
so every voice of theirs carries the provider's own list.


## OpenAPI

````yaml developers/openapi.json GET /v1/voices
openapi: 3.1.0
info:
  title: Vocily API
  description: >-
    Public REST API for Vocily. Build and configure an agent, publish a version
    and put it live, place outbound calls, and read back calls, chats and what
    the agent remembered. Authenticate with a workspace API key as a Bearer
    token.


    Some things stay in the dashboard, by design: creating an API key, buying or
    connecting a phone number, setting an agent's webhook URL, connecting
    WhatsApp and its templates, building HTTP tools, and running batch
    campaigns.
  version: v1
servers:
  - url: https://api.vocily.ai
    description: Production
security: []
paths:
  /v1/voices:
    get:
      tags:
        - catalogues
      summary: List Voices
      description: >-
        Voices you can put in `voice.voice_id`.


        `languages` is the set a voice is certified for, and it is what decides
        whether an

        agent can be saved: a provider handed a language it cannot speak fails
        while the

        pipeline is being built, so the call dies before the caller hears
        anything. Vocily

        publishes per-voice locales; the other providers certify per PROVIDER,
        so every voice

        of theirs carries the provider's own list (`GET /v1/tts-capabilities`).
      operationId: list_voices_v1_voices_get
      parameters:
        - name: provider
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Only this provider's voices. Omit for every provider.
            title: Provider
          description: Only this provider's voices. Omit for every provider.
        - name: language
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Only voices certified for this language code, e.g. `hi-IN`.
            title: Language
          description: Only voices certified for this language code, e.g. `hi-IN`.
      responses:
        '200':
          description: Voices you can put in `voice.voice_id`.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    provider:
                      type: string
                      enum:
                        - vocily
                        - sarvam
                        - cartesia
                        - elevenlabs
                        - smallest
                    voice_id:
                      type: string
                      description: What goes in `voice.voice_id`.
                    name:
                      type: string
                    gender:
                      type: string
                    language:
                      type: string
                      description: The voice's own language, e.g. `hi-IN`.
                    languages:
                      type: array
                      items:
                        type: string
                      description: >-
                        Every language this voice is certified for. An agent
                        whose `language.default` is not in here is refused on
                        save.
              example:
                - provider: vocily
                  voice_id: bn-IN-abhik
                  name: Abhik
                  gender: male
                  language: bn-IN
                  languages:
                    - bn-IN
                    - hi-IN
                - provider: vocily
                  voice_id: bn-IN-arnab
                  name: Arnab
                  gender: male
                  language: bn-IN
                  languages:
                    - bn-IN
                    - hi-IN
                - provider: elevenlabs
                  voice_id: EXAVITQu4vr4xnSDxMaL
                  name: Sarah
                  gender: female
                  language: Multi
                  languages:
                    - ar
                    - as-IN
                    - bn-IN
                    - de-DE
                    - en-GB
                    - en-IN
                    - en-US
                    - es-ES
                    - fr-FR
                    - gu-IN
                    - hi-IN
                    - it-IT
                    - ja-JP
                    - kn-IN
                    - ml-IN
                    - mr-IN
                    - nl-NL
                    - or-IN
                    - pa-IN
                    - pt-PT
                    - ru-RU
                    - ta-IN
                    - te-IN
                    - ur-IN
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                detail: Invalid API key
                code: UNAUTHORIZED
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded — honor `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                code: rate_limited
      security:
        - bearerAuth: []
components:
  schemas:
    ApiError:
      type: object
      description: >-
        Error envelope. `code` is derived from the HTTP status, so branch on it
        for the CLASS of failure; the specific reason is `detail.code`. Every
        public refusal carries both.
      properties:
        detail:
          type: object
          description: >-
            The reason. `code` is the domain reason (e.g. `call_not_found`) and
            `message` is a sentence safe to log. On a `422` it also carries
            `errors[]`, one entry per rejected field — see
            `HTTPValidationError`.
          properties:
            code:
              type: string
              example: call_not_found
            message:
              type: string
              example: Call not found
          required:
            - code
            - message
        code:
          type: string
          description: Derived from the HTTP status, not the domain reason.
          example: NOT_FOUND
    HTTPValidationError:
      type: object
      title: HTTPValidationError
      description: >-
        A request the API could not read: a field of the wrong type, out of
        range, missing, or one we do not accept. Same envelope as every other
        error.
      properties:
        detail:
          type: object
          description: >-
            What was wrong, as `code`, a one-line `message`, and every offending
            field in `errors`.
          required:
            - code
            - message
            - errors
          properties:
            code:
              type: string
              enum:
                - validation_error
            message:
              type: string
              description: >-
                The first problem in one line, with a count of the rest — e.g.
                `model.temperature: Input should be less than or equal to 2 (and
                1 more)`.
            errors:
              type: array
              items:
                $ref: '#/components/schemas/ValidationError'
              description: >-
                One entry per offending field. **Every problem is reported at
                once**, not just the first, so a malformed body needs one round
                trip to fix rather than one per field.
        code:
          type: string
          enum:
            - VALIDATION_ERROR
          description: Derived from the HTTP status, as on every error.
    ValidationError:
      type: object
      title: ValidationError
      required:
        - field
        - message
        - type
      properties:
        field:
          type: string
          description: >-
            The offending field as a path from the root of your request —
            `voice.speed`, `variables[0].key`, or `query.limit` for a query
            parameter. **This is the field to read.**
        message:
          type: string
          description: What is wrong with it, in plain language.
        type:
          type: string
          description: >-
            A stable machine code for the kind of failure, e.g.
            `extra_forbidden` for a field we do not accept, `missing` for a
            required one, or `less_than_equal` for a number out of range. Switch
            on this rather than on `message`, which may be reworded.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key as a Bearer token, e.g. `Authorization: Bearer vk_…`.'

````