> ## Documentation Index
> Fetch the complete documentation index at: https://dialnexa.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Voice Details
> Fetch one voice catalog entry by ID.
Read only
**Recommended.** This endpoint is part of the public `/v1` API reference and is the supported path for new integrations. See the [migration guide](/docs/api-reference/v1/migrating-to-v1) for versioning guidance.
Returns the full record for a single text-to-speech voice supported by DialNexa: the display `name`, the primary `language_code` (BCP-47), the perceived `gender`, the default `model_id`, the upstream `provider`, and a `preview_url` you can play to sample the voice. Use [List Voice Models](/docs/api-reference/voices/voice-models) to see all model variants available for this voice, different variants trade latency, naturalness, and cost.
## When to use this
* **Voice picker UIs**: render the selected voice with its preview audio and provider badge when editing an agent.
* **Agent configuration validation**: confirm the saved voice still exists and supports the language the agent is set to before publishing changes.
* **Migration tooling**: when a provider deprecates a voice, look up replacements by language and gender.
For the full catalogue, use [List Voices](/docs/api-reference/v1/voices/list). The catalogue is paginated and supports filtering by language.
## Path parameters
| Parameter | Description |
| --------- | ------------------------------------------ |
| `id` | The voice ID, for example `vce_en_us_ava`. |
## Errors
* `404 Not Found` is returned when the voice does not exist or has been removed by the provider.
* `401 Unauthorized` is returned when the API key is missing or revoked.
## Related endpoints
* [List Voices](/docs/api-reference/v1/voices/list): search and filter all available voices.
* [List Voice Models](/docs/api-reference/voices/voice-models): see model variants for a given voice.
* [List Accents](/docs/api-reference/v1/voices/accents): see available accent options across voices.
* [Text-to-speech and voices](/docs/voice-ai/text-to-speech-and-voices): guidance on choosing a voice.
## OpenAPI
````yaml GET /v1/voices/{id}
openapi: 3.0.0
info:
title: DialNexa API
description: >-
Public REST API for the DialNexa voice AI platform. Versioned endpoints are
under /v1; unversioned endpoints are legacy and deprecated.
version: 1.0.0
servers:
- url: https://api.dialnexa.com
description: DialNexa production API
security:
- bearer: []
tags:
- name: API Keys
- name: Agent Functions
- name: Agents V1
- name: Agents2
- name: Batch Calls
- name: Batch Calls V1
- name: Call Logs
- name: Calls
- name: Calls V1
- name: Campaign Leads
- name: Campaigns
- name: External Webhooks
- name: Knowledge Base
- name: Knowledge Base V1
- name: LLMs
- name: LLMs V1
- name: Languages
- name: Languages V1
- name: Organization Phone Numbers
- name: Organization Phone Numbers V1
- name: Phone Number Pricing
- name: Phone Number Pricing V1
- name: Transcribers
- name: Transcribers V1
- name: User Webhooks
- name: User Webhooks V1
- name: V1
- name: Voices
- name: Voices V1
- name: Webcall
- name: Workflow Leads
- name: Workflow Leads V1
- name: Workflows
- name: Workflows V1
paths:
/v1/voices/{id}:
get:
tags:
- Voices
- Voices V1
- V1
summary: Get Voice Details
description: Returns one voice catalog record by ID.
operationId: VoicesV1Controller_findOne
parameters:
- name: id
required: true
in: path
description: Voice ID
schema:
example: voice_abc123
type: string
responses:
'200':
description: Voice returned successfully.
content:
application/json:
schema:
type: object
properties:
id:
example: voice_abc123
type: string
name:
type: string
provider:
type: string
gender:
type: string
accent:
type: string
examples:
success:
summary: Successful response
value:
id: voice_abc123
name: Aditi
provider: elevenlabs
language_code: en-IN
gender: female
preview_url: https://example.com/preview.mp3
'400':
description: Invalid catalog ID format.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 400 Bad Request
value:
statusCode: 400
message: Invalid catalog ID format
error: Bad Request
'401':
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 401 Unauthorized
value:
statusCode: 401
message: API key is missing or invalid
error: Unauthorized
'403':
description: Forbidden - API key does not have access to this organization.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 403 Forbidden
value:
statusCode: 403
message: You do not have permission to access this resource
error: Forbidden
'404':
description: Voice not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 404 Not Found
value:
statusCode: 404
message: Voice not found
error: Not Found
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 500 Internal Server Error
value:
statusCode: 500
message: Internal server error
error: Internal Server Error
security:
- bearer: []
components:
schemas:
ErrorResponse:
type: object
properties:
statusCode:
type: integer
example: 400
message:
oneOf:
- type: string
- type: array
items:
type: string
example: phone_number must be a valid E.164 phone number
error:
type: string
example: Bad Request
required:
- statusCode
- message
- error
securitySchemes:
bearer:
scheme: bearer
bearerFormat: JWT
type: http
````