Make a video with every setting the dashboard’s Configure step has: the template and style, format, length, sources, presenter, background, captions and more. Send script to have it spoken word for word (templates that read a script only): the video skips script review and is charged now. Without one, a script is written from your sources first, then approved automatically as soon as it is written (script_review: auto, the default) or left in script_review for POST /v1/videos/{id}/approve (manual). The video is charged once, when it is released to render, at the price POST /v1/videos/quote gives; set max_price_cents to cap it. Included video credits are used first, then the prepaid balance. On the API & MCP plan and the Growth Marketing Manager hire a video is charged at cost plus 20%; on Revenue Engine and Custom it is free; other plans get 403 plan_not_included. Poll GET /v1/videos/{id} until status is ready, then download video_url or post it with POST /v1/videos/{id}/posts.
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: ai_videographer (the AI edits like a human editor: animation, real footage, photos, cutouts and a presenter on camera, with a narrator), talking_avatar (a presenter over your site), remotion (motion graphics with a narrator), site_demo (an automated demo: an agent clicks through your website, screen-recorded, 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:
ai_videographer,
talking_avatar,
remotion,
site_demo,
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
script_review
enum<string>
default:auto
required
Without your own script, one is written first. auto approves it (and charges the video) as soon as it is written; manual stops in script_review until you call POST /v1/videos/{id}/approve. Ignored when you send script: your script needs no review.
Available options:
auto,
manual
preset
string
A style of that template, e.g. imessage for remotion. Omit for the template's default.
title
string
Your name for the video. Kept as its title; omit it and the title is written from the script.
Required string length: 1 - 100
brief
string
What you want this video to be, in a sentence or two: the subject, the audience and the feel. The script is written to it. Ignored when you send script.
Required string length: 1 - 1000
language
enum<string>
The language the video is made in, as a code (en, es, fr, de, pt-BR, ja, ...): the script, the voiceover, on-screen text, subtitles, the title, the caption and the hashtags are all written and spoken in it, whatever language the sources are in. Default en. Your own script is spoken as you wrote it. INTERVIEW is made in en only: any other language is refused.
Available options:
en,
en-GB,
en-AU,
es,
es-ES,
fr,
fr-CA,
de,
it,
pt-BR,
pt,
nl,
pl,
sv,
da,
no,
fi,
cs,
el,
hu,
ro,
ru,
uk,
tr,
ar,
he,
hi,
zh,
zh-Hant,
zh-TW,
zh-Hans-TW,
yue,
yue-Hans,
ja,
ko,
id,
ms,
fil,
vi,
th
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
source_image_kinds
(enum<string> | null)[]
What each of source_image_urls is, in the same order: screen (a screenshot), photo, logo (your logo: shown by the end logo scene and nowhere else in the video) or other (a flyer, a chart, an illustration). null, or leaving the list out, has us read the image and decide.
Maximum array length: 10
Available options:
screen,
photo,
logo,
other
source_video_kinds
(enum<string> | null)[]
What each of source_video_urls is, in the same order: talking (someone talking to the camera), broll (footage to cut away to) or screen (a screen recording). null, or leaving the list out, has us read the video and decide.
Maximum array length: 5
Available options:
talking,
broll,
screen
script
string
Your own script, spoken word for word. Only for templates that read a script (talking_avatar, meme_hook, phone_mockup, real_footage), and for a slideshow, whose post text it is (up to 4000 characters). The video skips script review and is charged when it is created; a slideshow's slides are still planned from it, so it is reviewed as script_review says.
Required string length: 1 - 60000
avatar_provider
enum<string>
Who renders the presenter. Left out with a replica_id or avatar_id, that presenter is a Tavus one. Left out with neither, it is tavus for an interview (cast from its stock faces) and heygen otherwise. HeyGen without replica_id or avatar_id uses one of its pre-made presenters, chosen to fit the source text where one does; Tavus without them uses the account's default presenter.
Available options:
heygen,
tavus,
elevenlabs
avatar_id
string<uuid>
One of your saved avatars (required for ElevenLabs)
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: an ElevenLabs voice id, a Cartesia voice as cartesia:<voice id>, a Fish Audio voice as fish:<voice id>, or a built-in speaker as openai:<name> (e.g. openai:ash). A narrator left unset is the ElevenLabs default, spoken with eleven_v4
Required string length: 1 - 100
voice_model
string
The ElevenLabs speech model an ElevenLabs narrator is spoken with: eleven_v4, the only one. The retired eleven_v3, eleven_multilingual_v2 and eleven_flash_v2_5 are still accepted and spoken with eleven_v4. Ignored for any other narrator.
interview_cast
(object | null)[]
interview only: who is in each window, in order. A null window is cast for you.
Maximum array length: 4
Show child attributes
background_image
enum<string>string
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: cut away to B-roll while the presenter talks (never while they talk about what is behind them). freeform_ai: cut away to B-roll over the generated scenes while the narration carries on. remotion: cut to B-roll scenes between the drawn ones; each comes on once the scene before it has finished, with the narration over it.
b_roll_sources
enum<string>[]
With b_roll: what it is made of; several is a mix, chosen per cutaway or scene. For talking_avatar: stock (filmed stock footage), motion_graphics (one animated scene of the point being made), ai (a 5 second clip generated for the topic, charged per clip), youtube (a few seconds cut from a real YouTube video of a named event, person, product or moment the script refers to, charged per clip; third-party footage, credited in the caption, which a platform may mute or take down), online_image (the real photo of the very person, product, event or place the script names, found on Google Images and held full frame for a few seconds, charged per photo; third-party photos, credited in the caption) or greenscreen (one of your own screenshots or screen recordings from source_image_urls and source_video_urls, shown on a filmed phone or laptop, whichever fits its shape) or image (one of your own source_image_urls held full frame for a few seconds; see b_roll_images). Or any, alone: the planner picks per cutaway from all of those the video can use, and decides whether the video ends on an end card. For freeform_ai: the same, but ai, since its scenes are generated clips already. For remotion: automated_demo (a recording of your product being clicked through; needs source_url, takes demo_focus and demo_login), stock, ai, talking_avatar (a presenter says that scene on camera in their original background; HeyGen or Tavus, chosen with avatar_provider and replica_id or avatar_id, charged per second) uploaded (shots cut from source_video_urls), image (one of your own source_image_urls held full frame for the line about what it shows, blended in and out), youtube or online_image (as for talking_avatar, held for the length of the scene). Default ["stock"].
Required array length: 1 - 11 elements
Available options:
any,
stock,
motion_graphics,
ai,
youtube,
online_image,
greenscreen,
image,
uploaded,
automated_demo,
talking_avatar
b_roll_images
integer[]
With the image B-roll source: which of source_image_urls the cutaways may show, by index from 0. Each is shown at most once, on the words about what it shows. Omitted, the planner chooses among your photos.
Maximum array length: 8
Required range: 0 <= x <= 9007199254740991
b_roll_opening
boolean
With b_roll: let the video open on a cutaway instead of on the presenter. Default false.
b_roll_layouts
enum<string>[]
With b_roll, on talking_avatar, video_edit or freeform_ai: where in the frame a cutaway may play; several is a mix, each cutaway in the one that suits its footage. full_screen covers the whole video; top_third (vertical videos only) plays across the top third, blurred into the presenter below, for wide footage; side_third (horizontal videos only) plays down the third on the side away from the presenter, for upright footage; picture_in_picture is a floating box kept clear of the presenter, faces and on-screen text, moving as the presenter does (where nowhere is clear it takes your next layout, or with none, the spot that covers least); top_half (vertical videos only) plays across the top half, the presenter moved down below it with their head and shoulders in view; right_half (horizontal videos only) plays down the right half. Or any, alone: each cutaway in whichever of those suits it (never top_half or right_half). Layouts the video's format does not offer are dropped. Default ["any"].
Required array length: 1 - 7 elements
Available options:
any,
full_screen,
top_third,
side_third,
picture_in_picture,
top_half,
right_half
b_roll_end_scene
boolean
talking_avatar or freeform_ai, with or without b_roll: join an end card (a motion-graphics scene, for example a like and follow card, or where to book) to the end of the video, played after it has finished. It is always drawn, never footage. Drawn in b_roll_motion_style. Default false.
b_roll_end_scene_text
string
With b_roll_end_scene: the line the end card shows. Omitted, it is written for the video.
Maximum string length: 70
b_roll_end_scene_sound
enum<string>
With b_roll_end_scene: the sound effect the scene comes on with. Omitted is none.
Available options:
sparkle,
pop,
whoosh,
ding,
chime,
success,
notification,
impact,
riser
b_roll_end_scene_voice_id
string
With b_roll_end_scene: the voice that says the end card's line out loud as it plays, an ElevenLabs voice id or a built-in speaker such as openai:ash. Omitted is no voiceover.
Required string length: 1 - 200
b_roll_motion_style
enum<string>
With motion_graphics B-roll: the remotion style the cutaways are drawn in. Default motion-graphics-1.
Available options:
motion-graphics-1,
launch-video,
motion-graphics-2,
motion-graphics-3,
motion-graphics-4,
motion-graphics-5,
motion-graphics-6,
diorama,
clinic,
boutique,
notebook,
newsroom,
keynote,
motion-graphics-7,
motion-graphics-8,
prism,
momentum
videographer_sources
enum<string>[]
ai_videographer only: what its scenes may be made of (the dashboard's "What it may use"); several is a mix, chosen scene by scene. any (alone) is everything below. motion_graphics is synthesized graphics: shapes, 3D, arrows, diagrams, charts and maps drawn in code (leave it out for a video composed of media alone). stock (filmed stock footage), ai (a clip generated for the scene), talking_avatar (a presenter says the line on camera), uploaded (shots from source_video_urls and your website's videos), image (your photos), youtube (a few seconds of a real YouTube video of what the script names, credited) and online_image (the real photo of what the script names, found on Google Images, credited). Default ["any"].
Required array length: 1 - 9 elements
Available options:
any,
motion_graphics,
stock,
ai,
talking_avatar,
uploaded,
image,
youtube,
online_image
videographer_model
enum<string>
ai_videographer only: the Claude model that writes and animates the video (the dashboard's "Claude model"): anthropic/claude-fable-5.2 (most capable, slowest), anthropic/claude-opus-5.5 (deeper reasoning, faster), anthropic/claude-sonnet-5.5 (fast and capable). Default anthropic/claude-opus-5.5.
Available options:
anthropic/claude-fable-5.2,
anthropic/claude-opus-5.5,
anthropic/claude-sonnet-5.5
videographer_actions
integer
ai_videographer only: how much happens on screen, 0 to 100 (the dashboard's "Actions" slider). 100 is full of action, a new shot every few seconds; around 20 to 40 is calm (longer scenes, the presenter on screen longer, media full screen or in half the frame, simple cuts); 0 is long still scenes with straight cuts. Default 100.
Required range: 0 <= x <= 100
presenter_narrates
boolean
ai_videographer only: its HeyGen presenter always says their own lines on camera; true has them narrate the scenes they are off camera in too (one voice throughout), false leaves those to voice_id. Default true.
narration
integer
ai_videographer, remotion, freeform_ai and site_demo: how much of the video a narrator speaks over, 0 to 100. 100 is narrated throughout; 50 is a voice over about half of it, the silent scenes carried by the picture, on-screen words and music; 0 is no narration at all. Default 100.
Required range: 0 <= x <= 100
post_format
enum<string>
slideshow only: what the post is. text is its words alone (X, LinkedIn and Facebook), image its words with one captioned picture, carousel its words with slide_count captioned slides to swipe through. Default carousel. To have the post researched and written to perform on one network, use POST /v1/optimized-posts instead.
Available options:
text,
image,
carousel
post_orientation
enum<string>
slideshow with pictures only: their shape. square (1:1, shown whole on every feed), vertical (9:16, fills TikTok photo mode) or horizontal (16:9, fills an X, LinkedIn or Facebook feed). Default square.
Available options:
square,
vertical,
horizontal
subtitle_style
enum<string>
Captions of what is said, burned in along the bottom of the frame. dynamic adds each word as it is said and clears after a pause or about six words; dynamic_highlight does the same with a black border on the text and only the newest word in colour; emphasis does the same with a black border on the text and the important words in colour; enlarge shows four or five words at a time the same way, with one important word of each set bold and larger; one_word shows only the word being said; highlight shows a few words at a time with the one being said in colour; comic is comic-book lettering, a few big yellow capitals at a time with a heavy outline. Default none. Ignored by real_footage, which has written captions instead; on slideshow it styles the slide captions (classic, boxed or bold_words).
Available options:
none,
classic,
boxed,
bold_words,
dynamic,
dynamic_highlight,
emphasis,
enlarge,
one_word,
comic,
highlight
subtitle_position
enum<string> | null
Where the captions sit. On real_footage null is the top, on slideshow null keeps each slide's own place, and for spoken captions null is along the bottom.
Available options:
top,
middle,
bottom
subtitle_emojis
boolean
Floats an emoji beside the spoken captions at the few moments that deserve one (a question, a shocking fact, the call to action), chosen from what is said. Needs a subtitle_style other than none. Default false.
subtitle_size
enum<string>
How big the captions are drawn, relative to the style's own size. Default medium.
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: uploaded (your images), website (screenshots), ai (drawn) or google (real photos found on Google Images). Default ai.
Available options:
uploaded,
website,
ai,
google
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. It must be one filmed in the video's format.
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,
older-man-white-beard,
man-glasses-sunset,
woman-hugging-herself,
woman-walks-up-courtyard,
woman-laughing-brick-wall,
woman-laughing-forest,
man-grinning-forest,
bald-man-glare,
man-chin-thinking,
man-gasps-disbelief,
woman-glasses-ties-hair,
barista-pour-over,
market-vendor-tray,
builder-shovelling-sand,
painter-rolling-wall,
support-agent-headset,
man-phone-call-laptop,
older-man-laptop-park,
woman-tablet-cafe,
woman-phone-smiling,
office-worker-late,
pharmacist-typing,
woman-blow-drying-hair,
cook-lifts-pot-lid,
woman-sipping-mug
on_screen_caption
string
real_footage only: the caption over the clip, or up to 3 captions shown one after another, separated by a blank line (each at most 150 characters). Omit to have one written.
Maximum string length: 454
footage_narrated
boolean
real_footage only: whether a narrator reads the script. Default true.
phone_mockup: what plays on the device's screen. website scrolls the site and automated_demo clicks through it, either planned with the script from the site's map. Omit to pick video, then website, then photos. With greenscreen B-roll on another template: website makes a cutaway of the site scroll instead of the automated demo it is by default.
Available options:
video,
website,
automated_demo,
photos
device_clip
enum<string>
phone_mockup only: the device clip (a phone, tablet, laptop or monitor with a green screen), by slug. It must be one filmed in the video's format. Omit to have one picked that suits what is on screen.
Available options:
hand-phone,
phone-shop-floor,
phone-scrolling,
phone-in-car,
phone-sideways-sofa,
phone-cafe,
tablet-wood-desk,
tablet-marble-desk,
tablet-coffee-break,
tablet-flat-lay,
laptop-typing,
laptop-alarm-clock,
laptop-sideboard,
monitor-home-office,
phone-hand-city,
phone-hand-grey,
phone-two-hands,
phone-blue-wall,
laptop-living-room,
phone-hand-city-wide,
phone-hand-grey-wide,
phone-sideways-two-hands,
phone-sideways-close,
laptop-window-desk,
laptop-couch-typing,
laptop-navy-room,
laptop-woman-desk,
laptop-white-desk,
laptop-close-up,
phone-sideways-backdrop,
phone-backdrop
device_background
enum<string>
phone_mockup with a device_clip filmed against a green backdrop (a -backdrop slug): the built-in photo behind the device. Omit for the default.
Available options:
modern-office,
classical-hall,
library,
city-skyline,
city-street,
mountains,
park,
beach,
cafe,
loft
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
Show child attributes
max_price_cents
integer
A spending cap. With your own script the price is known now, and a video above the cap is rejected with 400 before anything is created. Otherwise the written script is priced when it is approved automatically; above the cap it is not approved and waits in script_review with the reason in error. With script_review: manual, pass the cap to the approve call instead.
Required range: 0 <= x <= 9007199254740991
caption
string
The post caption. Omit to use the one written with the script.
Maximum string length: 4000
hashtags
string[]
Hashtags for the post, with or without #
Maximum array length: 30
Maximum string length: 101
music
object
Background music mixed under the finished video: any track GET /v1/videos/music lists, from the built-in library, Epidemic Sound, your AI-generated tracks or commercial music. A track that cannot be used is a 400 before the video is made. A talking_avatar video sent without it gets a random royalty-free track. There is no level to set: the music plays at full volume wherever nobody speaks and comes down to about 30% under speech. Change it later with PUT /v1/videos/{id}/music.
Show child attributes
Response
Success
data
object
required
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"LumisReach","colors":{"primary":"#111827","light":"#d6d6d6","dark":"#111827"},"favicon":"https://mintcdn.com/lumis-labs/buUUrJV81nyLaiDT/favicon.png?fit=max\u0026auto=format\u0026n=buUUrJV81nyLaiDT\u0026q=85\u0026s=56327232f3ec8c84959027c8e5ec7585","api":{},"navbar":{"links":[{"href":"mailto:founders@lumisreach.com","label":"Contact Support"}],"primary":{"type":"button","label":"Get Started","href":"https://app.lumisreach.com"}},"footer":{"socials":{"x":"https://x.com/lumisreach","linkedin":"https://linkedin.com/company/lumisreach"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lumis-labs","hasAudioNarration":false,"actualSubdomain":"lumis-labs","customDomains":["docs.lumisreach.com"],"gitSource":{"type":"github","owner":"lumisai","repo":"reach","deployBranch":"prod","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6b00e04c48d16fff59c9460d","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":147},{"language":"default","tag":"Solutions","count":37},{"language":"default","tag":"Get Started","count":31},{"language":"default","tag":"Videos","count":22},{"language":"default","tag":"Integrations","count":20},{"language":"default","tag":"Quick Agent Actions","count":14},{"language":"default","tag":"Use Cases","count":10},{"language":"default","tag":"Calls, Texts and Contacts","count":9},{"language":"default","tag":"Concepts","count":9},{"language":"default","tag":"Enterprise Registration","count":9}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"global.css","content":"sidebar-group:has(sidebar-group-header [data-tag]),sidebar-group:has(sidebar-group-header .sidebar-group-tag),sidebar-group:has(sidebar-group-header .tag){opacity:0.45}"}]}
{"page":{"pagePath":"api-reference/videos/create-a-video","slug":"/api-reference/videos/create-a-video","pageMetadata":{"title":"Create a video","description":"Make a video with every setting the dashboard's Configure step has: the template and style, format, length, sources, presenter, background, captions and more. Send `script` to have it spoken word for word (templates that read a script only): the video skips script review and is charged now. Without one, a script is written from your sources first, then approved automatically as soon as it is written (`script_review: auto`, the default) or left in `script_review` for `POST /v1/videos/{id}/approve` (`manual`). The video is charged once, when it is released to render, at the price `POST /v1/videos/quote` gives; set `max_price_cents` to cap it. Included video credits are used first, then the prepaid balance. On the API \u0026 MCP plan and the Growth Marketing Manager hire a video is charged at cost plus 20%; on Revenue Engine and Custom it is free; other plans get `403 plan_not_included`. Poll `GET /v1/videos/{id}` until `status` is `ready`, then download `video_url` or post it with `POST /v1/videos/{id}/posts`.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos","href":"/api-reference/videos/create-a-video","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Make a video with every setting the dashboard’s Configure step has: the template and style, format, length, sources, presenter, background, captions and more. Send \", _jsx(_components.code, {\n children: \"script\"\n }), \" to have it spoken word for word (templates that read a script only): the video skips script review and is charged now. Without one, a script is written from your sources first, then approved automatically as soon as it is written (\", _jsx(_components.code, {\n children: \"script_review: auto\"\n }), \", the default) or left in \", _jsx(_components.code, {\n children: \"script_review\"\n }), \" for \", _jsx(_components.code, {\n children: \"POST /v1/videos/{id}/approve\"\n }), \" (\", _jsx(_components.code, {\n children: \"manual\"\n }), \"). The video is charged once, when it is released to render, at the price \", _jsx(_components.code, {\n children: \"POST /v1/videos/quote\"\n }), \" gives; set \", _jsx(_components.code, {\n children: \"max_price_cents\"\n }), \" to cap it. Included video credits are used first, then the prepaid balance. On the API \u0026 MCP plan and the Growth Marketing Manager hire a video is charged at cost plus 20%; on Revenue Engine and Custom it is free; other plans get \", _jsx(_components.code, {\n children: \"403 plan_not_included\"\n }), \". Poll \", _jsx(_components.code, {\n children: \"GET /v1/videos/{id}\"\n }), \" until \", _jsx(_components.code, {\n children: \"status\"\n }), \" is \", _jsx(_components.code, {\n children: \"ready\"\n }), \", then download \", _jsx(_components.code, {\n children: \"video_url\"\n }), \" or post it with \", _jsx(_components.code, {\n children: \"POST /v1/videos/{id}/posts\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a video","description":"Make a video with every setting the dashboard's Configure step has: the template and style, format, length, sources, presenter, background, captions and more. Send `script` to have it spoken word for word (templates that read a script only): the video skips script review and is charged now. Without one, a script is written from your sources first, then approved automatically as soon as it is written (`script_review: auto`, the default) or left in `script_review` for `POST /v1/videos/{id}/approve` (`manual`). The video is charged once, when it is released to render, at the price `POST /v1/videos/quote` gives; set `max_price_cents` to cap it. Included video credits are used first, then the prepaid balance. On the API \u0026 MCP plan and the Growth Marketing Manager hire a video is charged at cost plus 20%; on Revenue Engine and Custom it is free; other plans get `403 plan_not_included`. Poll `GET /v1/videos/{id}` until `status` is `ready`, then download `video_url` or post it with `POST /v1/videos/{id}/posts`.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos","href":"/api-reference/videos/create-a-video","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/lumis-labs/b06234118c1a31ee/scripts/autofill-auth.js"],"openApiReferenceData":{"operation":{"operationId":"v1_videos_post","tags":["Videos"],"summary":"Create a video","description":"Make a video with every setting the dashboard's Configure step has: the template and style, format, length, sources, presenter, background, captions and more. Send `script` to have it spoken word for word (templates that read a script only): the video skips script review and is charged now. Without one, a script is written from your sources first, then approved automatically as soon as it is written (`script_review: auto`, the default) or left in `script_review` for `POST /v1/videos/{id}/approve` (`manual`). The video is charged once, when it is released to render, at the price `POST /v1/videos/quote` gives; set `max_price_cents` to cap it. Included video credits are used first, then the prepaid balance. On the API \u0026 MCP plan and the Growth Marketing Manager hire a video is charged at cost plus 20%; on Revenue Engine and Custom it is free; other plans get `403 plan_not_included`. Poll `GET /v1/videos/{id}` until `status` is `ready`, then download `video_url` or post it with `POST /v1/videos/{id}/posts`.","parameters":["0c1c0cc5-e700-4c4c-9db6-63bffd6a6211"],"requestBody":"f3a12180-d1b5-4ed1-8289-516f44ea5f29","responses":{"200":"c3c72b58-5ca5-4995-8310-00298d894321","400":"77e73a97-a542-445d-89c0-816d8afc3dcd","401":"69f0757c-8a7d-49f1-8ecb-3ce8db5aeae8","403":"44a412af-2f88-4a74-a443-836949e1f621","404":"4cf31ab1-4bb9-4430-9347-e8d5f369fe13","409":"37661d52-3dbf-444f-ac88-9b9581480886","429":"ade3de8a-4b13-45f3-99e9-e2d9efba0deb"},"x-scopes":["videos:write"],"x-rate-limit":{"requestsPerMinute":600},"method":"post","type":"path","servers":["7a2be0e8-c1bb-4813-9f77-551d2a6398e6"],"security":["8b50598a-9f4d-48cc-8e28-e0b25e0d4033"],"path":"/v1/videos","baseUrlOptions":["https://api.lumisreach.com/api"],"title":"Create a video","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"0c1c0cc5-e700-4c4c-9db6-63bffd6a6211":{"name":"Idempotency-Key","in":"header","required":false,"description":"A UUID. When present, deduplicates repeat submissions. See /api-reference/idempotency.","schema":{"type":"string","isRequired":false,"description":"A UUID. When present, deduplicates repeat submissions. See /api-reference/idempotency.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"template":{"default":"talking_avatar","description":"Which recipe makes the video: `ai_videographer` (the AI edits like a human editor: animation, real footage, photos, cutouts and a presenter on camera, with a narrator), `talking_avatar` (a presenter over your site), `remotion` (motion graphics with a narrator), `site_demo` (an automated demo: an agent clicks through your website, screen-recorded, 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).","type":"string","enum":["ai_videographer","talking_avatar","remotion","site_demo","freeform_ai","meme_hook","interview","phone_mockup","slideshow","real_footage"],"isRequired":true,"uniqueKey":"template","typeLabel":"enum\u003cstring>"},"format":{"default":"vertical","description":"`vertical` (9:16) or `horizontal` (16:9)","type":"string","enum":["vertical","horizontal"],"isRequired":true,"uniqueKey":"format","typeLabel":"enum\u003cstring>"},"target_duration_seconds":{"default":30,"description":"Roughly how long a written script runs. Ignored when you send `script`. Each template supports its own subset.","type":"number","enum":[10,15,20,30,45,60,120,180,300],"isRequired":true,"uniqueKey":"target_duration_seconds","typeLabel":"enum\u003cnumber>"},"avatar_layout":{"default":"center","description":"Where the presenter sits. `audio_only` is for an automated demo only.","type":"string","enum":["center","bubble_bottom_left","bubble_bottom_right","audio_only"],"isRequired":true,"uniqueKey":"avatar_layout","typeLabel":"enum\u003cstring>"},"background_mode":{"default":"static","description":"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).","type":"string","enum":["static","scrolling","footage","automated_demo","original","image"],"isRequired":true,"uniqueKey":"background_mode","typeLabel":"enum\u003cstring>"},"script_review":{"default":"auto","description":"Without your own `script`, one is written first. `auto` approves it (and charges the video) as soon as it is written; `manual` stops in `script_review` until you call `POST /v1/videos/{id}/approve`. Ignored when you send `script`: your script needs no review.","type":"string","enum":["auto","manual"],"isRequired":true,"uniqueKey":"script_review","typeLabel":"enum\u003cstring>"},"preset":{"description":"A style of that template, e.g. `imessage` for `remotion`. Omit for the template's default.","type":"string","uniqueKey":"preset","typeLabel":"string"},"title":{"description":"Your name for the video. Kept as its `title`; omit it and the title is written from the script.","type":"string","minLength":1,"maxLength":100,"uniqueKey":"title","typeLabel":"string"},"brief":{"description":"What you want this video to be, in a sentence or two: the subject, the audience and the feel. The script is written to it. Ignored when you send `script`.","type":"string","minLength":1,"maxLength":1000,"uniqueKey":"brief","typeLabel":"string"},"language":{"description":"The language the video is made in, as a code (`en`, `es`, `fr`, `de`, `pt-BR`, `ja`, ...): the script, the voiceover, on-screen text, subtitles, the title, the caption and the hashtags are all written and spoken in it, whatever language the sources are in. Default `en`. Your own `script` is spoken as you wrote it. `INTERVIEW` is made in `en` only: any other language is refused.","type":"string","enum":["en","en-GB","en-AU","es","es-ES","fr","fr-CA","de","it","pt-BR","pt","nl","pl","sv","da","no","fi","cs","el","hu","ro","ru","uk","tr","ar","he","hi","zh","zh-Hant","zh-TW","zh-Hans-TW","yue","yue-Hans","ja","ko","id","ms","fil","vi","th"],"uniqueKey":"language","typeLabel":"enum\u003cstring>"},"source_url":{"description":"The website the video is about","type":"string","format":"uri","uniqueKey":"source_url","typeLabel":"string\u003curi>"},"source_text":{"description":"A description of the business, product or offer, in your words","type":"string","minLength":1,"maxLength":5000,"uniqueKey":"source_text","typeLabel":"string"},"source_image_urls":{"description":"Images already uploaded to LumisReach, in the order the video shows them","maxItems":10,"type":"array","items":{"type":"string","format":"uri","uniqueKey":"source_image_urls.items.[INDEX]","typeLabel":"string\u003curi>"},"uniqueKey":"source_image_urls","typeLabel":"string\u003curi>[]"},"source_video_urls":{"description":"Videos already uploaded to LumisReach, in order","maxItems":5,"type":"array","items":{"type":"string","format":"uri","uniqueKey":"source_video_urls.items.[INDEX]","typeLabel":"string\u003curi>"},"uniqueKey":"source_video_urls","typeLabel":"string\u003curi>[]"},"source_image_kinds":{"description":"What each of `source_image_urls` is, in the same order: `screen` (a screenshot), `photo`, `logo` (your logo: shown by the end logo scene and nowhere else in the video) or `other` (a flyer, a chart, an illustration). `null`, or leaving the list out, has us read the image and decide.","maxItems":10,"type":"array","items":{"oneOf":[{"type":"string","enum":["screen","photo","logo","other"],"uniqueKey":"source_image_kinds.items.[INDEX].oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"source_image_kinds.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"source_image_kinds.items.[INDEX]","typeLabel":"enum\u003cstring> | null"},"uniqueKey":"source_image_kinds","typeLabel":"(enum\u003cstring> | null)[]"},"source_video_kinds":{"description":"What each of `source_video_urls` is, in the same order: `talking` (someone talking to the camera), `broll` (footage to cut away to) or `screen` (a screen recording). `null`, or leaving the list out, has us read the video and decide.","maxItems":5,"type":"array","items":{"oneOf":[{"type":"string","enum":["talking","broll","screen"],"uniqueKey":"source_video_kinds.items.[INDEX].oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"source_video_kinds.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"source_video_kinds.items.[INDEX]","typeLabel":"enum\u003cstring> | null"},"uniqueKey":"source_video_kinds","typeLabel":"(enum\u003cstring> | null)[]"},"script":{"description":"Your own script, spoken word for word. Only for templates that read a script (`talking_avatar`, `meme_hook`, `phone_mockup`, `real_footage`), and for a `slideshow`, whose post text it is (up to 4000 characters). The video skips script review and is charged when it is created; a slideshow's slides are still planned from it, so it is reviewed as `script_review` says.","type":"string","minLength":1,"maxLength":60000,"uniqueKey":"script","typeLabel":"string"},"avatar_provider":{"description":"Who renders the presenter. Left out with a `replica_id` or `avatar_id`, that presenter is a Tavus one. Left out with neither, it is `tavus` for an interview (cast from its stock faces) and `heygen` otherwise. HeyGen without `replica_id` or `avatar_id` uses one of its pre-made presenters, chosen to fit the source text where one does; Tavus without them uses the account's default presenter.","type":"string","enum":["heygen","tavus","elevenlabs"],"uniqueKey":"avatar_provider","typeLabel":"enum\u003cstring>"},"avatar_id":{"description":"One of your saved avatars (required for ElevenLabs)","type":"string","format":"uuid","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)$","uniqueKey":"avatar_id","typeLabel":"string\u003cuuid>"},"replica_id":{"description":"A pre-made presenter: a Tavus face or a HeyGen look","type":"string","minLength":1,"maxLength":100,"uniqueKey":"replica_id","typeLabel":"string"},"heygen_engine":{"description":"HeyGen only. Omit for the most advanced engine the look supports.","type":"string","enum":["avatar_iii","avatar_iv","avatar_v"],"uniqueKey":"heygen_engine","typeLabel":"enum\u003cstring>"},"voice_id":{"description":"An ElevenLabs avatar's voice, or the narrator of a narrated template: an ElevenLabs voice id, a Cartesia voice as `cartesia:\u003cvoice id>`, a Fish Audio voice as `fish:\u003cvoice id>`, or a built-in speaker as `openai:\u003cname>` (e.g. `openai:ash`). A narrator left unset is the ElevenLabs default, spoken with `eleven_v4`","type":"string","minLength":1,"maxLength":100,"uniqueKey":"voice_id","typeLabel":"string"},"voice_model":{"description":"The ElevenLabs speech model an ElevenLabs narrator is spoken with: `eleven_v4`, the only one. The retired `eleven_v3`, `eleven_multilingual_v2` and `eleven_flash_v2_5` are still accepted and spoken with `eleven_v4`. Ignored for any other narrator.","type":"string","uniqueKey":"voice_model","typeLabel":"string"},"interview_cast":{"description":"`interview` only: who is in each window, in order. A null window is cast for you.","maxItems":4,"type":"array","items":{"oneOf":[{"type":"object","properties":{"replica_id":{"description":"A pre-made presenter id","type":"string","minLength":1,"maxLength":100,"uniqueKey":"interview_cast.items.[INDEX].oneOf.0.replica_id","typeLabel":"string"},"avatar_id":{"description":"One of your own saved avatars","type":"string","format":"uuid","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)$","uniqueKey":"interview_cast.items.[INDEX].oneOf.0.avatar_id","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"uniqueKey":"interview_cast.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"interview_cast.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"interview_cast.items.[INDEX]","typeLabel":"object | null"},"uniqueKey":"interview_cast","typeLabel":"(object | null)[]"},"background_image":{"oneOf":[{"type":"string","description":"`image` background: a built-in photo's slug, or `upload:\u003cindex>` for one of your images","enum":["modern-office","classical-hall","library","city-skyline","city-street","mountains","park","beach","cafe","loft"],"uniqueKey":"background_image.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"`image` background: a built-in photo's slug, or `upload:\u003cindex>` for one of your images","pattern":"^upload:(\\d{1,2})$","uniqueKey":"background_image.oneOf.1","typeLabel":"string"}],"uniqueKey":"background_image","typeLabel":"enum\u003cstring> | string"},"b_roll":{"description":"`talking_avatar`: cut away to B-roll while the presenter talks (never while they talk about what is behind them). `freeform_ai`: cut away to B-roll over the generated scenes while the narration carries on. `remotion`: cut to B-roll scenes between the drawn ones; each comes on once the scene before it has finished, with the narration over it.","type":"boolean","uniqueKey":"b_roll","typeLabel":"boolean"},"b_roll_sources":{"description":"With `b_roll`: what it is made of; several is a mix, chosen per cutaway or scene. For `talking_avatar`: `stock` (filmed stock footage), `motion_graphics` (one animated scene of the point being made), `ai` (a 5 second clip generated for the topic, charged per clip), `youtube` (a few seconds cut from a real YouTube video of a named event, person, product or moment the script refers to, charged per clip; third-party footage, credited in the caption, which a platform may mute or take down), `online_image` (the real photo of the very person, product, event or place the script names, found on Google Images and held full frame for a few seconds, charged per photo; third-party photos, credited in the caption) or `greenscreen` (one of your own screenshots or screen recordings from `source_image_urls` and `source_video_urls`, shown on a filmed phone or laptop, whichever fits its shape) or `image` (one of your own `source_image_urls` held full frame for a few seconds; see `b_roll_images`). Or `any`, alone: the planner picks per cutaway from all of those the video can use, and decides whether the video ends on an end card. For `freeform_ai`: the same, but `ai`, since its scenes are generated clips already. For `remotion`: `automated_demo` (a recording of your product being clicked through; needs `source_url`, takes `demo_focus` and `demo_login`), `stock`, `ai`, `talking_avatar` (a presenter says that scene on camera in their original background; HeyGen or Tavus, chosen with `avatar_provider` and `replica_id` or `avatar_id`, charged per second) `uploaded` (shots cut from `source_video_urls`), `image` (one of your own `source_image_urls` held full frame for the line about what it shows, blended in and out), `youtube` or `online_image` (as for `talking_avatar`, held for the length of the scene). Default `[\"stock\"]`.","minItems":1,"maxItems":11,"type":"array","items":{"type":"string","enum":["any","stock","motion_graphics","ai","youtube","online_image","greenscreen","image","uploaded","automated_demo","talking_avatar"],"uniqueKey":"b_roll_sources.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"b_roll_sources","typeLabel":"enum\u003cstring>[]"},"b_roll_images":{"description":"With the `image` B-roll source: which of `source_image_urls` the cutaways may show, by index from 0. Each is shown at most once, on the words about what it shows. Omitted, the planner chooses among your photos.","maxItems":8,"type":"array","items":{"type":"integer","minimum":0,"maximum":9007199254740991,"uniqueKey":"b_roll_images.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"b_roll_images","typeLabel":"integer[]"},"b_roll_opening":{"description":"With `b_roll`: let the video open on a cutaway instead of on the presenter. Default false.","type":"boolean","uniqueKey":"b_roll_opening","typeLabel":"boolean"},"b_roll_layouts":{"description":"With `b_roll`, on `talking_avatar`, `video_edit` or `freeform_ai`: where in the frame a cutaway may play; several is a mix, each cutaway in the one that suits its footage. `full_screen` covers the whole video; `top_third` (vertical videos only) plays across the top third, blurred into the presenter below, for wide footage; `side_third` (horizontal videos only) plays down the third on the side away from the presenter, for upright footage; `picture_in_picture` is a floating box kept clear of the presenter, faces and on-screen text, moving as the presenter does (where nowhere is clear it takes your next layout, or with none, the spot that covers least); `top_half` (vertical videos only) plays across the top half, the presenter moved down below it with their head and shoulders in view; `right_half` (horizontal videos only) plays down the right half. Or `any`, alone: each cutaway in whichever of those suits it (never `top_half` or `right_half`). Layouts the video's format does not offer are dropped. Default `[\"any\"]`.","minItems":1,"maxItems":7,"type":"array","items":{"type":"string","enum":["any","full_screen","top_third","side_third","picture_in_picture","top_half","right_half"],"uniqueKey":"b_roll_layouts.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"b_roll_layouts","typeLabel":"enum\u003cstring>[]"},"b_roll_end_scene":{"description":"`talking_avatar` or `freeform_ai`, with or without `b_roll`: join an end card (a motion-graphics scene, for example a like and follow card, or where to book) to the end of the video, played after it has finished. It is always drawn, never footage. Drawn in `b_roll_motion_style`. Default false.","type":"boolean","uniqueKey":"b_roll_end_scene","typeLabel":"boolean"},"b_roll_end_scene_text":{"description":"With `b_roll_end_scene`: the line the end card shows. Omitted, it is written for the video.","type":"string","maxLength":70,"uniqueKey":"b_roll_end_scene_text","typeLabel":"string"},"b_roll_end_scene_sound":{"description":"With `b_roll_end_scene`: the sound effect the scene comes on with. Omitted is none.","type":"string","enum":["sparkle","pop","whoosh","ding","chime","success","notification","impact","riser"],"uniqueKey":"b_roll_end_scene_sound","typeLabel":"enum\u003cstring>"},"b_roll_end_scene_voice_id":{"description":"With `b_roll_end_scene`: the voice that says the end card's line out loud as it plays, an ElevenLabs voice id or a built-in speaker such as `openai:ash`. Omitted is no voiceover.","type":"string","minLength":1,"maxLength":200,"uniqueKey":"b_roll_end_scene_voice_id","typeLabel":"string"},"b_roll_motion_style":{"description":"With `motion_graphics` B-roll: the `remotion` style the cutaways are drawn in. Default `motion-graphics-1`.","type":"string","enum":["motion-graphics-1","launch-video","motion-graphics-2","motion-graphics-3","motion-graphics-4","motion-graphics-5","motion-graphics-6","diorama","clinic","boutique","notebook","newsroom","keynote","motion-graphics-7","motion-graphics-8","prism","momentum"],"uniqueKey":"b_roll_motion_style","typeLabel":"enum\u003cstring>"},"videographer_sources":{"description":"`ai_videographer` only: what its scenes may be made of (the dashboard's \"What it may use\"); several is a mix, chosen scene by scene. `any` (alone) is everything below. `motion_graphics` is synthesized graphics: shapes, 3D, arrows, diagrams, charts and maps drawn in code (leave it out for a video composed of media alone). `stock` (filmed stock footage), `ai` (a clip generated for the scene), `talking_avatar` (a presenter says the line on camera), `uploaded` (shots from `source_video_urls` and your website's videos), `image` (your photos), `youtube` (a few seconds of a real YouTube video of what the script names, credited) and `online_image` (the real photo of what the script names, found on Google Images, credited). Default `[\"any\"]`.","minItems":1,"maxItems":9,"type":"array","items":{"type":"string","enum":["any","motion_graphics","stock","ai","talking_avatar","uploaded","image","youtube","online_image"],"uniqueKey":"videographer_sources.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"videographer_sources","typeLabel":"enum\u003cstring>[]"},"videographer_model":{"description":"`ai_videographer` only: the Claude model that writes and animates the video (the dashboard's \"Claude model\"): `anthropic/claude-fable-5.2` (most capable, slowest), `anthropic/claude-opus-5.5` (deeper reasoning, faster), `anthropic/claude-sonnet-5.5` (fast and capable). Default `anthropic/claude-opus-5.5`.","type":"string","enum":["anthropic/claude-fable-5.2","anthropic/claude-opus-5.5","anthropic/claude-sonnet-5.5"],"uniqueKey":"videographer_model","typeLabel":"enum\u003cstring>"},"videographer_actions":{"description":"`ai_videographer` only: how much happens on screen, 0 to 100 (the dashboard's \"Actions\" slider). 100 is full of action, a new shot every few seconds; around 20 to 40 is calm (longer scenes, the presenter on screen longer, media full screen or in half the frame, simple cuts); 0 is long still scenes with straight cuts. Default 100.","type":"integer","minimum":0,"maximum":100,"uniqueKey":"videographer_actions","typeLabel":"integer"},"presenter_narrates":{"description":"`ai_videographer` only: its HeyGen presenter always says their own lines on camera; `true` has them narrate the scenes they are off camera in too (one voice throughout), `false` leaves those to `voice_id`. Default `true`.","type":"boolean","uniqueKey":"presenter_narrates","typeLabel":"boolean"},"narration":{"description":"`ai_videographer`, `remotion`, `freeform_ai` and `site_demo`: how much of the video a narrator speaks over, 0 to 100. 100 is narrated throughout; 50 is a voice over about half of it, the silent scenes carried by the picture, on-screen words and music; 0 is no narration at all. Default 100.","type":"integer","minimum":0,"maximum":100,"uniqueKey":"narration","typeLabel":"integer"},"post_format":{"description":"`slideshow` only: what the post is. `text` is its words alone (X, LinkedIn and Facebook), `image` its words with one captioned picture, `carousel` its words with `slide_count` captioned slides to swipe through. Default `carousel`. To have the post researched and written to perform on one network, use `POST /v1/optimized-posts` instead.","type":"string","enum":["text","image","carousel"],"uniqueKey":"post_format","typeLabel":"enum\u003cstring>"},"post_orientation":{"description":"`slideshow` with pictures only: their shape. `square` (1:1, shown whole on every feed), `vertical` (9:16, fills TikTok photo mode) or `horizontal` (16:9, fills an X, LinkedIn or Facebook feed). Default `square`.","type":"string","enum":["square","vertical","horizontal"],"uniqueKey":"post_orientation","typeLabel":"enum\u003cstring>"},"subtitle_style":{"description":"Captions of what is said, burned in along the bottom of the frame. `dynamic` adds each word as it is said and clears after a pause or about six words; `dynamic_highlight` does the same with a black border on the text and only the newest word in colour; `emphasis` does the same with a black border on the text and the important words in colour; `enlarge` shows four or five words at a time the same way, with one important word of each set bold and larger; `one_word` shows only the word being said; `highlight` shows a few words at a time with the one being said in colour; `comic` is comic-book lettering, a few big yellow capitals at a time with a heavy outline. Default `none`. Ignored by `real_footage`, which has written captions instead; on `slideshow` it styles the slide captions (`classic`, `boxed` or `bold_words`).","type":"string","enum":["none","classic","boxed","bold_words","dynamic","dynamic_highlight","emphasis","enlarge","one_word","comic","highlight"],"uniqueKey":"subtitle_style","typeLabel":"enum\u003cstring>"},"subtitle_position":{"oneOf":[{"type":"string","description":"Where the captions sit. On `real_footage` null is the top, on `slideshow` null keeps each slide's own place, and for spoken captions null is along the bottom.","enum":["top","middle","bottom"],"uniqueKey":"subtitle_position.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Where the captions sit. On `real_footage` null is the top, on `slideshow` null keeps each slide's own place, and for spoken captions null is along the bottom.","uniqueKey":"subtitle_position.oneOf.1","typeLabel":"null"}],"uniqueKey":"subtitle_position","typeLabel":"enum\u003cstring> | null"},"subtitle_emojis":{"description":"Floats an emoji beside the spoken captions at the few moments that deserve one (a question, a shocking fact, the call to action), chosen from what is said. Needs a `subtitle_style` other than `none`. Default `false`.","type":"boolean","uniqueKey":"subtitle_emojis","typeLabel":"boolean"},"subtitle_size":{"description":"How big the captions are drawn, relative to the style's own size. Default `medium`.","type":"string","enum":["small","medium","large"],"uniqueKey":"subtitle_size","typeLabel":"enum\u003cstring>"},"video_model":{"description":"`freeform_ai` only: `\u003cmodel>@\u003ctier>`, e.g. `seedance-2.5@720p`. Omit for the default.","type":"string","uniqueKey":"video_model","typeLabel":"string"},"slide_count":{"description":"`slideshow` only","type":"integer","minimum":3,"maximum":10,"uniqueKey":"slide_count","typeLabel":"integer"},"slide_source":{"description":"`slideshow` only: where the pictures come from: `uploaded` (your images), `website` (screenshots), `ai` (drawn) or `google` (real photos found on Google Images). Default `ai`.","type":"string","enum":["uploaded","website","ai","google"],"uniqueKey":"slide_source","typeLabel":"enum\u003cstring>"},"image_model":{"description":"`slideshow` with AI pictures: the image model. Omit for the default.","type":"string","uniqueKey":"image_model","typeLabel":"string"},"stock_footage":{"description":"`real_footage` only: the clip, by slug. It must be one filmed in the video's `format`.","type":"string","enum":["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","older-man-white-beard","man-glasses-sunset","woman-hugging-herself","woman-walks-up-courtyard","woman-laughing-brick-wall","woman-laughing-forest","man-grinning-forest","bald-man-glare","man-chin-thinking","man-gasps-disbelief","woman-glasses-ties-hair","barista-pour-over","market-vendor-tray","builder-shovelling-sand","painter-rolling-wall","support-agent-headset","man-phone-call-laptop","older-man-laptop-park","woman-tablet-cafe","woman-phone-smiling","office-worker-late","pharmacist-typing","woman-blow-drying-hair","cook-lifts-pot-lid","woman-sipping-mug"],"uniqueKey":"stock_footage","typeLabel":"enum\u003cstring>"},"on_screen_caption":{"description":"`real_footage` only: the caption over the clip, or up to 3 captions shown one after another, separated by a blank line (each at most 150 characters). Omit to have one written.","type":"string","maxLength":454,"uniqueKey":"on_screen_caption","typeLabel":"string"},"footage_narrated":{"description":"`real_footage` only: whether a narrator reads the script. Default true.","type":"boolean","uniqueKey":"footage_narrated","typeLabel":"boolean"},"meme_clip_id":{"description":"`meme_hook`: a clip from your library...","type":"string","format":"uuid","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)$","uniqueKey":"meme_clip_id","typeLabel":"string\u003cuuid>"},"stock_meme_clip":{"description":"...or a built-in clip, by slug","type":"string","enum":["dramatic-chipmunk","sneezing-panda","keyboard-cat","vibing-cat","screaming-goat","coffin-dance","epic-sax-guy","rick-roll","office-rage","surprised-kitty"],"uniqueKey":"stock_meme_clip","typeLabel":"enum\u003cstring>"},"phone_screen":{"description":"`phone_mockup`: what plays on the device's screen. `website` scrolls the site and `automated_demo` clicks through it, either planned with the script from the site's map. Omit to pick video, then website, then photos. With `greenscreen` B-roll on another template: `website` makes a cutaway of the site scroll instead of the automated demo it is by default.","type":"string","enum":["video","website","automated_demo","photos"],"uniqueKey":"phone_screen","typeLabel":"enum\u003cstring>"},"device_clip":{"description":"`phone_mockup` only: the device clip (a phone, tablet, laptop or monitor with a green screen), by slug. It must be one filmed in the video's `format`. Omit to have one picked that suits what is on screen.","type":"string","enum":["hand-phone","phone-shop-floor","phone-scrolling","phone-in-car","phone-sideways-sofa","phone-cafe","tablet-wood-desk","tablet-marble-desk","tablet-coffee-break","tablet-flat-lay","laptop-typing","laptop-alarm-clock","laptop-sideboard","monitor-home-office","phone-hand-city","phone-hand-grey","phone-two-hands","phone-blue-wall","laptop-living-room","phone-hand-city-wide","phone-hand-grey-wide","phone-sideways-two-hands","phone-sideways-close","laptop-window-desk","laptop-couch-typing","laptop-navy-room","laptop-woman-desk","laptop-white-desk","laptop-close-up","phone-sideways-backdrop","phone-backdrop"],"uniqueKey":"device_clip","typeLabel":"enum\u003cstring>"},"device_background":{"description":"`phone_mockup` with a `device_clip` filmed against a green backdrop (a `-backdrop` slug): the built-in photo behind the device. Omit for the default.","type":"string","enum":["modern-office","classical-hall","library","city-skyline","city-street","mountains","park","beach","cafe","loft"],"uniqueKey":"device_background","typeLabel":"enum\u003cstring>"},"demo_focus":{"description":"Site demos: the features to show, in your words","type":"string","maxLength":1000,"uniqueKey":"demo_focus","typeLabel":"string"},"demo_login":{"description":"Site demos: sign in first to show the product behind the login","type":"object","properties":{"email":{"type":"string","minLength":1,"maxLength":320,"isRequired":true,"uniqueKey":"demo_login.email","typeLabel":"string"},"password":{"type":"string","minLength":1,"maxLength":500,"description":"Stored encrypted; never returned","isRequired":true,"uniqueKey":"demo_login.password","typeLabel":"string"},"login_url":{"description":"The sign-in page, if not the site's own","type":"string","maxLength":2000,"format":"uri","uniqueKey":"demo_login.login_url","typeLabel":"string\u003curi>"}},"required":["email","password"],"additionalProperties":false,"uniqueKey":"demo_login","typeLabel":"object"},"max_price_cents":{"description":"A spending cap. With your own `script` the price is known now, and a video above the cap is rejected with 400 before anything is created. Otherwise the written script is priced when it is approved automatically; above the cap it is not approved and waits in `script_review` with the reason in `error`. With `script_review: manual`, pass the cap to the approve call instead.","type":"integer","minimum":0,"maximum":9007199254740991,"uniqueKey":"max_price_cents","typeLabel":"integer"},"caption":{"description":"The post caption. Omit to use the one written with the script.","type":"string","maxLength":4000,"uniqueKey":"caption","typeLabel":"string"},"hashtags":{"description":"Hashtags for the post, with or without `#`","maxItems":30,"type":"array","items":{"type":"string","maxLength":101,"uniqueKey":"hashtags.items.[INDEX]","typeLabel":"string"},"uniqueKey":"hashtags","typeLabel":"string[]"},"music":{"description":"Background music mixed under the finished video: any track `GET /v1/videos/music` lists, from the built-in library, Epidemic Sound, your AI-generated tracks or commercial music. A track that cannot be used is a 400 before the video is made. A `talking_avatar` video sent without it gets a random royalty-free track. There is no level to set: the music plays at full volume wherever nobody speaks and comes down to about 30% under speech. Change it later with `PUT /v1/videos/{id}/music`.","type":"object","properties":{"library":{"default":"lumisreach","description":"Where the track is from, as `GET /v1/videos/music` lists it: `lumisreach` (the built-in royalty-free library), `epidemic` (Epidemic Sound's catalog), `generated` (a track your workspace made with `POST /v1/videos/music/generated`, once `ready`) or `commercial` (popular songs from TikTok's charts; needs your workspace's confirmation, in the dashboard, that it holds the rights).","type":"string","enum":["lumisreach","epidemic","generated","commercial"],"isRequired":true,"uniqueKey":"music.library","typeLabel":"enum\u003cstring>"},"track_id":{"type":"string","minLength":1,"maxLength":100,"description":"The track's `track_id` from `GET /v1/videos/music`","isRequired":true,"uniqueKey":"music.track_id","typeLabel":"string"},"accept_price_cents":{"description":"A premium Epidemic Sound track's `price_cents`, as the listing showed it: sending it agrees to the charge, made once per video. Needed for a premium track only; every other track is free to use.","type":"integer","minimum":1,"maximum":100000,"uniqueKey":"music.accept_price_cents","typeLabel":"integer"},"smart":{"description":"Smart Music: play the track only under the stretches where the story gets interesting, tapering off after each, instead of from start to finish. Default `false`.","type":"boolean","uniqueKey":"music.smart","typeLabel":"boolean"}},"required":["library","track_id"],"additionalProperties":false,"uniqueKey":"music","typeLabel":"object"}},"required":["template","format","target_duration_seconds","avatar_layout","background_mode","script_review"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"template":"talking_avatar","format":"vertical","target_duration_seconds":30,"avatar_layout":"center","background_mode":"static","script_review":"auto","preset":"\u003cstring>","title":"\u003cstring>","brief":"\u003cstring>","source_url":"\u003cstring>","source_text":"\u003cstring>","source_image_urls":["\u003cstring>"],"source_video_urls":["\u003cstring>"],"source_image_kinds":[],"source_video_kinds":[],"script":"\u003cstring>","avatar_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","replica_id":"\u003cstring>","voice_id":"\u003cstring>","voice_model":"\u003cstring>","interview_cast":[{"replica_id":"\u003cstring>","avatar_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}],"b_roll":true,"b_roll_sources":[],"b_roll_images":[4503599627370495],"b_roll_opening":true,"b_roll_layouts":[],"b_roll_end_scene":true,"b_roll_end_scene_text":"\u003cstring>","b_roll_end_scene_voice_id":"\u003cstring>","videographer_sources":[],"videographer_actions":50,"presenter_narrates":true,"narration":50,"subtitle_emojis":true,"video_model":"\u003cstring>","slide_count":6,"image_model":"\u003cstring>","on_screen_caption":"\u003cstring>","footage_narrated":true,"meme_clip_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","demo_focus":"\u003cstring>","max_price_cents":4503599627370495,"caption":"\u003cstring>","hashtags":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"c3c72b58-5ca5-4995-8310-00298d894321":{"description":"Success","content":{"application/json":{"schema":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","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)$","isRequired":true,"uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"title":{"type":"string","isRequired":true,"uniqueKey":"data.title","typeLabel":"string"},"status":{"type":"string","enum":["unsubmitted","queued","researching","script_review","rendering","compositing","ready","failed"],"description":"`queued` → `researching` → `script_review` (waiting for approval) → `rendering` → `compositing` → `ready`, or `failed`. `unsubmitted` is a draft saved in the dashboard.","isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"template":{"type":"string","enum":["ai_videographer","talking_avatar","remotion","site_demo","freeform_ai","meme_hook","interview","phone_mockup","slideshow","real_footage","video_edit"],"isRequired":true,"uniqueKey":"data.template","typeLabel":"enum\u003cstring>"},"preset":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.preset.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.preset.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.preset","typeLabel":"string | null"},"format":{"type":"string","enum":["vertical","horizontal"],"isRequired":true,"uniqueKey":"data.format","typeLabel":"enum\u003cstring>"},"duration_seconds":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"data.duration_seconds.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"data.duration_seconds.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.duration_seconds","typeLabel":"number | null"},"video_url":{"oneOf":[{"type":"string","description":"The finished MP4, once `ready`. A signed link that needs no API key, safe to hand to other services.","format":"uri","isRequired":true,"uniqueKey":"data.video_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","description":"The finished MP4, once `ready`. A signed link that needs no API key, safe to hand to other services.","isRequired":true,"uniqueKey":"data.video_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.video_url","typeLabel":"string\u003curi> | null"},"thumbnail_url":{"oneOf":[{"type":"string","format":"uri","isRequired":true,"uniqueKey":"data.thumbnail_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","isRequired":true,"uniqueKey":"data.thumbnail_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.thumbnail_url","typeLabel":"string\u003curi> | null"},"billed_cents":{"oneOf":[{"type":"integer","description":"What the video was charged, once, when it was released to render. Null until then.","maximum":9007199254740991,"minimum":-9007199254740991,"isRequired":true,"uniqueKey":"data.billed_cents.oneOf.0","typeLabel":"integer"},{"type":"null","description":"What the video was charged, once, when it was released to render. Null until then.","isRequired":true,"uniqueKey":"data.billed_cents.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.billed_cents","typeLabel":"integer | null"},"error":{"oneOf":[{"description":"Why it failed, or (in `script_review`) why an automatic approval was held back","type":"string","isRequired":true,"uniqueKey":"data.error.oneOf.0","typeLabel":"string"},{"description":"Why it failed, or (in `script_review`) why an automatic approval was held back","type":"null","isRequired":true,"uniqueKey":"data.error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.error","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","isRequired":true,"uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","isRequired":true,"uniqueKey":"data.updated_at","typeLabel":"string\u003cdate-time>"},"posts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","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)$","isRequired":true,"uniqueKey":"data.posts.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"provider":{"type":"string","enum":["tiktok","instagram","facebook","x","linkedin","youtube"],"isRequired":true,"uniqueKey":"data.posts.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["scheduled","pending","publishing","published","failed","canceled","deleted"],"isRequired":true,"uniqueKey":"data.posts.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"media_type":{"type":"string","enum":["video","carousel","image","text"],"isRequired":true,"uniqueKey":"data.posts.items.[INDEX].media_type","typeLabel":"enum\u003cstring>"},"permalink":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.posts.items.[INDEX].permalink.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.posts.items.[INDEX].permalink.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.posts.items.[INDEX].permalink","typeLabel":"string | null"},"scheduled_for":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","isRequired":true,"uniqueKey":"data.posts.items.[INDEX].scheduled_for.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"data.posts.items.[INDEX].scheduled_for.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.posts.items.[INDEX].scheduled_for","typeLabel":"string\u003cdate-time> | null"},"published_at":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","isRequired":true,"uniqueKey":"data.posts.items.[INDEX].published_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"data.posts.items.[INDEX].published_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.posts.items.[INDEX].published_at","typeLabel":"string\u003cdate-time> | null"},"error":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.posts.items.[INDEX].error.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.posts.items.[INDEX].error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.posts.items.[INDEX].error","typeLabel":"string | null"}},"required":["id","provider","status","media_type","permalink","scheduled_for","published_at","error"],"additionalProperties":false,"uniqueKey":"data.posts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.posts","typeLabel":"object[]"},"price_cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"What the video costs: the amount charged once released, otherwise the quote for the script (or, before it is written, the estimate).","isRequired":true,"uniqueKey":"data.price_cents","typeLabel":"integer"},"price_estimated":{"type":"boolean","description":"True while the price is an estimate from the length asked for","isRequired":true,"uniqueKey":"data.price_estimated","typeLabel":"boolean"},"script_approved":{"type":"boolean","isRequired":true,"uniqueKey":"data.script_approved","typeLabel":"boolean"},"user_script":{"type":"boolean","description":"True when you supplied the script","isRequired":true,"uniqueKey":"data.user_script","typeLabel":"boolean"},"script":{"oneOf":[{"description":"The spoken words, once written","type":"string","isRequired":true,"uniqueKey":"data.script.oneOf.0","typeLabel":"string"},{"description":"The spoken words, once written","type":"null","isRequired":true,"uniqueKey":"data.script.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.script","typeLabel":"string | null"},"script_sections":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","isRequired":true,"uniqueKey":"data.script_sections.oneOf.0.items.[INDEX].label","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"data.script_sections.oneOf.0.items.[INDEX].text","typeLabel":"string"}},"required":["label","text"],"additionalProperties":false,"uniqueKey":"data.script_sections.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"A scrolling background's script, one part per section","isRequired":true,"uniqueKey":"data.script_sections.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"A scrolling background's script, one part per section","isRequired":true,"uniqueKey":"data.script_sections.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.script_sections","typeLabel":"object[] | null"},"scenes":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.scenes.oneOf.0.items.[INDEX].id","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"data.scenes.oneOf.0.items.[INDEX].label","typeLabel":"string"},"duration_seconds":{"type":"number","isRequired":true,"uniqueKey":"data.scenes.oneOf.0.items.[INDEX].duration_seconds","typeLabel":"number"},"voiceover":{"type":"string","isRequired":true,"uniqueKey":"data.scenes.oneOf.0.items.[INDEX].voiceover","typeLabel":"string"},"caption":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.scenes.oneOf.0.items.[INDEX].caption.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.scenes.oneOf.0.items.[INDEX].caption.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.scenes.oneOf.0.items.[INDEX].caption","typeLabel":"string | null"},"prompt":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.scenes.oneOf.0.items.[INDEX].prompt.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.scenes.oneOf.0.items.[INDEX].prompt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.scenes.oneOf.0.items.[INDEX].prompt","typeLabel":"string | null"}},"required":["id","label","duration_seconds","voiceover","caption","prompt"],"additionalProperties":false,"uniqueKey":"data.scenes.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"A scene template's shot list, once planned","isRequired":true,"uniqueKey":"data.scenes.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"A scene template's shot list, once planned","isRequired":true,"uniqueKey":"data.scenes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.scenes","typeLabel":"object[] | null"},"slides":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.slides.oneOf.0.items.[INDEX].id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"data.slides.oneOf.0.items.[INDEX].role","typeLabel":"string"},"headline":{"type":"string","isRequired":true,"uniqueKey":"data.slides.oneOf.0.items.[INDEX].headline","typeLabel":"string"},"body":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.slides.oneOf.0.items.[INDEX].body.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.slides.oneOf.0.items.[INDEX].body.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.slides.oneOf.0.items.[INDEX].body","typeLabel":"string | null"},"position":{"type":"string","isRequired":true,"uniqueKey":"data.slides.oneOf.0.items.[INDEX].position","typeLabel":"string"},"prompt":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.slides.oneOf.0.items.[INDEX].prompt.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.slides.oneOf.0.items.[INDEX].prompt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.slides.oneOf.0.items.[INDEX].prompt","typeLabel":"string | null"},"image_url":{"oneOf":[{"type":"string","format":"uri","isRequired":true,"uniqueKey":"data.slides.oneOf.0.items.[INDEX].image_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","isRequired":true,"uniqueKey":"data.slides.oneOf.0.items.[INDEX].image_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.slides.oneOf.0.items.[INDEX].image_url","typeLabel":"string\u003curi> | null"}},"required":["id","role","headline","body","position","prompt","image_url"],"additionalProperties":false,"uniqueKey":"data.slides.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"A slideshow's slides, once planned; `image_url` once rendered","isRequired":true,"uniqueKey":"data.slides.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"A slideshow's slides, once planned; `image_url` once rendered","isRequired":true,"uniqueKey":"data.slides.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.slides","typeLabel":"object[] | null"},"interview":{"oneOf":[{"type":"object","required":["speakers","turns"],"properties":{"speakers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.interview.oneOf.0.speakers.items.[INDEX].id","typeLabel":"string"},"role":{"type":"string","isRequired":true,"uniqueKey":"data.interview.oneOf.0.speakers.items.[INDEX].role","typeLabel":"string"},"face_name":{"type":"string","isRequired":true,"uniqueKey":"data.interview.oneOf.0.speakers.items.[INDEX].face_name","typeLabel":"string"}},"required":["id","role","face_name"],"additionalProperties":false,"uniqueKey":"data.interview.oneOf.0.speakers.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.interview.oneOf.0.speakers","typeLabel":"object[]"},"turns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.interview.oneOf.0.turns.items.[INDEX].id","typeLabel":"string"},"speaker_id":{"type":"string","isRequired":true,"uniqueKey":"data.interview.oneOf.0.turns.items.[INDEX].speaker_id","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"data.interview.oneOf.0.turns.items.[INDEX].text","typeLabel":"string"}},"required":["id","speaker_id","text"],"additionalProperties":false,"uniqueKey":"data.interview.oneOf.0.turns.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.interview.oneOf.0.turns","typeLabel":"object[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.interview.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"data.interview.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.interview","typeLabel":"object | null"},"caption":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.caption.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.caption.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.caption","typeLabel":"string | null"},"hashtags":{"type":"array","items":{"type":"string","uniqueKey":"data.hashtags.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.hashtags","typeLabel":"string[]"},"post_caption":{"oneOf":[{"description":"The caption with its hashtags, as it is posted by default","type":"string","isRequired":true,"uniqueKey":"data.post_caption.oneOf.0","typeLabel":"string"},{"description":"The caption with its hashtags, as it is posted by default","type":"null","isRequired":true,"uniqueKey":"data.post_caption.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.post_caption","typeLabel":"string | null"},"music":{"oneOf":[{"type":"object","required":["library","track_id","title","status"],"properties":{"library":{"type":"string","enum":["lumisreach","epidemic","generated","commercial"],"description":"`generated`: a track an AI model made for your organization in the dashboard. `commercial`: a song from TikTok's charts, used once your organization confirmed it holds the rights in the dashboard","isRequired":true,"uniqueKey":"data.music.oneOf.0.library","typeLabel":"enum\u003cstring>"},"track_id":{"type":"string","isRequired":true,"uniqueKey":"data.music.oneOf.0.track_id","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"data.music.oneOf.0.title","typeLabel":"string"},"status":{"type":"string","enum":["pending","mixing","applied","failed"],"isRequired":true,"uniqueKey":"data.music.oneOf.0.status","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.music.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"data.music.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.music","typeLabel":"object | null"},"brief":{"oneOf":[{"description":"What the video was asked to be, when a `brief` was given","type":"string","isRequired":true,"uniqueKey":"data.brief.oneOf.0","typeLabel":"string"},{"description":"What the video was asked to be, when a `brief` was given","type":"null","isRequired":true,"uniqueKey":"data.brief.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.brief","typeLabel":"string | null"},"language":{"type":"string","description":"The language it is made in, as a code (`en`, `fr`, ...)","isRequired":true,"uniqueKey":"data.language","typeLabel":"string"},"source_url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.source_url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.source_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.source_url","typeLabel":"string | null"},"target_duration_seconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"data.target_duration_seconds","typeLabel":"integer"},"avatar_provider":{"type":"string","enum":["heygen","tavus","elevenlabs"],"isRequired":true,"uniqueKey":"data.avatar_provider","typeLabel":"enum\u003cstring>"},"avatar_layout":{"type":"string","enum":["center","bubble_bottom_left","bubble_bottom_right","audio_only"],"isRequired":true,"uniqueKey":"data.avatar_layout","typeLabel":"enum\u003cstring>"},"background_mode":{"type":"string","enum":["static","scrolling","footage","automated_demo","original","image"],"isRequired":true,"uniqueKey":"data.background_mode","typeLabel":"enum\u003cstring>"},"subtitle_style":{"type":"string","enum":["none","classic","boxed","bold_words","dynamic","dynamic_highlight","emphasis","enlarge","one_word","comic","highlight"],"isRequired":true,"uniqueKey":"data.subtitle_style","typeLabel":"enum\u003cstring>"},"subtitle_emojis":{"type":"boolean","isRequired":true,"uniqueKey":"data.subtitle_emojis","typeLabel":"boolean"},"video_model":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.video_model.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.video_model.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.video_model","typeLabel":"string | null"},"videographer":{"oneOf":[{"type":"object","description":"An `ai_videographer` video's settings; null on every other template","required":["sources","model","actions","presenter_narrates"],"properties":{"sources":{"type":"array","items":{"type":"string","enum":["any","motion_graphics","stock","ai","talking_avatar","uploaded","image","youtube","online_image"],"uniqueKey":"data.videographer.oneOf.0.sources.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"data.videographer.oneOf.0.sources","typeLabel":"enum\u003cstring>[]"},"model":{"type":"string","isRequired":true,"uniqueKey":"data.videographer.oneOf.0.model","typeLabel":"string"},"actions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"data.videographer.oneOf.0.actions","typeLabel":"integer"},"presenter_narrates":{"type":"boolean","isRequired":true,"uniqueKey":"data.videographer.oneOf.0.presenter_narrates","typeLabel":"boolean"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.videographer.oneOf.0","typeLabel":"object"},{"type":"null","description":"An `ai_videographer` video's settings; null on every other template","isRequired":true,"uniqueKey":"data.videographer.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.videographer","typeLabel":"object | null"},"narration":{"oneOf":[{"type":"integer","description":"How much of it a narrator speaks over, 0 to 100, on the templates that have the setting","maximum":9007199254740991,"minimum":-9007199254740991,"isRequired":true,"uniqueKey":"data.narration.oneOf.0","typeLabel":"integer"},{"type":"null","description":"How much of it a narrator speaks over, 0 to 100, on the templates that have the setting","isRequired":true,"uniqueKey":"data.narration.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.narration","typeLabel":"integer | null"},"post_format":{"oneOf":[{"type":"string","description":"A `slideshow` post's format; null on a video","enum":["text","image","carousel"],"isRequired":true,"uniqueKey":"data.post_format.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"A `slideshow` post's format; null on a video","isRequired":true,"uniqueKey":"data.post_format.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.post_format","typeLabel":"enum\u003cstring> | null"},"post_orientation":{"oneOf":[{"type":"string","description":"The shape of a post's pictures; null on a video and on a text post","enum":["square","vertical","horizontal"],"isRequired":true,"uniqueKey":"data.post_orientation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The shape of a post's pictures; null on a video and on a text post","isRequired":true,"uniqueKey":"data.post_orientation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.post_orientation","typeLabel":"enum\u003cstring> | null"},"dashboard_url":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"data.dashboard_url","typeLabel":"string\u003curi>"}},"required":["id","title","status","template","preset","format","duration_seconds","video_url","thumbnail_url","billed_cents","error","created_at","updated_at","posts","price_cents","price_estimated","script_approved","user_script","script","script_sections","scenes","slides","interview","caption","hashtags","post_caption","music","brief","language","source_url","target_duration_seconds","avatar_provider","avatar_layout","background_mode","subtitle_style","subtitle_emojis","video_model","videographer","narration","post_format","post_orientation","dashboard_url"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","title":"\u003cstring>","status":"unsubmitted","template":"ai_videographer","preset":"\u003cstring>","format":"vertical","duration_seconds":123,"video_url":"\u003cstring>","thumbnail_url":"\u003cstring>","billed_cents":0,"error":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","posts":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","provider":"tiktok","status":"scheduled","media_type":"video","permalink":"\u003cstring>","scheduled_for":"2023-11-07T05:31:56Z","published_at":"2023-11-07T05:31:56Z","error":"\u003cstring>"}],"price_cents":0,"price_estimated":true,"script_approved":true,"user_script":true,"script":"\u003cstring>","script_sections":[{"label":"\u003cstring>","text":"\u003cstring>"}],"scenes":[{"id":"\u003cstring>","label":"\u003cstring>","duration_seconds":123,"voiceover":"\u003cstring>","caption":"\u003cstring>","prompt":"\u003cstring>"}],"slides":[{"id":"\u003cstring>","role":"\u003cstring>","headline":"\u003cstring>","body":"\u003cstring>","position":"\u003cstring>","prompt":"\u003cstring>","image_url":"\u003cstring>"}],"interview":{"speakers":[{"id":"\u003cstring>","role":"\u003cstring>","face_name":"\u003cstring>"}],"turns":[{"id":"\u003cstring>","speaker_id":"\u003cstring>","text":"\u003cstring>"}]},"caption":"\u003cstring>","hashtags":["\u003cstring>"],"post_caption":"\u003cstring>","music":{"library":"lumisreach","track_id":"\u003cstring>","title":"\u003cstring>","status":"pending"},"brief":"\u003cstring>","language":"\u003cstring>","source_url":"\u003cstring>","target_duration_seconds":0,"avatar_provider":"heygen","avatar_layout":"center","background_mode":"static","subtitle_style":"none","subtitle_emojis":true,"video_model":"\u003cstring>","videographer":{"sources":["any"],"model":"\u003cstring>","actions":0,"presenter_narrates":true},"narration":0,"post_format":"text","post_orientation":"square","dashboard_url":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"77e73a97-a542-445d-89c0-816d8afc3dcd":{"description":"Validation error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.fields.additionalProperties","typeLabel":"string"},"uniqueKey":"error.fields","typeLabel":"object"},"doc_url":{"type":"string","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","fields":{},"doc_url":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"69f0757c-8a7d-49f1-8ecb-3ce8db5aeae8":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.fields.additionalProperties","typeLabel":"string"},"uniqueKey":"error.fields","typeLabel":"object"},"doc_url":{"type":"string","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","fields":{},"doc_url":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"44a412af-2f88-4a74-a443-836949e1f621":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.fields.additionalProperties","typeLabel":"string"},"uniqueKey":"error.fields","typeLabel":"object"},"doc_url":{"type":"string","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","fields":{},"doc_url":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"4cf31ab1-4bb9-4430-9347-e8d5f369fe13":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.fields.additionalProperties","typeLabel":"string"},"uniqueKey":"error.fields","typeLabel":"object"},"doc_url":{"type":"string","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","fields":{},"doc_url":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"37661d52-3dbf-444f-ac88-9b9581480886":{"description":"Conflict (incl. idempotency conflicts)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.fields.additionalProperties","typeLabel":"string"},"uniqueKey":"error.fields","typeLabel":"object"},"doc_url":{"type":"string","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","fields":{},"doc_url":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"ade3de8a-4b13-45f3-99e9-e2d9efba0deb":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.fields.additionalProperties","typeLabel":"string"},"uniqueKey":"error.fields","typeLabel":"object"},"doc_url":{"type":"string","format":"uri","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","fields":{},"doc_url":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"8b50598a-9f4d-48cc-8e28-e0b25e0d4033":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"7a2be0e8-c1bb-4813-9f77-551d2a6398e6":{"url":"https://api.lumisreach.com/api"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"lumis-labs","siteName":"LumisReach","title":"Create a video - LumisReach","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-21T00:05:41.090Z","originalFileLocation":"api-reference/videos/create-a-video.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Make a video with every setting the dashboard\u0026#x27;s Configure step has: the template and style, format, length, sources, presenter, background, captions and more. Send script to have it spoken word for word (templates that read a script only): the video skips script review and is charged now. Without one, a script is written from your sources first, then approved automatically as soon as it is written (script_review: auto, the default) or left in script_review for POST /v1/videos/{id}/approve (manual). The video is charged once, when it is released to render, at the price POST /v1/videos/quote gives; set max_price_cents to cap it. Included video credits are used first, then the prepaid balance. On the API \u0026amp; MCP plan and the Growth Marketing Manager hire a video is charged at cost plus 20%; on Revenue Engine and Custom it is free; other plans get 403 plan_not_included. Poll GET /v1/videos/{id} until status is ready, then download video_url or post it with POST /v1/videos/{id}/posts.\">\u003cmeta data-mint-head name=\"application-name\" content=\"LumisReach\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lumis-labs/UN69hXfwmW9E7Cph/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/lumis-labs/UN69hXfwmW9E7Cph/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lumis-labs/UN69hXfwmW9E7Cph/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/lumis-labs/UN69hXfwmW9E7Cph/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/lumis-labs/UN69hXfwmW9E7Cph/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lumis-labs/UN69hXfwmW9E7Cph/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lumis-labs/UN69hXfwmW9E7Cph/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/lumis-labs/UN69hXfwmW9E7Cph/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/lumis-labs/UN69hXfwmW9E7Cph/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a video - LumisReach\">\u003cmeta data-mint-head property=\"og:description\" content=\"Make a video with every setting the dashboard\u0026#x27;s Configure step has: the template and style, format, length, sources, presenter, background, captions and more. Send script to have it spoken word for word (templates that read a script only): the video skips script review and is charged now. Without one, a script is written from your sources first, then approved automatically as soon as it is written (script_review: auto, the default) or left in script_review for POST /v1/videos/{id}/approve (manual). The video is charged once, when it is released to render, at the price POST /v1/videos/quote gives; set max_price_cents to cap it. Included video credits are used first, then the prepaid balance. On the API \u0026amp; MCP plan and the Growth Marketing Manager hire a video is charged at cost plus 20%; on Revenue Engine and Custom it is free; other plans get 403 plan_not_included. Poll GET /v1/videos/{id} until status is ready, then download video_url or post it with POST /v1/videos/{id}/posts.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"LumisReach\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.lumisreach.com/api-reference/videos/create-a-video\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lumis-labs.mintlify.site/_mintlify/api/og/v2?division=Videos\u0026amp;title=Create+a+video\u0026amp;description=Make+a+video+with+every+setting+the+dashboard%27s+Configure+step+has%3A+the+template+and+style%2C+format%2C+length%2C+sources%2C+presenter%2C+background%2C+captions+and+more.+S\u0026amp;theme=665b67b381179b4f7360cf64\u0026amp;signature=43c009261c3768875552c451fea41667c83e48494fda523078332192b04299e5\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a video - LumisReach\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Make a video with every setting the dashboard\u0026#x27;s Configure step has: the template and style, format, length, sources, presenter, background, captions and more. Send script to have it spoken word for word (templates that read a script only): the video skips script review and is charged now. Without one, a script is written from your sources first, then approved automatically as soon as it is written (script_review: auto, the default) or left in script_review for POST /v1/videos/{id}/approve (manual). The video is charged once, when it is released to render, at the price POST /v1/videos/quote gives; set max_price_cents to cap it. Included video credits are used first, then the prepaid balance. On the API \u0026amp; MCP plan and the Growth Marketing Manager hire a video is charged at cost plus 20%; on Revenue Engine and Custom it is free; other plans get 403 plan_not_included. Poll GET /v1/videos/{id} until status is ready, then download video_url or post it with POST /v1/videos/{id}/posts.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lumis-labs.mintlify.site/_mintlify/api/og/v2?division=Videos\u0026amp;title=Create+a+video\u0026amp;description=Make+a+video+with+every+setting+the+dashboard%27s+Configure+step+has%3A+the+template+and+style%2C+format%2C+length%2C+sources%2C+presenter%2C+background%2C+captions+and+more.+S\u0026amp;theme=665b67b381179b4f7360cf64\u0026amp;signature=43c009261c3768875552c451fea41667c83e48494fda523078332192b04299e5\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/lumis-labs/UN69hXfwmW9E7Cph/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"LumisReach\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#111827\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.lumisreach.com/api-reference/videos/create-a-video\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/videos/create-a-video.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.lumisreach.com/#organization\",\"name\":\"LumisReach\",\"url\":\"https://docs.lumisreach.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.lumisreach.com#website\",\"name\":\"LumisReach\",\"url\":\"https://docs.lumisreach.com\",\"publisher\":{\"@id\":\"https://docs.lumisreach.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.lumisreach.com/api-reference/videos/create-a-video#webpage\",\"url\":\"https://docs.lumisreach.com/api-reference/videos/create-a-video\",\"name\":\"Create a video\",\"description\":\"Make a video with every setting the dashboard's Configure step has: the template and style, format, length, sources, presenter, background, captions and more. Send script to have it spoken word for word (templates that read a script only): the video skips script review and is charged now. Without one, a script is written from your sources first, then approved automatically as soon as it is written (script_review: auto, the default) or left in script_review for POST /v1/videos/{id}/approve (manual). The video is charged once, when it is released to render, at the price POST /v1/videos/quote gives; set max_price_cents to cap it. Included video credits are used first, then the prepaid balance. On the API \u0026 MCP plan and the Growth Marketing Manager hire a video is charged at cost plus 20%; on Revenue Engine and Custom it is free; other plans get 403 plan_not_included. Poll GET /v1/videos/{id} until status is ready, then download video_url or post it with POST /v1/videos/{id}/posts.\",\"dateModified\":\"2026-11-21T00:05:41.090Z\",\"isPartOf\":{\"@id\":\"https://docs.lumisreach.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.lumisreach.com/api-reference/videos/create-a-video#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.lumisreach.com/api-reference/videos/create-a-video#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Videos\",\"item\":\"https://docs.lumisreach.com/api-reference/videos\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a video\",\"item\":\"https://docs.lumisreach.com/api-reference/videos/create-a-video\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.lumisreach.com/api-reference/videos/create-a-video#apireference\",\"headline\":\"Create a video\",\"name\":\"Create a video\",\"description\":\"Make a video with every setting the dashboard's Configure step has: the template and style, format, length, sources, presenter, background, captions and more. Send script to have it spoken word for word (templates that read a script only): the video skips script review and is charged now. Without one, a script is written from your sources first, then approved automatically as soon as it is written (script_review: auto, the default) or left in script_review for POST /v1/videos/{id}/approve (manual). The video is charged once, when it is released to render, at the price POST /v1/videos/quote gives; set max_price_cents to cap it. Included video credits are used first, then the prepaid balance. On the API \u0026 MCP plan and the Growth Marketing Manager hire a video is charged at cost plus 20%; on Revenue Engine and Custom it is free; other plans get 403 plan_not_included. Poll GET /v1/videos/{id} until status is ready, then download video_url or post it with POST /v1/videos/{id}/posts.\",\"url\":\"https://docs.lumisreach.com/api-reference/videos/create-a-video\",\"mainEntityOfPage\":{\"@id\":\"https://docs.lumisreach.com/api-reference/videos/create-a-video#webpage\"},\"dateModified\":\"2026-11-21T00:05:41.090Z\",\"publisher\":{\"@id\":\"https://docs.lumisreach.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.lumisreach.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"LumisReach\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"LumisReach\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/videos/create-a-video.md","siteName":"LumisReach","nav":{"global":null,"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":""}]},{"tab":"Solutions","pages":[{"title":"Solutions","href":"/solutions"}]},{"tab":"Policies","pages":[{"title":"Policies","href":"/policies/privacy-policy"}]},{"tab":"Partners","pages":[{"title":"Partners","href":"/partners"}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/api-reference"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Conventions","href":"/api-reference/conventions"},{"title":"MCP server","href":"/api-reference/mcp"}]},{"group":"Concepts","pages":[{"title":"Caller Trust","href":"/concepts/caller-trust"},{"title":"Sub-entities (multi-tenant organizations)","href":"/concepts/sub-entities"},{"title":"HIPAA \u0026 BAA coverage","href":"/concepts/hipaa"},{"title":"Outreach audit \u0026 consent records","sidebarTitle":"Outreach Audit","href":"/concepts/outreach-audit"}]},{"group":"Quick Agent Actions","pages":[{"title":"Quick Agent Actions","href":"/api-reference/quick-agent-actions"},{"title":"Start a Quick AI Phone Call","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/quick/ai-calls","href":"/api-reference/quick-agent-actions/start-a-quick-ai-phone-call"},{"title":"Start a Quick AI Text conversation","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/quick/ai-texts","href":"/api-reference/quick-agent-actions/start-a-quick-ai-text-conversation"},{"title":"Send a single text message","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/quick/texts","href":"/api-reference/quick-agent-actions/send-a-single-text-message"},{"title":"Send a Quick Email","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/quick/emails","href":"/api-reference/quick-agent-actions/send-a-quick-email"},{"title":"Send a Quick iMessage","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/quick/imessages","href":"/api-reference/quick-agent-actions/send-a-quick-imessage"},{"title":"Send a quick chat message","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/quick/chat-messages","href":"/api-reference/quick-agent-actions/send-a-quick-chat-message"},{"title":"List connected chat channels","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/quick/chat-channels","href":"/api-reference/quick-agent-actions/list-connected-chat-channels"},{"title":"Connect a chat channel","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/quick/chat-channels","href":"/api-reference/quick-agent-actions/connect-a-chat-channel"},{"title":"List Quick Agent Action jobs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/quick/actions","href":"/api-reference/quick-agent-actions/list-quick-agent-action-jobs"},{"title":"Get a Quick Agent Action job","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/quick/actions/{id}","href":"/api-reference/quick-agent-actions/get-a-quick-agent-action-job"},{"title":"Cancel a Quick Agent Action job","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/quick/actions/{id}/cancel","href":"/api-reference/quick-agent-actions/cancel-a-quick-agent-action-job"},{"title":"Buy a phone number and set up its AI agent","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/quick/ai-numbers","href":"/api-reference/quick-agent-actions/buy-a-phone-number-and-set-up-its-ai-agent"},{"title":"Get AI phone number status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/quick/ai-numbers/{id}","href":"/api-reference/quick-agent-actions/get-ai-phone-number-status"}]},{"group":"Lincoln AI","pages":[{"title":"Lincoln AI","href":"/api-reference/lincoln"},{"title":"Message Lincoln AI","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/lincoln/messages","href":"/api-reference/lincoln-ai/message-lincoln-ai"},{"title":"List Lincoln AI conversations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/lincoln/conversations","href":"/api-reference/lincoln-ai/list-lincoln-ai-conversations"},{"title":"Get a Lincoln AI conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/lincoln/conversations/{id}","href":"/api-reference/lincoln-ai/get-a-lincoln-ai-conversation"}]},{"group":"Videos","pages":[{"title":"Videos","href":"/api-reference/videos"},{"title":"Quote a video","description":"The price of a video with these settings (the same body as `POST /v1/videos`), without making it. Videos are priced at the cost of the providers that make them (presenter renders, generated shots and pictures, narration, rendering) plus a small markup, and charged once, when released to render; retries are free. With your own `script` the quote is exact. Without one it is an estimate from `target_duration_seconds` (`estimated: true`), and the charge at approval is for what was actually written. Free.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/quote","href":"/api-reference/videos/quote-a-video"},{"title":"Create a video","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos","href":"/api-reference/videos/create-a-video"},{"title":"List videos","description":"The workspace's videos, newest first, including ones made in the dashboard or by a posting schedule. Filter by `status`; page with `meta.cursor`. Free.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos","href":"/api-reference/videos/list-videos"},{"title":"Get a video","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}","href":"/api-reference/videos/get-a-video"},{"title":"Approve a video's script","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/approve","href":"/api-reference/videos/approve-a-videos-script"},{"title":"Edit a finished video","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/edit","href":"/api-reference/videos/edit-a-finished-video"},{"title":"Update a video's caption and hashtags","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/videos/{id}","href":"/api-reference/videos/update-a-videos-caption-and-hashtags"},{"title":"Retry a video","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/retry","href":"/api-reference/videos/retry-a-video"},{"title":"Delete a video","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/videos/{id}","href":"/api-reference/videos/delete-a-video"},{"title":"Search music","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/music","href":"/api-reference/videos/search-music"},{"title":"Get the music catalog","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/music/catalog","href":"/api-reference/videos/get-the-music-catalog"},{"title":"Generate a music track","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/music/generated","href":"/api-reference/videos/generate-a-music-track"},{"title":"Get a generated music track","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/music/generated/{id}","href":"/api-reference/videos/get-a-generated-music-track"},{"title":"Set a video's music","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/videos/{id}/music","href":"/api-reference/videos/set-a-videos-music"},{"title":"Remove a video's music","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/videos/{id}/music","href":"/api-reference/videos/remove-a-videos-music"},{"title":"List social connections","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/social-connections","href":"/api-reference/videos/list-social-connections"},{"title":"Post a video","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/posts","href":"/api-reference/videos/post-a-video"},{"title":"List a video's posts","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/posts","href":"/api-reference/videos/list-a-videos-posts"},{"title":"List scheduled posts","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/posts","href":"/api-reference/videos/list-scheduled-posts"},{"title":"Reschedule a post","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/posts/{id}","href":"/api-reference/videos/reschedule-a-post"},{"title":"Cancel a scheduled post","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/posts/{id}","href":"/api-reference/videos/cancel-a-scheduled-post"}]},{"group":"Optimized posts","pages":[{"title":"Optimized posts","href":"/api-reference/optimized-posts"},{"title":"Create an optimized post","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/optimized-posts","href":"/api-reference/optimized-posts/create-an-optimized-post"},{"title":"Get an optimized post","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/optimized-posts/{id}","href":"/api-reference/optimized-posts/get-an-optimized-post"}]},{"group":"Predictions","pages":[{"title":"Predictions","href":"/api-reference/predictions"},{"title":"Predict performance","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/predictions","href":"/api-reference/predictions/predict-performance"},{"title":"Get a prediction","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/predictions/{id}","href":"/api-reference/predictions/get-a-prediction"},{"title":"List predictions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/predictions","href":"/api-reference/predictions/list-predictions"}]},{"group":"Video Schedules","pages":[{"title":"Video schedules","href":"/api-reference/video-schedules"},{"title":"List video schedules","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/video-schedules","href":"/api-reference/video-schedules/list-video-schedules"},{"title":"Create a video schedule","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/video-schedules","href":"/api-reference/video-schedules/create-a-video-schedule"},{"title":"Get a video schedule","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/video-schedules/{id}","href":"/api-reference/video-schedules/get-a-video-schedule"},{"title":"Update a video schedule","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/video-schedules/{id}","href":"/api-reference/video-schedules/update-a-video-schedule"},{"title":"Delete a video schedule","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/video-schedules/{id}","href":"/api-reference/video-schedules/delete-a-video-schedule"},{"title":"Skip the next run","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/video-schedules/{id}/skip","href":"/api-reference/video-schedules/skip-the-next-run"},{"title":"List a schedule's videos","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/video-schedules/{id}/videos","href":"/api-reference/video-schedules/list-a-schedules-videos"}]},{"group":"Calls, Texts and Contacts","pages":[{"title":"Calls, texts and contacts","href":"/api-reference/conversations"},{"title":"List calls","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/calls","href":"/api-reference/calls/list-calls"},{"title":"Get a call","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/calls/{id}","href":"/api-reference/calls/get-a-call"},{"title":"Download a call recording","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/calls/{id}/recording","href":"/api-reference/calls/download-a-call-recording"},{"title":"Place an outbound call from one of your numbers to a destination","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/calls/dial","href":"/api-reference/calls/place-an-outbound-call-from-one-of-your-numbers-to-a-destination"},{"title":"List text messages","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/messages","href":"/api-reference/messages/list-text-messages"},{"title":"List emails with a person","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/emails","href":"/api-reference/emails/list-emails-with-a-person"},{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/contacts/{id}","href":"/api-reference/contacts/get-a-contact"}]},{"group":"Account","pages":[{"title":"Current authenticated principal","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/me","href":"/api-reference/account/current-authenticated-principal"},{"title":"Current account snapshot","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/account","href":"/api-reference/account/current-account-snapshot"},{"title":"API status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1","href":"/api-reference/account/api-status"}]},{"group":"Sub-entities","pages":[{"title":"List sub-entities under the caller's umbrella organization","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sub-entities","href":"/api-reference/sub-entities/list-sub-entities-under-the-callers-umbrella-organization"},{"title":"Create a sub-entity under the caller's umbrella organization","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sub-entities","href":"/api-reference/sub-entities/create-a-sub-entity-under-the-callers-umbrella-organization"},{"title":"Retrieve a sub-entity","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sub-entities/{id}","href":"/api-reference/sub-entities/retrieve-a-sub-entity"},{"title":"Update a sub-entity","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/sub-entities/{id}","href":"/api-reference/sub-entities/update-a-sub-entity"}]},{"group":"Billing","pages":[{"title":"Billing summary","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/billing","href":"/api-reference/billing/billing-summary"},{"title":"Usage and charges by category","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/billing/usage","href":"/api-reference/billing/usage-and-charges-by-category"},{"title":"List billing events","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/billing/events","href":"/api-reference/billing/list-billing-events"}]},{"group":"Phone Numbers","pages":[{"title":"List owned phone numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/phone-numbers","href":"/api-reference/phone-numbers/list-owned-phone-numbers"},{"title":"Purchase a new phone number","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/phone-numbers","href":"/api-reference/phone-numbers/purchase-a-new-phone-number"},{"title":"Retrieve a phone number","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/phone-numbers/{id}","href":"/api-reference/phone-numbers/retrieve-a-phone-number"},{"title":"Update a phone number's settings","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/phone-numbers/{id}","href":"/api-reference/phone-numbers/update-a-phone-numbers-settings"},{"title":"Release a phone number","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/phone-numbers/{id}","href":"/api-reference/phone-numbers/release-a-phone-number"},{"title":"Check live CNAM status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/phone-numbers/{id}/cnam-status","href":"/api-reference/phone-numbers/check-live-cnam-status"},{"title":"Search available phone numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/phone-numbers/search","href":"/api-reference/phone-numbers/search-available-phone-numbers"}]},{"group":"Number Configuration","pages":[{"title":"Number configuration","href":"/api-reference/number-configuration"},{"title":"Get a number's AI configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/phone-numbers/{id}/config","href":"/api-reference/phone-numbers/get-a-numbers-ai-configuration"},{"title":"Update a number's AI configuration","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/phone-numbers/{id}/config","href":"/api-reference/phone-numbers/update-a-numbers-ai-configuration"},{"title":"List voices for a number","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/phone-numbers/{id}/voices","href":"/api-reference/phone-numbers/list-voices-for-a-number"}]},{"group":"Caller IDs","pages":[{"title":"List caller IDs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voice/caller-ids","href":"/api-reference/caller-ids/list-caller-ids"},{"title":"Start caller ID verification","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/voice/caller-ids","href":"/api-reference/caller-ids/start-caller-id-verification"},{"title":"Update CNAM display name","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/voice/caller-ids/{id}","href":"/api-reference/caller-ids/update-cnam-display-name"},{"title":"Submit verification code","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/voice/caller-ids/{id}/verify","href":"/api-reference/caller-ids/submit-verification-code"}]},{"group":"Enterprise Registration","pages":[{"title":"List enterprise registrations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/caller-trust/enterprises","href":"/api-reference/enterprise-registration/list-enterprise-registrations"},{"title":"Create a new enterprise registration draft","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/caller-trust/enterprises","href":"/api-reference/enterprise-registration/create-a-new-enterprise-registration-draft"},{"title":"Get enterprise by ID","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/caller-trust/enterprises/{id}","href":"/api-reference/enterprise-registration/get-enterprise-by-id"},{"title":"Update a DRAFT enterprise registration","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/caller-trust/enterprises/{id}","href":"/api-reference/enterprise-registration/update-a-draft-enterprise-registration"},{"title":"Delete enterprise by ID","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/caller-trust/enterprises/{id}","href":"/api-reference/enterprise-registration/delete-enterprise-by-id"},{"title":"Sign LOA + submit enterprise to carrier (by ID)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/caller-trust/enterprises/{id}/sign-and-submit","href":"/api-reference/enterprise-registration/sign-loa-+-submit-enterprise-to-carrier-by-id"},{"title":"Submit enterprise to Telnyx (by ID)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/caller-trust/enterprises/{id}/submit","href":"/api-reference/enterprise-registration/submit-enterprise-to-telnyx-by-id"},{"title":"Re-sign LOA for enterprise (by ID)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/caller-trust/enterprises/{id}/resign","href":"/api-reference/enterprise-registration/re-sign-loa-for-enterprise-by-id"},{"title":"Generate LOA PDF for enterprise (by ID)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/caller-trust/enterprises/{id}/generate-loa","href":"/api-reference/enterprise-registration/generate-loa-pdf-for-enterprise-by-id"}]},{"group":"Enterprise Registration (Legacy)","pages":[{"title":"Get the caller's enterprise registration (deprecated)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/caller-trust/enterprise","href":"/api-reference/enterprise-registration/get-the-callers-enterprise-registration-deprecated"},{"title":"Create or update the caller's enterprise registration draft (deprecated)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/caller-trust/enterprise","href":"/api-reference/enterprise-registration/create-or-update-the-callers-enterprise-registration-draft-deprecated"},{"title":"Generate LOA PDF for hand-signing (deprecated)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/caller-trust/enterprise/generate-loa","href":"/api-reference/enterprise-registration/generate-loa-pdf-for-hand-signing-deprecated"},{"title":"Re-sign the LOA for an enterprise (deprecated)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/caller-trust/enterprise/resign","href":"/api-reference/enterprise-registration/re-sign-the-loa-for-an-enterprise-deprecated"},{"title":"Submit enterprise to Telnyx (deprecated)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/caller-trust/enterprise/submit","href":"/api-reference/enterprise-registration/submit-enterprise-to-telnyx-deprecated"},{"title":"Sign LOA + submit enterprise to carrier (deprecated)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/caller-trust/enterprise/sign-and-submit","href":"/api-reference/enterprise-registration/sign-loa-+-submit-enterprise-to-carrier-deprecated"},{"title":"Delete the caller's enterprise registration (deprecated)","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/caller-trust/enterprise","href":"/api-reference/enterprise-registration/delete-the-callers-enterprise-registration-deprecated"}]},{"group":"Branded Calling","tag":"Coming Soon","pages":[{"title":"Branded Calling","href":"/api-reference/branded-calling"},{"title":"Retrieve the caller's Display Identity Record (brand)","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/caller-trust/brand","href":"/api-reference/branded-calling/retrieve-the-callers-display-identity-record-brand"},{"title":"Save (or update) the Display Identity Record draft","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/caller-trust/brand","href":"/api-reference/branded-calling/save-or-update-the-display-identity-record-draft"},{"title":"Submit the brand profile for vetting","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/caller-trust/brand/submit","href":"/api-reference/branded-calling/submit-the-brand-profile-for-vetting"}]},{"group":"Dialer Calls","pages":[{"title":"Place a dialer call","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/voice/calls","href":"/api-reference/dialer-calls/place-a-dialer-call"},{"title":"List dialer calls","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voice/calls","href":"/api-reference/dialer-calls/list-dialer-calls"},{"title":"Get a dialer call","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voice/calls/{id}","href":"/api-reference/dialer-calls/get-a-dialer-call"},{"title":"Hang up a dialer call","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/voice/calls/{id}/hangup","href":"/api-reference/dialer-calls/hang-up-a-dialer-call"}]},{"group":"Call Webhooks","pages":[{"title":"Call webhooks","href":"/api-reference/calls/webhooks"},{"title":"Create a call webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/voice/calls/webhooks","href":"/api-reference/calls/create-a-call-webhook"},{"title":"List call webhooks","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voice/calls/webhooks","href":"/api-reference/calls/list-call-webhooks"},{"title":"Delete a call webhook","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/voice/calls/webhooks/{id}","href":"/api-reference/calls/delete-a-call-webhook"},{"title":"Send a test call event","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/voice/calls/webhooks/{id}/test","href":"/api-reference/calls/send-a-test-call-event"}]},{"group":"Inbound SMS","pages":[{"title":"Inbound SMS webhooks","href":"/api-reference/sms/webhooks"},{"title":"Create an inbound SMS webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sms/webhooks","href":"/api-reference/sms/create-an-inbound-sms-webhook"},{"title":"List inbound SMS webhooks","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sms/webhooks","href":"/api-reference/sms/list-inbound-sms-webhooks"},{"title":"Delete an inbound SMS webhook","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/sms/webhooks/{id}","href":"/api-reference/sms/delete-an-inbound-sms-webhook"},{"title":"Send a test inbound SMS event","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sms/webhooks/{id}/test","href":"/api-reference/sms/send-a-test-inbound-sms-event"},{"title":"Stream inbound texts","openapi":"GET /v1/sms/stream","href":"/api-reference/sms/stream"}]},{"group":"SMS","tag":"Coming Soon","pages":[{"title":"Send an SMS message","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sms/send","href":"/api-reference/sms/send-an-sms-message"}]},{"group":"WebRTC","pages":[{"title":"Get WebRTC connection token","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/voice/webrtc-token","href":"/api-reference/webrtc/get-webrtc-connection-token"}]},{"group":"Documents","pages":[{"title":"Upload a document (e.g. signed LOA)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/caller-trust/documents","href":"/api-reference/documents/upload-a-document-eg-signed-loa"},{"title":"Get document status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/caller-trust/documents/{id}","href":"/api-reference/documents/get-document-status"}]},{"group":"Reputation","pages":[{"title":"Get Number Reputation enrollment settings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/caller-trust/reputation","href":"/api-reference/reputation/get-number-reputation-enrollment-settings"},{"title":"Enable Number Reputation monitoring","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/caller-trust/reputation","href":"/api-reference/reputation/enable-number-reputation-monitoring"},{"title":"Update reputation check frequency","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/caller-trust/reputation","href":"/api-reference/reputation/update-reputation-check-frequency"},{"title":"Disable Number Reputation monitoring","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/caller-trust/reputation","href":"/api-reference/reputation/disable-number-reputation-monitoring"},{"title":"List reputation scores for every enrolled number","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/caller-trust/reputation/numbers","href":"/api-reference/reputation/list-reputation-scores-for-every-enrolled-number"},{"title":"Enroll phone numbers in reputation monitoring","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/caller-trust/reputation/numbers","href":"/api-reference/reputation/enroll-phone-numbers-in-reputation-monitoring"},{"title":"Get reputation scores for a phone number","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/caller-trust/reputation/numbers/{phone}","href":"/api-reference/reputation/get-reputation-scores-for-a-phone-number"},{"title":"Disenroll a phone number from reputation monitoring","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/caller-trust/reputation/numbers/{phone}","href":"/api-reference/reputation/disenroll-a-phone-number-from-reputation-monitoring"}]},{"group":"Usage","pages":[{"title":"Current-month usage rollup","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage","href":"/api-reference/usage/current-month-usage-rollup"},{"title":"Voice usage stats","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voice/usage","href":"/api-reference/usage/voice-usage-stats"},{"title":"Per-phone usage","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voice/usage/{phoneId}","href":"/api-reference/usage/per-phone-usage"}]}]}]},"basePath":"","title":"Create a video - LumisReach","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}