Skip to main content
POST
Create a video
Send multipart/form-data with the audio under the field name audio (singular, one file), plus the avatar’s configId. Common audio formats such as MP3 and WAV work. The response comes back straight away with status: "queued", progress: "0.00" and no video yet. The video is generated in the background:
  1. Poll: call Get video progress with the returned id every few seconds.
  2. Stop polling when status is completed, failed or cancelled.
  3. Download: once it’s completed, use Download a video.
An unknown configId isn’t rejected here. The video is created and then ends with status: "failed". Take configId from List avatars.

Authorizations

X-API-KEY
string
header
required

Body

multipart/form-data
audio
file
required

The speech, as an audio file, under the field name audio. Up to 100 MB.

configId
string
required

The avatar's model_config_id, from List avatars.

Example:

"4f0cda01-bd22-410c-8b2e-026ce07691da"

name
string

A label for the video.

Example:

"Welcome message"

Response

The new video, with status queued.

message
string
Example:

"Video generation job created successfully"

data
object