API reference · HeyGen

heygen/heygen-voice

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

AUDIOAsyncOpen model

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run

Model IDheygen/heygen-voice

Input Schema

4 parameters · 1 required · 3 optional

Parameter	Type	Required	Description
`text`	string	Required	Text to speak, up to 5,000 characters. · Min length: 1 · Max length: 5000
`voice`	string	Optional	HeyGen public voice. Ignored when reference_audio is set. · Options: Jonah, Nadine, Tabitha, Soren, Elowen, Vincent, Jocelyn, Marielle, Corinne, Lucian, Kieran, Hugh, Noelle, Bram, Ewan, Iona, Cecily, Simon, Weston, Felicity, Gareth, Rory, Meredith, Sabrina · Default: "Jonah" JonahNadineTabithaSorenElowenVincentJocelynMarielleCorinneLucianKieranHughNoelleBramEwanIonaCecilySimonWestonFelicityGarethRoryMeredithSabrina
`language`	string	Optional	Language of the text. Detected automatically when omitted. · Options: ar, be, bg, ca, cs, da, de, el, en, es, fa, fi, fr, he, hi, hr, hu, id, it, ja, ko, mk, ms, nl, pl, pt, ro, ru, sk, sl, sr, sv, ta, th, tl, tr, uk, vi, zh arbebgcacsdadeelenesfafifrhehihrhuiditjakomkmsnlplptroruskslsrsvtathtltrukvizh
`reference_audio`	string	Optional	Optional single-speaker recording to clone instead of a public voice. Only the first 3 minutes are used.

Output Schema

Field	Type	Description
`id`	string	Unique identifier for the generation task
`status`	string	Task status: pending, running, completed, failed, timeout
`model`	string	Model used for the generation
`outputs`	array	Array of output items
`outputs[].url`	string	URL of the generated artifact
`outputs[].content_type`	string	MIME type (e.g. image/png, video/mp4)
`error`	object \| null	Error details if failed, null on success
`error.type`	string	Machine-readable error type code
`error.message`	string	Human-readable error description

Async Workflow

This model uses asynchronous execution. Submit a request and poll for the result.

Submit — POST to /v1/run, receive an id
Poll — GET /v1/run/{id} until status is completed, failed, or timeout
Retrieve — Read outputs from the completed response

Code Examples

Ready-to-run snippets

const apiKey = process.env.SANDBASE_API_KEY;
const response = await fetch("https://api.sandbase.ai/v1/run", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "model": "heygen/heygen-voice",
    "text": "Hello! This is HeyGen Voice, speaking on fal.",
    "voice": "Jonah"
  }),
});

if (!response.ok) throw new Error(await response.text());
let result = await response.json();
for (let attempt = 0; attempt < 120 && !["completed", "failed", "timeout"].includes(result.status); attempt++) {
  await new Promise((resolve) => setTimeout(resolve, 2_000));
  const poll = await fetch(`https://api.sandbase.ai/v1/run/${result.id}`, {
    headers: { Authorization: `Bearer ${apiKey}` },
  });
  if (!poll.ok) throw new Error(await poll.text());
  result = await poll.json();
}
if (result.status !== "completed") throw new Error(`Generation ended: ${result.status}`);
console.log(result);

← Back to HeyGen Voice