Recipes
This page is a short index of recipes. For Avatar, the canonical
/v1/avatar-1.0/* routes are the best choice. The deep guides are in
Models.
A Format that you run for your own customers has a longer recipe of its own. Refer to Embed a Format in your product.
Verify a key
List current capabilities
Create an avatar
Create an Avatar 1.0 identity
POST /v1/avatar-1.0/generate
Required
Create an avatar video
The estimated length of an avatar-video script must be 4-60 seconds
inclusive. For the default plus path, do not send quality.
Create an avatar talking video
POST /v1/avatar-1.0/talking-video
Required
Preview first frames, then generate
Create an avatar-video preview
POST /v1/avatar-video-previews
Required
After the preview job completes:
Generate video from preview
POST /v1/avatar-video-previews/{id}/generate-video
Required
Face swap (Beta)
Create a face-swap job (Beta)
POST /v1/models/sume/avatar-face-swap/v1.0/runs
Required
Caption an existing video
Create a video caption job
POST /v1/video-captions
Required
Search trending TikTok videos
Search trending TikTok videos
POST /v1/trending-videos/search
Required
Generate an image
Deep guide: Image 1.0.
Generate an Image 1.0 job
POST /v1/image-1.0/generate
Required
Generate a video
Deep guide: Video 1.0.
Generate a Video 1.0 job
POST /v1/video-1.0/generate
Required
Generate music
Deep guide: Music 1.0. Do not send duration on Music 1.0.
Generate a Music 1.0 job
POST /v1/music-1.0/generate
Required
Poll and fetch result
Use media inputs
The API is URL-first. For normal flows, a separate asset upload is not necessary. Use public HTTPS URLs directly in these launch request fields:
- Avatar photo input:
input.image_url - Avatar Video product reference:
product_image - Avatar Video scene photo reference:
scene.image_url - Face swap / captions source:
video_url
Refer to Media inputs.