HeyGen: HeyGen Video
HeyGen Video generates 5–15-second scenes with dialogue, ambience and effects from text, a first image or visual and audio references. Its general-purpose heygen-video-1 model supports product and character shots, with reference controls and MP4 output. Clear, contained actions give it a useful production brief.
About the model
This description covers the model’s capabilities. Available in Ailoot inputs, outputs and options are listed for the selected method below.
HeyGen Video is HeyGen’s general-purpose scene-generation model, identified by the manufacturer as heygen-video-1. It creates the subject, setting, light and sound together from a creative brief. Each clip is 5–15 seconds long and contains its generated audio track, including dialogue, ambience and effects. Useful production inputs include a scene description, a product photograph or material that establishes a person, place or movement. The resulting asset is a short scene for a product presentation, an onboarding insert, a property view or other edited video work.
Three modes give the inputs different roles. Text-to-video creates a scene from the prompt. Image-to-video starts literally on the supplied image, then follows the brief for the action. Reference-to-video uses supplied images, video and optional audio to guide a newly composed scene; it requires at least one reference image or video. Choose a first-frame image when the opening composition must match a still, or references when a known object should appear in a different composition. This scene model is distinct from HeyGen’s avatar rendering engines and Video Agent composition workflow.
The maker’s guide favours detailed, concrete shot directions: one subject, one location and one contained action, with a locked or gently moving camera. Describe the camera position, lens or depth-of-field intent, light, surface texture and colour treatment. Explain where objects touch when an action depends on contact. For an original product example, use a reference photograph of a travel flask and ask for it to stand on a wooden counter while a presenter speaks beside it, with a small camera move toward the flask. Inspect the flask’s form, placement and visible markings in the result.
Reference lists support up to nine images, three videos and three audio items, with a maximum of twelve references in total. Images, videos and audio are numbered separately in the manufacturer’s prompt format: the first image is <Picture 1>, and the first video is <Video 1>. Give each reference a role and identify that role explicitly in the brief. The model reads the first five seconds of each reference video, so prepare the relevant section at the start. The API reference also specifies reference-video proportions between 1:4 and 4:1. A long clip containing the desired movement only at its end is a poor preparation for that five-second input window.
The documented reference interface accepts a directly accessible HTTPS resource, an uploaded asset identifier or inline base64. The guide lists maximum image sizes of 16 MB by URL and 5 MB inline; video or audio may be up to 32 MB by URL and 16 MB inline. Prepare readable source material with the important subject easy to distinguish and without competing instructions in different references. Keep the intended orientation in the first-frame image. These input details concern the maker’s reference workflow and help organize the creative materials for the selected mode.
Direct sound in the same brief as the picture. State the dialogue, vocal delivery, room tone and specific effects, including whether a sound should be nearby or distant. Specify the intended music treatment when the scene should contain only speech and ambience. The guide suggests allowing roughly 2.5 spoken words per second as a planning estimate, so leave room for pauses and the visible action. A short introduction can be planned as one line followed by a beat that reveals the product. Listen for the actual words and whether the generated sound fits the space and action.
Output duration is selected in whole seconds from five to fifteen, with a five-second default. Resolution is a size class: 480p, 768p, 1080p or 2k. The documented framing choices are 21:9, 16:9, 4:3, 1:1, 3:4 and 9:16. For text- and reference-to-video at 1080p or 2k, select 16:9 or 9:16; adaptive reference framing is documented at 480p and 768p. Image-to-video follows the first image’s proportions, so crop before generation when the required shape changes. Review the completed result’s actual dimensions rather than assuming a size-class label implies one conventional pixel pair.
The model guide specifies MP4 video with H.264 picture encoding and AAC audio at 32 kHz stereo. A generation is processed asynchronously, and the completed job supplies the playable video location, duration and dimensions. Its signed video location can be refreshed by retrieving the job again. Preserve the actual clip, the reference materials and the brief for an editing review. A pending or processing record tracks the generation; the completed video is the production artifact to assess for picture, speech and sound.
The manufacturer documents prompt enhancement choices of turbo, quality and disabled; disabled keeps the prepared wording as written. A fixed seed is useful when comparing a change to one clause while retaining the other inputs. Record the chosen seed and settings with the shot brief. For on-screen lettering, keep an intended phrase short and spell it precisely; the guide recommends compositing paragraphs, small print and labelled diagrams afterward. Check every visible character in a generated title rather than assuming the wording was reproduced correctly.
The guide identifies long on-screen text, soft organic movement such as petals, paper or hair, and close hand manipulation as less reliable areas. For a procedural explanation, let a clearly written line convey the steps while the image shows a stable person or object; use separately verified visuals when the physical operation itself must be exact. Review the whole shot for object continuity, contact, face and hand detail, dialogue and sound. A concise list of what should change in the next take keeps a detailed production brief practical.
Ailoot Ultra · Video POST /v1/videos heygen/heygen-video-1
heygen/heygen-video-1Overview
HeyGen Video generates 5–15-second scenes with dialogue, ambience and effects from text, a first image or visual and audio references. Its general-purpose heygen-video-1 model supports product and character shots, with reference controls and MP4 output. Clear, contained actions give it a useful production brief.
- Accepted inputs
- Text · Images · Audio · Video
- Results
- Video
Available in Ailoot · inputs & methods
Ailoot Ultra · Video POST /v1/videos
- Input types
text,image,audio,video- Output types
video- Output format
- original MP4 bytes; no normalization/transcode
| Field | Type | Requirement | Values & limits | Default |
|---|---|---|---|---|
Fieldmodel | Typestring | RequirementRequired | Values & limits heygen/heygen-video-1 | Default— |
Fieldprompt | Typestring | RequirementRequired | Values & limits | Default— |
Fieldduration | Typeinteger | RequirementRequired | Values & limits 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 Minimum: 1 Maximum: 600 | Default— |
Fieldresolution | Typestring | RequirementOptional | Values & limits 480p, 768p, 2K | Default— |
Fieldaspect_ratio | Typestring | RequirementOptional | Values & limits 21:9, 16:9, 4:3, 1:1, 3:4, 9:16 | Default— |
Fieldgenerate_audio | Typeboolean | RequirementOptional | Values & limits false | Default— |
Fieldframe_images | Typearray | RequirementOptional | Values & limits Minimum items: 1 Maximum items: 1 Input content: Array of frame objects. Each object has type=image_url, image_url containing url, and frame_type. Use an HTTPS image URL and set frame_type to first_frame. Each frame role appears at most once. Exact keys: type, image_url, frame_type Conditions: These keys describe each frame object; image_url contains only url. Omit frame_images for a text-only request. | Default— |
Fieldinput_references | Typearray | RequirementOptional | Values & limits | Default— |
Fieldseed | Typeinteger | RequirementOptional | Values & limits Minimum: -9,223,372,036,854,775,808 Maximum: 9,223,372,036,854,775,807 | Default— |
Fieldcallback_url | Typestring | RequirementOptional | Values & limits Pattern: ^https:// | Default— |
Fieldsession_id | Typestring | RequirementOptional | Values & limits | Default— |
Fieldtrace | Typeobject | RequirementOptional | Values & limits | Default— |
Fielduser | Typestring | RequirementOptional | Values & limits | Default— |
Input material combinations
Text to video · A written prompt. · Required: model, prompt, duration
Provide prompt as text and duration as whole seconds. Choose a supported resolution and, if needed, an aspect ratio.
model: Type: string · heygen/heygen-video-1
prompt: Type: string · Maximum UTF-8 bytes: 10,000 · Non-whitespace required: Yes
Image to video · A written prompt and a first-frame image. · Required: model, prompt, duration, frame_images
frame_images is an array. Each frame object has type, image_url and frame_type; image_url contains url. Set type to image_url. Use first_frame. Each frame role appears at most once. Supply a public HTTPS image URL for each frame. Choose a supported resolution and, if needed, an aspect ratio.
Exact keys: type, image_url, frame_type
model: Type: string · heygen/heygen-video-1
prompt: Type: string · Maximum UTF-8 bytes: 10,000 · Non-whitespace required: Yes
Reference to video · A written prompt and supported image, video, audio references. · Required: model, prompt, duration, input_references
input_references is an array of objects. Set type to image_url, video_url, audio_url, and use the matching field containing url. Use public HTTPS URLs. Omit frame_images to select reference mode. Choose a supported resolution and, if needed, an aspect ratio.
model: Type: string · heygen/heygen-video-1
prompt: Type: string · Maximum UTF-8 bytes: 10,000 · Non-whitespace required: Yes
Method parameters and lifecycle
| Parameter | Contract |
|---|---|
Parametercontent_type | Contractapplication/json |
Parameterrequired | Contractmodel, prompt, duration |
Parametermaterial_types | Contracttext, image, audio, video |
Parameteradditional_properties | Contractfalse |
Parameteroptional_controls | Contractresolution, aspect_ratio, generate_audio, frame_images, input_references, seed, callback_url, session_id, trace, user |
Lifecycle: submit_once_poll_original
GET /v1/videos/{public_id}
GET /v1/videos/{public_id}/content
Pricing
How the final charge is calculated
The displayed rates estimate the cost before generation. The final charge is calculated from the cost recorded for the original generation. Measured output duration and forecast quantities are not the final billable quantity.
Tariff references do not add request options. Supported parameters are listed for the selected method.
- Fast mode
- Not specified When fast mode is selected
- Flex mode
- Not specified When flex mode is selected
- Maximum reasoning effort
- Not specified When maximum reasoning effort uses the default adjustment
Estimated rates for comparison
Prices by configuration
Match each charge to the conditions shown. Use one rate for each set of alternative configurations.
| Configuration | Rate schedule | Forecast quantity | Billing unit | Billing conditions | Charge |
|---|---|---|---|---|---|
| ConfigurationBase token rates | Rate scheduleBase rate | Forecast quantity— | Billing unit— | Billing conditions— | Charge Input · Input tokens · Estimate for comparison only — / 1K tokens Output · Output tokens · Estimate for comparison only — / 1K tokens Input · Cache read · Estimate for comparison only — / 1K tokens Input · Cache write · Estimate for comparison only — / 1K tokens Input · Cache write, 1 hour · Estimate for comparison only — / 1K tokens |
| ConfigurationVideo price | Rate schedule— | Forecast quantity— | Billing unitper video second | Billing conditionsresolution: 2k | Charge Output · Video price · Estimate for comparison only $0.2 per video second |
| ConfigurationVideo price | Rate schedule— | Forecast quantity— | Billing unitper video second | Billing conditionsresolution: 480p | Charge Output · Video price · Estimate for comparison only $0.04 per video second |
| ConfigurationVideo price | Rate schedule— | Forecast quantity— | Billing unitper video second | Billing conditionsresolution: 768p | Charge Output · Video price · Estimate for comparison only $0.072 per video second |
| ConfigurationVideo price | Rate schedule— | Forecast quantity— | Billing unitper video second | Billing conditionsgeneration mode: reference; resolution: 2k | Charge Output · Video price · Estimate for comparison only $0.36 per video second |
| ConfigurationVideo price | Rate schedule— | Forecast quantity— | Billing unitper video second | Billing conditionsgeneration mode: reference; resolution: 480p | Charge Output · Video price · Estimate for comparison only $0.14 per video second |
| ConfigurationVideo price | Rate schedule— | Forecast quantity— | Billing unitper video second | Billing conditionsgeneration mode: reference; resolution: 768p | Charge Output · Video price · Estimate for comparison only $0.2 per video second |
| Configurationreference input image | Rate schedule— | Forecast quantity— | Billing unitper reference input image | Billing conditions— | Charge Input · reference input image · Estimate for comparison only $0.08 per reference input image |
| ConfigurationEstimated generation cost | Rate schedule— | Forecast quantityone generation estimate | Billing unit— | Billing conditions— | Charge Output · Estimated generation cost · Estimate for comparison only $0.2 estimate before generation This estimate is not an additional charge or a fixed rate for the completed generation. |
Ailoot reserves an estimated amount before a request. After the result, it settles the final charge from measured usage. Streaming settlement uses the final usage record. How reservation and settlement work →
Reference tariff details
Model-level reference schedules do not change method selection, quotes or charges. Active charges use the selected Ailoot method rates.
Video configuration price references
Prices by configuration
Match each charge to the conditions shown. Use one rate for each set of alternative configurations.
| Configuration | Billing conditions | Charge |
|---|---|---|
| ConfigurationVideo price | Billing conditionsresolution: 2k | Charge Output · Video price $0.18 per video second Published price reference for the configuration shown. Final charges follow the actual billed configuration. |
| ConfigurationVideo price | Billing conditionsresolution: 480p | Charge Output · Video price $0.04 per video second Published price reference for the configuration shown. Final charges follow the actual billed configuration. |
| ConfigurationVideo price | Billing conditionsresolution: 768p | Charge Output · Video price $0.06 per video second Published price reference for the configuration shown. Final charges follow the actual billed configuration. |
| ConfigurationVideo price | Billing conditionsgeneration mode: reference; resolution: 2k | Charge Output · Video price $0.36 per video second Published price reference for the configuration shown. Final charges follow the actual billed configuration. |
| ConfigurationVideo price | Billing conditionsgeneration mode: reference; resolution: 480p | Charge Output · Video price $0.08 per video second Published price reference for the configuration shown. Final charges follow the actual billed configuration. |
| ConfigurationVideo price | Billing conditionsgeneration mode: reference; resolution: 768p | Charge Output · Video price $0.12 per video second Published price reference for the configuration shown. Final charges follow the actual billed configuration. |
Example requests
Ailoot Ultra · Video
set -eu
: "${AILOOT_API_KEY:?Set your Ailoot API key}"
python3 - <<'PY_REQUEST'
from pathlib import Path
Path('request.json').write_text('{"aspect_ratio":"16:9","duration":8,"model":"heygen/heygen-video-1","prompt":"A serene mountain landscape at sunset","resolution":"480p"}', encoding='utf-8')
PY_REQUEST
curl --fail-with-body --silent --show-error https://api.ailoot.ai/v1/videos \
-H "Authorization: Bearer $AILOOT_API_KEY" -H 'Content-Type: application/json' \
--data-binary @request.json -D response-headers.txt -o result.json
python3 - <<'PY_RESULT'
import json
from pathlib import Path
r=json.loads(Path('result.json').read_text())
print(json.dumps(r,ensure_ascii=False,indent=2))
print('Keep the complete JSON and response headers; do not resubmit an unknown creation.')
PY_RESULT
Receive and save results
Ailoot Ultra · Video
signed owned content URLs
GET /v1/videos/{public_id}GET /v1/videos/{public_id}/content
Check job status
set -eu
: "${AILOOT_API_KEY:?Set your Ailoot API key}"
python3 - <<'PY_STATUS_URL'
import json
from pathlib import Path
from urllib.parse import quote
r=json.loads(Path('result.json').read_text())
if not isinstance(r.get('id'),str) or not r['id']:raise SystemExit('Keep the original response and headers for reconciliation; no returned ID')
Path('status-url.txt').write_text('https://api.ailoot.ai/v1/videos/'+quote(r['id'],safe=''))
PY_STATUS_URL
curl --fail-with-body --silent --show-error "$(cat status-url.txt)" \
-H "Authorization: Bearer $AILOOT_API_KEY" -D status-headers.txt -o status.json
python3 - <<'PY_RESULT'
import json
from pathlib import Path
r=json.loads(Path('status.json').read_text())
print(json.dumps(r,ensure_ascii=False,indent=2))
print('Keep the complete JSON and response headers; do not resubmit an unknown creation.')
PY_RESULT
Other content reads
set -eu
: "${AILOOT_API_KEY:?Set your Ailoot API key}"
export AILOOT_API_KEY
python3 - <<'PY_ASSETS'
import json,os,subprocess
from pathlib import Path
from urllib.parse import urljoin,urlsplit
r=json.loads(Path('status.json').read_text())
if r.get('status')!='completed':raise SystemExit('Keep the original ID and read its status; never recreate an unknown job')
if not isinstance(r.get('data'),list) or not r['data']:raise SystemExit('Keep the complete original status; no completed outputs supplied')
urls=[]
for i,u in enumerate(r.get('data',[])):
if not isinstance(u,str):raise SystemExit('Keep the original response; unexpected asset shape')
urls.append((str(i),u))
for label,path in urls:
u=urljoin('https://api.ailoot.ai',path);z=urlsplit(u)
if z.scheme!='https' or z.netloc!='api.ailoot.ai' or z.username or z.password:raise SystemExit('Use the actual returned Ailoot owned content URL')
target=Path('owned-'+label+'.bin')
subprocess.run(['curl','--fail-with-body','--silent','--show-error',u,'-H','Authorization: Bearer '+os.environ['AILOOT_API_KEY'],'-D',str(target)+'.headers','-o',str(target)],check=True)
print('All returned owned URLs saved; complete metadata, timing and usage remain in the JSON.')
PY_ASSETS
Keep all completed results
Save every completed video or returned file; retrieve every actual returned asset URL.
Keep every actual owned output and its returned measured metadata.
If the original response needs checking
503 result_pending_check + originalid + X-Should-Retry:false; never replay original
Response fields
| Field | Type | Meaning |
|---|---|---|
Fieldindex | Typeinteger | MeaningZero-based position of this video in the outputs list. |
Fieldcontent_url | Typestring | MeaningSigned HTTPS download URL for this completed video. |
Fieldsha256 | Typestring | null | MeaningSHA-256 digest of the original video bytes; null if unavailable. |
Fieldsize_bytes | Typeinteger | null | MeaningSize of the original video file in bytes; null if unavailable. |
Fieldduration_ms | Typeinteger | null | MeaningMeasured video duration in milliseconds; null if unavailable. |
Fieldwidth | Typeinteger | null | MeaningVideo width in pixels; null if unavailable. |
Fieldheight | Typeinteger | null | MeaningVideo height in pixels; null if unavailable. |
Fieldvideo_codec | Typestring | null | MeaningVideo codec identifier; null if not recorded. |
Fieldhas_audio | Typeboolean | null | MeaningWhether the video contains an audio track; null if not measured. |
Fieldaudio_codec | Typestring | null | MeaningAudio codec identifier; null when no identifier is recorded. |
Errors and next steps
| Response | Condition | Next step |
|---|---|---|
Response404 · not_found_error | ConditionVideo access is unavailable, or this video ID was not found. | Next stepCheck video access. For an existing video, use its original public ID and the same API key. |
Response401 · authentication_error | ConditionThe API key does not match the authenticated account. | Next stepCheck your API key and account access before submitting. |
Response400 · invalid_request_error | ConditionThe request could not be read, or the download index is invalid. | Next stepCorrect the request body. For a download, choose an output index returned by the original task. |
Response422 · price_unavailable | ConditionThe selected video configuration cannot be priced. | Next stepChoose a supported video configuration and complete its required options before submitting a corrected request. |
Response422 · invalid_request_error | ConditionA video input or original continuation task is invalid. | Next stepUse valid HTTPS inputs. For continuation, use your completed original public video ID with the same API key. |
Response402 · billing_error | ConditionThe available balance or limits do not allow a reservation. | Next stepCheck your available balance and limits before sending a new request. |
Response503 · server_error | ConditionVideo verification, storage or service access is temporarily unavailable. | Next stepWait for service availability. If you already have a video ID, check that original task instead of creating another generation. |
Response503 · result_pending_check | ConditionThe original video result and charge need checking. | Next stepKeep the returned video ID and check that task. Do not send a replacement generation request while it is being checked. |
Response503 · owned_result_unavailable | ConditionThe existing video download is temporarily unavailable. | Next stepCheck the same video task later and download its existing output. A new generation creates a separate operation. |
Response409 · video_not_ready | ConditionThe video content has not been published. | Next stepCheck the original task status. Download after it reports completed; if it reports failed, follow its charge-check notice. |
Aliases
Model aliases
Ailoot Ultra heygen/heygen-video-1
Method path aliases
Use the method paths shown above.
Related caller IDs
FAQ · HeyGen: HeyGen Video
- What inputs and results are available?
POST /v1/videos·heygen/heygen-video-1:text,image,audio,video→video- Which fields does the request use?
POST /v1/videos·heygen/heygen-video-1:model,prompt,duration,resolution,aspect_ratio,generate_audio,frame_images,input_references,seed,callback_url,session_id,trace,user- What limits apply?
POST /v1/videos·heygen/heygen-video-1:duration.minimum:1;duration.maximum:600;frame_images.max_items:1;frame_images.min_items:1;seed.minimum:-9223372036854775808;seed.maximum:9223372036854775807