Overview/OpenAPI/Editing & Errors

Editing & Errors

Scene edits, Omni iteration, and error handling.

Editing and errors

Use POST /creations/{creation_id}/edit.

Scene editing

{  "action": "update_scene_narration",  "scene_id": "section_2",  "narration_text": "Updated narration"}

Use regenerate_scene to rebuild one scene. Read editable_actions and scenes[] first.

AI Video iteration

Only use this when the catalog or detail exposes conversational editing:

{  "action": "iterate",  "prompt": "Keep the camera motion and make the lighting warmer"}

No interaction ID is required. Veo does not support iterate; create a new result instead.

Check what the completed result allows

Editing is capability-based. Fetch GET /creations/{creation_id} after the original job succeeds, then inspect editable_actions and scenes[] before offering an edit control. A client should not imply that every creation, field, or provider supports the same revision path. Scene-level edits apply only where the returned detail makes them available.

Treat every edit as asynchronous

An edit creates work of its own. Keep the job information returned by the edit request, poll the job endpoint, and refresh the creation detail only after it succeeds. Present the refreshed main_url, artifacts, scenes, and editable actions rather than continuing to display a cached version of the original result.

Handle errors without duplicate edits

Use the structured HTTP response and job status to distinguish invalid parameters, unsupported actions, permissions, and account or credit limits. Correct the request or ask the user for the needed decision before submitting another edit. For a Veo result or a creation without the requested action, create a new catalog-valid result rather than retrying iterate.