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

# List available voices

> Returns the voice catalog. Each voice has a tier (`va-1` or `va-1-pro`) that determines the per-minute rate at billing time. Pass the row's `id` as `voice_id` when creating or updating an agent. If `tier` is provided, it must be one of the tiers returned by `GET /agent/voice-tiers`.



## OpenAPI

````yaml /openapi.json get /agent/voices
openapi: 3.1.0
info:
  title: Vocobase Partner API
  version: '2.0'
  description: >-
    API for managing voice AI agents, documents, and calls on the Vocobase
    platform.
servers:
  - url: https://api.vocobase.com/api/v2
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Config
    description: >-
      Read and update partner configuration, webhook settings, and telephony
      credentials.
  - name: Agents
    description: Create, read, update, and delete voice AI agents.
  - name: Voices
    description: >-
      List voice tiers, available voices, and stream preview audio for agent
      configuration.
  - name: Documents
    description: Upload, manage, and delete knowledge base documents.
  - name: Agent Documents
    description: Link and unlink documents to agents for knowledge base integration.
  - name: Calls
    description: Initiate outbound calls and view call history.
  - name: Phone Numbers
    description: >-
      Import DIDs, assign agents for inbound routing, and re-sync carrier
      Application bindings.
  - name: Inbound Routing Policies
    description: >-
      Define pre-answer routing decisions for inbound calls before AI sessions
      are created.
  - name: Telephony Connections
    description: Create, list, rename, and disconnect named V2 telephony connections.
  - name: VoiceLink Management
    description: Manage VoiceLink reseller clients, DID mapping, and readiness sync.
  - name: Projects
    description: Organize agents into projects. Every agent belongs to exactly one project.
  - name: Dictionaries
    description: Speech-recognition dictionary CRUD and agent attachment.
  - name: Sessions
    description: Browser-initiated WebRTC voice sessions for in-app voice agents.
paths:
  /agent/voices:
    get:
      tags:
        - Voices
      summary: List available voices
      description: >-
        Returns the voice catalog. Each voice has a tier (`va-1` or `va-1-pro`)
        that determines the per-minute rate at billing time. Pass the row's `id`
        as `voice_id` when creating or updating an agent. If `tier` is provided,
        it must be one of the tiers returned by `GET /agent/voice-tiers`.
      operationId: listVoices
      parameters:
        - name: tier
          in: query
          schema:
            type: string
            enum:
              - va-1
              - va-1-pro
          description: Filter voices by tier. Invalid tiers return `400 VALIDATION_ERROR`.
          example: va-1
      responses:
        '200':
          description: Voice catalog.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    properties:
                      voices:
                        type: array
                        items:
                          $ref: '#/components/schemas/Voice'
              example:
                success: true
                data:
                  voices:
                    - id: b49e0d0f-2219-4425-a765-1efd32beb509
                      display_name: Sheetal
                      description: Warm, conversational Hindi narrator.
                      provider: cartesia
                      model_name: sonic-3.5
                      tier: va-1
                      provider_voice_id: a0e99841-438c-4a64-b679-ae501e7d6091
                      speed: 1
                      volume: 1
                      temperature: null
                      language: hi
                      gender: female
                      gemini_location: null
                      preview_text: Hello, this is a short preview of my voice.
                      status: active
                      last_validated_at: '2026-06-01T10:00:00.000Z'
                      validation_error: null
                      metadata: {}
                      created_at: '2026-06-01T09:00:00.000Z'
                      updated_at: '2026-06-01T10:00:00.000Z'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    Voice:
      type: object
      description: >-
        A voice from the platform catalog. Pass `id` as `voice_id` on agent
        create/update.
      properties:
        id:
          type: string
          format: uuid
          description: Pass this as `voice_id` on agent create/update.
        display_name:
          type: string
        description:
          type:
            - string
            - 'null'
        provider:
          type: string
          enum:
            - cartesia
            - inworld
            - gemini
        model_name:
          type: string
        tier:
          type: string
          enum:
            - va-1
            - va-1-pro
          description: Drives the per-minute rate at billing time.
        provider_voice_id:
          type: string
          description: >-
            Provider-native voice id or voice name. Use `id`, not this field,
            when creating agents or previewing audio.
        speed:
          type: number
        volume:
          type:
            - number
            - 'null'
        temperature:
          type:
            - number
            - 'null'
        language:
          type: string
        gender:
          type:
            - string
            - 'null'
        gemini_location:
          type:
            - string
            - 'null'
        preview_text:
          type:
            - string
            - 'null'
          description: >-
            Default text used by the preview endpoint when no `text` query
            parameter is provided.
        status:
          type: string
          enum:
            - active
        last_validated_at:
          type:
            - string
            - 'null'
          format: date-time
        validation_error:
          type:
            - string
            - 'null'
        metadata:
          type: object
          description: Provider-specific metadata for the voice configuration.
          additionalProperties: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - display_name
        - provider
        - model_name
        - tier
        - provider_voice_id
        - speed
        - language
        - status
        - created_at
        - updated_at
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          const: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
      required:
        - success
        - error
  responses:
    ValidationError:
      description: Validation error in request body or parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: VALIDATION_ERROR
              message: agent_name is required and must be max 50 characters
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: UNAUTHORIZED
              message: Invalid or missing API key
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: INTERNAL_ERROR
              message: An unexpected error occurred
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key in format: `rg_live_xxxx`. Pass as a Bearer token in the
        Authorization header.

````