Skip to main content
POST
Render take video
Start talking-avatar video for a take that is ready_to_render with audio_url set. This locks phonemes and video instructions. Credits are charged when the job starts. If there are not enough credits, the request fails and the take is unchanged. Optional body (both default true):
  • show_ai_label — overlay This is AI. Can be false on any plan.
  • show_logo — overlay Made by plus the Akapulu Labs logo. false requires Starter or higher.
Recommend leaving show_ai_label on. Invisible watermarks and Content Credentials still go on the files. Details: AI content disclosure. Poll Get take until status is complete, then download video_url.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

clip_id
string<uuid>
required

Clip ID.

take_id
string<uuid>
required

Take ID.

Body

application/json
show_ai_label
boolean
default:true

Overlay This is AI. Allowed false on every plan.

Overlay Made by plus the Akapulu Labs logo. false requires Starter or higher.

Response

Video job started

id
string<uuid>
required
clip_id
string<uuid>
required
name
string
required
status
enum<string>
required

Current landmark. Poll until ready_to_render for audio, complete for video.

Available options:
starting_tts,
generating_audio,
generating_motion_instructions,
ready_to_render,
starting_video,
preparing_video,
generating_face_video,
generating_avatar_gestures,
compositing,
applying_labels,
watermarking,
signing,
complete,
failed
avatar_id
string<uuid>
required
error
string | null
required
audio_url
string | null
required

Hour-long download URL once audio exists.

video_url
string | null
required

Hour-long download URL once video exists.

created_at
string<date-time>
required
updated_at
string<date-time>
required
text
string
phonemes
string
chunk_prompts
object[]
show_ai_label
boolean
estimated_seconds
number

Approximate seconds left in the current job.

credits_charged
any

Credits charged for this request, when a job was billed.

credits_used
any
credits_remaining
any