Update Storyboard Elements
Video Storyboard
Update Storyboard Elements
Update existing render elements in a storyboard preview before rendering the final video
PUT
Update Storyboard Elements
Overview
The Update Storyboard Elements API allows you to modify existing render elements generated from the Create Storyboard Preview API. Use this endpoint to update background visuals, scene text, or background music URLs before rendering the final video using the Render from Preview API.This endpoint only updates existing elements in the storyboard. You cannot add new elements, only modify elements that were generated during preview creation. Each element is identified by its unique
id.When to Use This API
Workflow
API Endpoint
Path Parameters
string
required
The job ID returned from the Create Storyboard Preview API. The job must be in
completed status.Request Headers
string
required
API key for authentication
string
required
Must be
application/jsonRequest Body
The request body is a JSON array of element objects. Each object must include the required fields (id, elementType, type, startTime, duration) along with any properties you want to update. Only elements with matching id values in the existing storyboard will be updated.
string
required
The unique identifier of the element to update. Must match an existing element
id from the storyboard preview renderParams.elements array.Examples: backgroundElement_20260306230202544742ecd40c041449..., bgMusic, voiceOver, SceneText_202603062302035443dd4953bf12...string
required
The type category of the element. Must match the existing element’s
elementType.Values:backgroundElement: Scene background image or videoaudioElement: Background music or voice-over audioSceneText: Scene text overlay (displayed on scenes)layerItem: Layer items such as title text, avatars, or overlays
string
required
The media type of the element. Must match or be compatible with the element.Values:
video: Video mediaimage: Image mediaaudio: Audio mediatext: Text content
number
required
The start time of the element in seconds. Must be >= 0.
number
required
The duration of the element in seconds. Must be > 0.
Element Attributes Reference
Any additional properties included in the element update object will be merged with the existing element. Below is a comprehensive reference of all attributes for each element type.Element IDs are auto-generated unique strings (e.g.,
backgroundElement_20260306230202544742ecd40c041449dac21bb737c799201). Always retrieve the actual IDs from the preview job response rather than constructing them manually.Element Types Summary
Background Element (backgroundElement)
The background element is the full-screen visual behind each scene. One background element exists per scene.
Media Properties
Display Properties
Video Playback Properties
Visual Effects
Metadata
Full Background Element Example
Full Background Element Example
Scene Text (SceneText) and Layer Text (layerItem with type: "text")
Text elements display text content on top of scenes. SceneText elements represent the per-sentence text overlay for a scene, while layerItem text elements represent titles, headings, or additional text overlays.
Content Properties
Font & Styling Properties
Text Background Properties
Text Shadow Properties
Layout & Position Properties
Bullet Properties
Animation Properties
Computed Properties (read-only)
Full Scene Text Element Example
Full Scene Text Element Example
Full Title/Layer Text Element Example
Full Title/Layer Text Element Example
Audio Element (audioElement)
Audio elements represent background music (bgMusic) or voice-over narration (voiceOver).
Audio Properties
Segments
Full Background Music Element Example
Full Background Music Element Example
Full Voice-Over Element Example
Full Voice-Over Element Example
Layer Visual Element (layerItem with type: "video" or "image")
Layer visual elements are overlay images or videos displayed on top of the background, such as avatars, logos, or decorative graphics.
Position Presets
Thepreset property defines a named anchor position for text and layer elements within the video frame:
Text Animations
Text elements support entry and exit animations. Theanimation array contains animation configuration objects:
Writing Styles control the granularity of the animation:
Response
204 No Content response indicates the elements were updated successfully. The updated elements will be reflected when you:
- Retrieve the job details using the Get Storyboard Preview Job by ID API
- Render the video using Render from Preview
Code Examples
Update Background Visual
Update Scene Text
Update Background Music
Update Multiple Elements
Important Notes
Only existing elements can be updated
Only existing elements can be updated
You cannot add new elements to the storyboard. Only elements that already exist in the
renderParams.elements array (returned from the storyboard preview job) can be updated. Elements are matched by their unique id.Element IDs come from the preview response
Element IDs come from the preview response
After creating a storyboard preview and polling the job to completion, the response includes
renderParams.elements, an array of all elements with their id values. Element IDs are auto-generated unique strings. Always retrieve the actual IDs from the response rather than constructing them manually.Updates are merged, not replaced
Updates are merged, not replaced
When you update an element, the properties you provide are merged with the existing element properties. Properties you do not include in the update remain unchanged. For example, updating only the
url of a background element will keep its existing loop, mute, objectMode, and other properties.Remove textLines when updating text content
Remove textLines when updating text content
When updating the
text property of a SceneText or layerItem text element, you must set textLines to an empty array []. The textLines array contains pre-calculated line break positions and character coordinates that are specific to the original text. If you change the text but keep the old textLines, the rendering engine will use stale layout data, causing incorrect line breaks and character positioning. Setting textLines to [] ensures the system recalculates the layout during preview and video rendering.Scene text supports HTML highlighting
Scene text supports HTML highlighting
Scene text (
SceneText) elements support <strong> tags for keyword highlighting. For example: "This is <strong>important</strong> text" will render “important” with the element’s keywordColor.Updates persist for rendering
Updates persist for rendering
Once elements are updated, the changes are saved to the storyboard job. When you subsequently render the video using Render from Preview, the updated elements will be used in the final render.
Related APIs
Create Storyboard Preview
Generate a storyboard preview with elements to update
Render from Preview
Render the final video from the updated storyboard
Render Storyboard Video
Render video directly from storyboard input
Get Storyboard Preview Job
Check job status and retrieve render params
