Get Voice

Returns details for a specific voice, including clone workflow status when available. Use this to poll a voice clone until its status is ‘complete’.

GET /v3/voices/{voice_id}

Get Voice

cURL

curl --request GET \
  --url https://api.heygen.com/v3/voices/{voice_id} \
  --header 'x-api-key: <api-key>'

200

{
  "data": {
    "voice_id": "<string>",
    "support_pause": true,
    "name": "<string>",
    "language": "<string>",
    "gender": "<string>",
    "preview_audio_url": "<string>",
    "status": "processing",
    "failure_message": "<string>",
    "support_interactive_avatar": false,
    "created_at": 123
  }
}

Authorizations

ApiKeyAuthBearerAuth

x-api-key · string · header · required

HeyGen API key. Obtain from your HeyGen dashboard.

Path Parameters

voice_id · string · required

Unique voice identifier

Response

200

application/json

Successful response

data · VoiceDetailV3 · object

Response payload for GET /v3/voices/{voice_id}.

Show child attributes