Generate motion graphic
generate_motion_graphicCreate animated motion graphics from a text prompt for precise text effects like typing, kinetic typography, and lower thirds, output as transparent WebM or opaque MP4.
Instructions
Generate an animated motion graphic video from a text prompt. Best for precise text animations (typing effects, kinetic typography, lower thirds) that stock or generated footage can't express. Outputs a transparent WebM overlay by default; set transparentBackground to false for an opaque MP4. Optionally pass reference media file ids to display or animate. Typically takes 2–5 minutes because VideoGen writes animation code and then renders it; complex prompts can take longer. Tell the user that wait before starting and keep polling calmly — a healthy in-progress job is expected.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| prompt | Yes | Description of the animated motion graphic. | |
| fileIds | No | Optional reference media file ids. | |
| entityIds | No | Optional actor, product, or visual-style entity ids (vg_enti_...). | |
| aspectRatio | No | Output aspect ratio as width:height units (not pixels). Example: { width: 16, height: 9 }. | |
| subToolModes | No | Optional per-capability controls for generated images, video clips, voiceover, and stock media. Omit to use AUTO for every capability. | |
| durationSeconds | No | ||
| transparentBackground | No | Render a transparent WebM for use as an overlay on other video or images. Defaults to true. Set to false for an opaque MP4. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Error details when status is failed; otherwise null. | |
| status | No | Job status: pending, running, succeeded, failed, or cancelled. | |
| results | No | Generated results with download URLs when succeeded. | |
| toolType | No | Tool name (e.g. GENERATE_IMAGE). | |
| attemptIndex | No | Current or latest attempt index. | |
| toolExecutionId | Yes | Tool execution id (vg_tool_...). | |
| progressPercentage | No | Completion progress 0-100 (present after polling). |