API Reference

Generate Voice Audio Preview

post
https://api.heygen.com/v2/voices//preview

Generates a short audio preview with the specified voice and text.

Path Params
string
required

Unique identifier of the voice to be used for generating preview. Can be retrieved from List All Voices (V2) endpoint.

Body Params
string
Defaults to plain

Format of the text field. Accepts plain or ssml.

string
required

Text or SSML to be synthesized.

string
required

ID of the voice to use. Must match the path parameter. Can be retrieved from List All Voices (V2) endpoint.

settings
object

Voice synthesis settings.

boolean
Defaults to false

If true, returns word‑level timestamps.

string

Generation mode. Currently supports only preview.

Response

Updated about 2 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 months ago