HeyGen Voice Text to Speech API
Multilingual text-to-speech in hundreds of stock voices.
POST /v2/heygen-voice-tts · submit + poll 1# pip install "segmind>=1.1.0"
2# export SEGMIND_API_KEY="YOUR_API_KEY"
3import segmind
4
5# Async (v2): submit to the queue and block until COMPLETED.
6# run() returns the final result dict (600s deadline, 1.0s poll by default).
7result = segmind.run(
8 "heygen-voice-tts",
9 text="Forty-one nights on the mountain, and still nothing. Then, at 3:12 in the morning, the screen lit up. Could this really be it? I called Dr. Okafor at the Atacama station, my hands shaking so hard I could barely hold the phone. We checked it twice, then a third time - and yes, it was real. After three years, we had finally found it.",
10 voice_id="049413e41c334753984c294d694afb5c",
11 speed=1,
12 expressiveness=1,
13)
14print(result["status"]) # COMPLETED
15print(result.get("output")) # model output (e.g. media URL)
16print(result["metrics"]["inference_time"]) # server compute seconds
17
18# --- Or submit + poll manually (track request_id, control the cadence) ---
19from segmind import SegmindClient, InferenceFailed, InferenceTimeout
20
21client = SegmindClient() # reads SEGMIND_API_KEY
22payload = {
23 "text": "Forty-one nights on the mountain, and still nothing. Then, at 3:12 in the morning, the screen lit up. Could this really be it? I called Dr. Okafor at the Atacama station, my hands shaking so hard I could barely hold the phone. We checked it twice, then a third time - and yes, it was real. After three years, we had finally found it.",
24 "voice_id": "049413e41c334753984c294d694afb5c",
25 "speed": 1,
26 "expressiveness": 1,
27}
28job = client.submit_async("heygen-voice-tts", **payload)
29print(job.request_id) # available immediately
30try:
31 result = job.wait(timeout=600, interval=1.0)
32except InferenceTimeout as e:
33 print("still running:", e.request_id)
34except InferenceFailed as e:
35 print("failed:", e.detail) 1# pip install "segmind>=1.1.0"
2# export SEGMIND_API_KEY="YOUR_API_KEY"
3import segmind
4
5# Async (v2): submit to the queue and block until COMPLETED.
6# run() returns the final result dict (600s deadline, 1.0s poll by default).
7result = segmind.run(
8 "heygen-voice-tts",
9 text="Forty-one nights on the mountain, and still nothing. Then, at 3:12 in the morning, the screen lit up. Could this really be it? I called Dr. Okafor at the Atacama station, my hands shaking so hard I could barely hold the phone. We checked it twice, then a third time - and yes, it was real. After three years, we had finally found it.",
10 voice_id="049413e41c334753984c294d694afb5c",
11 speed=1,
12 expressiveness=1,
13)
14print(result["status"]) # COMPLETED
15print(result.get("output")) # model output (e.g. media URL)
16print(result["metrics"]["inference_time"]) # server compute seconds
17
18# --- Or submit + poll manually (track request_id, control the cadence) ---
19from segmind import SegmindClient, InferenceFailed, InferenceTimeout
20
21client = SegmindClient() # reads SEGMIND_API_KEY
22payload = {
23 "text": "Forty-one nights on the mountain, and still nothing. Then, at 3:12 in the morning, the screen lit up. Could this really be it? I called Dr. Okafor at the Atacama station, my hands shaking so hard I could barely hold the phone. We checked it twice, then a third time - and yes, it was real. After three years, we had finally found it.",
24 "voice_id": "049413e41c334753984c294d694afb5c",
25 "speed": 1,
26 "expressiveness": 1,
27}
28job = client.submit_async("heygen-voice-tts", **payload)
29print(job.request_id) # available immediately
30try:
31 result = job.wait(timeout=600, interval=1.0)
32except InferenceTimeout as e:
33 print("still running:", e.request_id)
34except InferenceFailed as e:
35 print("failed:", e.detail)API Endpoint
https://api.segmind.com/v1/heygen-voice-ttsParameters
textrequiredstringScript to speak, up to 5,000 characters. Multi-sentence text with varied punctuation reads most naturally. On stock voices, pause with <break time="0.5s"/> (seconds only).
"Forty-one nights on the mountain, and still nothing. Then, at 3:12 in the morning, the screen lit up. Could this really be it? I called Dr. Okafor at the Atacama station, my hands shaking so hard I could barely hold the phone. We checked it twice, then a third time - and yes, it was real. After three years, we had finally found it."voice_idrequiredstringA HeyGen stock catalog voice ID, or a voice you made with heygen-voice-clone (private to your workspace).
"049413e41c334753984c294d694afb5c"engineoptionalstringOptional stock-voice engine. Premade catalog voices reject a pin, so leave it unset.
"orca""starfish"expressivenessoptionalnumberEmotional range for cloned voices, 0 to 1. Near 1 is lively, around 0.2 is calm; stock voices use the default.
1Range: 0 - 1languageoptionalstringOptional code like en, pt-BR, or zh-HK. Auto-detected from the text when unset; set it to force a language.
speedoptionalnumberPlayback speed 0.5 to 2, stock voices only. Keep at 1 for cloned voices.
1Range: 0.5 - 2Response Type
Returns: Audio
Asynchronous requests (v2)
Use Async for video, long-running (>~60s), or high-concurrency workloads; Sync is simplest for fast image & LLM calls. Async submits a request and you poll it to completion.
- 1
POST /v2/heygen-voice-ttsSubmit — returns request_id, status_url, response_url
- 2
GET /v2/requests/{id}/statusPoll — until COMPLETED or FAILED
- 3
GET /v2/requests/{id}Result — final response body
Status states
- A FAILED request is served as HTTP 422 — the body still carries the error detail.
- An unknown or expired request_id returns HTTP 404.
- Results are retained for 1 hour, then expire.
- Content / RAI blocks surface as FAILED, not a separate state.
- Track completion by polling the status endpoint.
Common Error Codes
The API returns standard HTTP status codes. Detailed error messages are provided in the response body.
Bad Request
Invalid parameters or request format
Unauthorized
Missing or invalid API key
Forbidden
Insufficient permissions
Not Found
Model or endpoint not found
Insufficient Credits
Not enough credits to process request
Rate Limited
Too many requests
Server Error
Internal server error
Bad Gateway
Service temporarily unavailable
Timeout
Request timed out