AI App

AI App API

Use interactive_lesson to create a clickable lesson, quiz, simulator, or learning app.

Create

POST /creations

{  "type": "interactive_lesson",  "prompt": "Build an interactive lesson that lets students explore how binary search narrows the range",  "language": "en",  "instructions": "Include step controls and a reset action"}

Usually not needed:

• voice_id
• duration_seconds
• scene_count

Manage

The main priorities are:

• whether the job is complete
• the final launch URL
• a preview or cover image

Revise

Public OpenAPI does not currently expose scene-level editing for AI Apps. To revise the experience, create a new result with the updated prompt and instructions.

Practical Guidance

• keep both the UI and docs lightweight
• do not copy the full video or slides parameter surface
• return a clear “open this URL to try it” result first

Choose AI App for interaction, not playback

Use AI App when someone should manipulate a concept, make a choice, answer a question, or explore a simulator. A useful request identifies the user, the action they should take, the learning or decision goal, the controls they need, and what a completed interaction looks like. This produces a more focused result than asking for a broad “learning app.”

Keep the request inside the app contract

interactive_lesson is not a video type. Use the prompt for the user goal and use instructions for concrete product constraints such as steps, feedback, reset behavior, or accessibility needs. Leave out voice_id, duration_seconds, and scene_count. Read /catalog, create one valid request, poll its job, then retrieve the completed main_url through the creation detail.

Public OpenAPI does not currently offer scene-level editing for AI Apps. If the interaction needs a material change, create a revised result with clearer requirements and share the new returned launch URL rather than treating a video edit action as an app update.

Related guides

• Catalog for current capability data
• Creations & Jobs for the async lifecycle
• Vector Animation for an explanatory but non-interactive result