Overview/OpenAPI/Vector Animation

Vector Animation

Precisely express formulas, algorithms, structures, and processes.

Vector Animation

Use vector_animation only when you explicitly want a Vector Animation for formulas, algorithms, structures, or processes.

{  "type": "vector_animation",  "prompt": "Use [3, 7, 12, 18, 25, 31, 42, 56, 68, 73, 88] to demonstrate binary search for 73, with accurate low, high, and mid labels in every round",  "language": "en",  "aspect_ratio": "16:9"}

Do not send duration_seconds or scene_count. Read supported ratios, voices, and qualities from the catalog.

Best-fit requests

Use Vector Animation when accuracy depends on the visual structure: formulas, algorithms, system relationships, comparisons, or a process with ordered steps. Include the concrete entities, their relationships, the sequence, and the labels that must be correct. For an algorithm, provide the input and the expected state changes; for a system, name the components and direction of flow.

Keep the payload narrow and valid

Read /catalog first, then provide the language, ratio, voice, and quality values it permits for vector_animation. Do not add duration_seconds or scene_count; those fields belong to other products. Submit the creation, poll its job, and read the completed detail before presenting a result or offering a revision.

The detail response is also the authority for scenes[] and editable_actions. If an explanation or label needs work, use only an exposed edit action. If no such action is present, create a revised result with a more precise prompt instead of assuming a scene change is supported.