Request fields

Avatar creation

Field	Type	Required	Description
type	string	Yes	prompt, photo, or props.
name	string	Yes	Human-readable avatar name.
prompt	string	Required for prompt	Avatar description.
file.type	string	Required for photo	Use url.
file.url	string	Required for photo	Portrait image URL.
ethnicity	string	Required for props	Asian, South Asian, Southeast Asian, Black, Hispanic, Middle Eastern, White, or Wasian.
sex	string	Required for props	male or female.
age	integer	Required for props	Must be at least 20.
webhook_url	string	No	HTTPS URL that receives avatar.ready or avatar.failed when the job reaches a terminal state.

UGC video

Field	Type	Required	Description
script	string	Yes	Spoken script for the generated video.
product_image	string	Yes	Product/reference image URL.
scene.type	string	No	prompt or photo. Controls the first generated reference frame background.
scene.prompt	string	Required when scene.type is prompt	Scene direction, such as in front of a mirror inside a room.
scene.image_url	string	Required when scene.type is photo	Scene/background image URL.
avatar.mode	string	Yes	Use existing.
avatar.avatar_id	string	Yes	Ready avatar ID.
ratio	string	No	Output aspect ratio. Defaults to 9:16.
aspect_ratio	string	No	Alias for ratio.
title	string	No	Optional video title.
webhook_url	string	No	HTTPS URL that receives avatar_video.ready or avatar_video.failed when the job reaches a terminal state.