Ozor icon

Ozor

Generate, edit, and export AI videos via the Ozor API

Actions11

Document → Generate From Plan

AI-generated

Summary

Generate a video from an existing document analysis plan by streaming server-sent event (SSE) progress updates.

Inputs

  • Plan ID (required) — The unique identifier of the document analysis plan to render into a video.
  • Return Progress Events — Boolean toggle to include every SSE progress event in the output; if false (default), only the final event is returned.

Output shape

A single JSON object containing the final generation event from the plan, optionally including an array of all progress events when requested.

The operation streams SSE events from the API and aggregates them. It throws an error if generation fails or no 'done' event is received. When 'Return Progress Events' is true, the full event list is returned alongside the final event data.

Examples

Example 1: Generate video from plan with only final event output

Set 'Plan ID' to the target plan, leave 'Return Progress Events' false or unset; output includes final generation details.

Example 2: Generate video from plan with full progress events

Set 'Plan ID' to the target plan, set 'Return Progress Events' to true; output includes final event plus all SSE progress events array.

Links

Discussion