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

# Get Voice

> Looks up one voice visible to the current workspace by `voice_id`. Same shape as Clone Voice.

<AccordionGroup>
  <Accordion title="More details">
    To use a built-in voice instead, see [Choose a voice](/streaming-avatar/character/voice).
  </Accordion>

  <Accordion title="Errors">
    Error responses use the same `{code, message, data}` envelope; a non-zero `code` identifies the error.

    | Case | Error code |
    | - | - |
    | The voice does not exist or is not visible to the current workspace | `20005 not found` |
  </Accordion>
</AccordionGroup>


## OpenAPI

````yaml streaming-avatar/api-references/openapi.json GET /v1/voices/{voice_id}
openapi: 3.1.0
info:
  title: Vivix Streaming Avatar API
  version: 1.0.0
  description: REST endpoints for Streaming Avatar sessions, voices, and characters.
servers:
  - url: https://api.vivix.ai
security:
  - bearerAuth: []
paths:
  /v1/voices/{voice_id}:
    get:
      summary: Get Voice
      description: >-
        Looks up one voice visible to the current workspace by `voice_id`. Same
        shape as Clone Voice.
      operationId: getVoice
      parameters:
        - name: voice_id
          in: path
          required: true
          schema:
            type: string
          description: The `voice_id` returned by clone or list.
          example: voice_9f1c2a7b
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                  - message
                  - data
                properties:
                  code:
                    type: integer
                    description: '`0` on success; any other value is an error code.'
                  message:
                    type: string
                    description: '`success`, or an English error description.'
                  data:
                    type: object
                    properties:
                      voice_id:
                        type: string
                        description: >-
                          Voice id (shaped like `voice_…`). Pass it unchanged as
                          `tts_voice_id`.
                      name:
                        type: string
                        description: Display name.
                      language:
                        type: string
                        description: Language sent on create; empty string when omitted.
                    required:
                      - voice_id
                      - name
                      - language
              example:
                code: 0
                message: success
                data:
                  voice_id: voice_9f1c2a7b
                  name: Studio Host
                  language: zh
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your Vivix API key. Keep it on your server.

````