Talking videos

Make a talking-avatar video

Your avatar says your text (in a voice from GET /v1/voices) or lip-syncs your audio. Choose the engine (price per second differs: ask POST /v1/avatars/videos/estimate per engine), the format and the quality. Asynchronous; the mp4 and its SRT are copied to our storage (24 hours) and can go straight into /v1/studio/edit for captions, music and hooks.

Billing: Per second of video, by engine and avatar type (Avatar III / IV / V; photo avatar / digital twin). Failed videos are not charged. · Rate limit: 10/min · Asynchronous

post/v1/avatars/videos

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/avatars/videos
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

x-wait-msinteger

Wait for the job inside this call (ms)

Request body

speednumber

Speaking speed with script

titlestring
engine'avatar_iii' | 'avatar_iv' | 'avatar_v'

avatar_v (the newest and most lifelike, the looks that support it — GET /v1/avatars says which) · avatar_iv (default: the newest that animates every photo and twin) · avatar_iii (cheaper, rougher). The price differs per engine — ask /estimate

scriptstring

What the avatar says (up to 5,000 characters). Pauses: <break time="1s"/>

languagestring

The script's language (our code, e.g. he, en, ru, uk) — an accent hint for multilingual voices

voice_idstring

With script: a voice from GET /v1/voices (a digital twin speaks in its own voice when omitted)

audio_urlstring uri

Or your own speech (mp3 / wav, up to 10 minutes) — a recording, or a voice-over from /v1/ai/voice

avatar_idstring

Your avatar (GET /v1/avatars)

image_urlstring uri

Or animate a photo directly, without saving an avatar (Avatar IV). Needs consent

consent_idstring

A consent you recorded before (the dashboard records one when you tick the box)

resolution'720p' | '1080p' | '4k'
aspect_ratio'9:16' | '16:9' | '1:1' | '4:5' | '5:4' | 'auto'
motion_promptstring

Body motion and gestures, e.g. "gesturing with hands while presenting" (Avatar IV / V)

expressiveness'low' | 'medium' | 'high'

How lively a photo avatar is (Avatar IV)

background_colorstring

Response

Completed (or 202 while processing)

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
outputobject

Operation result (see each operation). While a Studio render is processing: stage (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), phase (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), progress (a percent, 0–100) and progress_fraction (0–1), eta_seconds (seconds left, never below 0) and estimate_seconds

errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.