Skip to main content
POST
Quote a video

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

A UUID. When present, deduplicates repeat submissions. See /api-reference/idempotency.

Body

application/json
template
enum<string>
default:talking_avatar
required

Which recipe makes the video: talking_avatar (a presenter over your site), remotion (motion graphics with a narrator), freeform_ai (one generated clip per scene), meme_hook (a viral clip into your presenter), interview (2 to 4 avatars in a split screen), phone_mockup (your video, site or photos on a phone in a hand), slideshow (captioned still slides) or real_footage (a real stock clip with a caption).

Available options:
talking_avatar,
remotion,
freeform_ai,
meme_hook,
interview,
phone_mockup,
slideshow,
real_footage
format
enum<string>
default:vertical
required

vertical (9:16) or horizontal (16:9)

Available options:
vertical,
horizontal
target_duration_seconds
enum<number>
default:30
required

Roughly how long a written script runs. Ignored when you send script. Each template supports its own subset.

Available options:
10,
15,
20,
30,
45,
60,
120,
180,
300
avatar_layout
enum<string>
default:center
required

Where the presenter sits. audio_only is for an automated demo only.

Available options:
center,
bubble_bottom_left,
bubble_bottom_right,
audio_only
background_mode
enum<string>
default:static
required

What the presenter stands in front of: static (a still of the site), scrolling (scrolls the site or several images), footage (your uploaded video), automated_demo (an agent clicks through your product), original (the presenter's own set) or image (a photo).

Available options:
static,
scrolling,
footage,
automated_demo,
original,
image
preset
string

A style of that template, e.g. imessage for remotion. Omit for the template's default.

source_url
string<uri>

The website the video is about

source_text
string

A description of the business, product or offer, in your words

Required string length: 1 - 5000
source_image_urls
string<uri>[]

Images already uploaded to LumisReach, in the order the video shows them

Maximum array length: 10
source_video_urls
string<uri>[]

Videos already uploaded to LumisReach, in order

Maximum array length: 5
script
string

Your own script, spoken word for word. Only for templates that read a script (talking_avatar, meme_hook, phone_mockup, real_footage). The video skips script review and is charged when it is created.

Required string length: 1 - 60000
avatar_provider
enum<string>

Who renders the presenter. Defaults to heygen for an interview and tavus otherwise (Tavus without replica_id or avatar_id uses the account's default presenter).

Available options:
heygen,
tavus,
elevenlabs
avatar_id
string<uuid>

One of your saved avatars (required for ElevenLabs)

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
replica_id
string

A pre-made presenter: a Tavus face or a HeyGen look

Required string length: 1 - 100
heygen_engine
enum<string>

HeyGen only. Omit for the most advanced engine the look supports.

Available options:
avatar_iii,
avatar_iv,
avatar_v
voice_id
string

An ElevenLabs avatar's voice, or the narrator of a narrated template

Required string length: 1 - 100
interview_cast
(object | null)[]

interview only: who is in each window, in order. A null window is cast for you.

Maximum array length: 4
background_image

image background: a built-in photo's slug, or upload:<index> for one of your images

Available options:
modern-office,
classical-hall,
library,
city-skyline,
city-street,
mountains,
park,
beach,
cafe,
loft
b_roll
boolean

talking_avatar only: cut away to stock clips while the presenter talks

subtitle_style
enum<string>

Burned-in subtitles. Default none.

Available options:
none,
classic,
boxed,
bold_words
subtitle_position
enum<string> | null

Null keeps the style's own place

Available options:
top,
middle,
bottom
subtitle_size
enum<string>
Available options:
small,
medium,
large
video_model
string

freeform_ai only: <model>@<tier>, e.g. seedance-2.5@720p. Omit for the default.

slide_count
integer

slideshow only

Required range: 3 <= x <= 10
slide_source
enum<string>

slideshow only: where the pictures come from. Default ai.

Available options:
uploaded,
website,
ai
image_model
string

slideshow with AI pictures: the image model. Omit for the default.

stock_footage
enum<string>

real_footage only: the clip, by slug

Available options:
young-woman-braids-portrait,
stylish-senior-woman-hat,
man-coffee-fedora,
woman-curly-hair-turns,
taxi-driver-by-cab,
bald-man-smiling,
asian-woman-laughing,
nurse-in-corridor,
woman-hijab-smiling,
man-dimple-smile,
grandmother-on-sofa,
man-coat-field,
older-man-plants,
young-man-glasses-curls,
construction-worker-hard-hat,
shop-owner-packing-box,
barista-iced-coffee,
man-making-pancakes,
senior-woman-reading,
man-driving-car,
florist-arranging-bouquet,
woman-cooking-spices,
woman-laptop-phone-breakfast,
woman-morning-coffee,
older-man-tea,
grandma-baking-with-granddaughter,
man-typing-laptop,
barista-pouring-milk,
builder-hammering-wall,
woman-treadmill-gym
on_screen_caption
string

real_footage only: the caption over the clip. Omit to have one written.

Maximum string length: 150
footage_narrated
boolean

real_footage only: whether a narrator reads the script. Default true.

meme_clip_id
string<uuid>

meme_hook: a clip from your library...

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
stock_meme_clip
enum<string>

...or a built-in clip, by slug

Available options:
dramatic-chipmunk,
sneezing-panda,
keyboard-cat,
vibing-cat,
screaming-goat,
coffin-dance,
epic-sax-guy,
rick-roll,
office-rage,
surprised-kitty
phone_screen
enum<string>

phone_mockup only: what plays on the phone. Omit to pick video, then website, then photos.

Available options:
video,
website,
photos
demo_focus
string

Site demos: the features to show, in your words

Maximum string length: 1000
demo_login
object

Site demos: sign in first to show the product behind the login

Response

Success

data
object
required