Actions4
Video → Create Video
AI-generatedSummary
Create a video by submitting a detailed prompt along with optional parameters to guide the video generation process. Returns immediately with a video job ID for status tracking.
Inputs
- Prompt (required) — Describe the video to create, using natural language text; image URLs in prompt text are not treated as uploaded assets.
- Website URL — Optional website URL to provide brand, product, or company context for the video.
- Voice Name or ID — Select or specify a voice for narration.
- Style Name or ID — Select or specify a style for the video.
- Aspect Ratio — Choose the video's aspect ratio, e.g., 1:1, 16:9, 9:16, or use API default.
- Duration Name or ID — Specify target video duration in seconds.
- Animation Mode Name or ID — Select an animation mode to influence video motion style.
- Video Format — Choose between standard video or short silent video formats.
- Image URLs — Provide public image URLs as uploaded assets, one per line.
- Scenario Name or ID — Pick a predefined scenario like product launch or explainer video for structured prompts.
- Video Type Profile Name or ID — Optionally select a narrative template like Feature Explainer or Customer Proof Reel.
- Energy Level — Define the video's energy or tone level.
- Story Flow — Narrative directions such as hook, proof points, call to action, or tone (max 1024 characters).
- Deep Research — Boolean indicating if Ngram should spend more time researching source material before generation.
Output shape
a single record containing data for the submitted video job
The operation returns immediately after submitting the video creation request with a job ID and metadata in a 'data' root property. Use the returned video ID with 'Get Status' or the 'On Video Ready' trigger to track completion and retrieve the final video URL.
Examples
Example 1: Create a marketing explainer video by providing a prompt describing the product, optionally associating a voice and style, then tracking the video generation status using the returned video ID.
Submit prompt and optional parameters; receives immediate acknowledgment with video job ID.