Poll edit status

These pages describe the Training API on dev, where authenticated creation, editing, downloads, revert, and website brand lookup have been tested live. Production availability is not confirmed. Your API service and worker must both run the updated code. See Testing and availability.

GET {API_BASE}/v1/edits/{edit_id}

curl --fail-with-body "$API_BASE/v1/edits/$EDIT_ID" \
  -H "X-API-Key: $KNOWLIFY_API_KEY"

Both the edit record and its video must be accessible within the key’s scope.

Response

Field	Meaning
`edit_id`, `video_uuid`	Edit and video identifiers
`status`	`queued`, `processing`, `applying`, `awaiting_approval`, `awaiting_clarification`, `complete`, `error`, `cancelled`, or `reverted`
`is_complete`	True for `complete` or `reverted`
`is_failed`	True for `error` or `cancelled`
`progress`	Stage and coarse percentage; may include scene numbers
`required_action`	The saved plan or question that needs a response; otherwise null
`result`	Result object when available; otherwise null
`error_message`	Failure reason, or null
`created_at`, `updated_at`	Creation and update timestamps

The result can include:

video_synced: whether the edit was applied through video sync. False means no new rendered video was applied, for example when no rendered timestamps existed.
link: an available video URL; may be null. Do not infer synchronization from the URL alone.
changed_scene_numbers, added_scene_numbers, deleted_scene_numbers: planner changes.
regenerated_scenes, kept_scenes: rendering outcomes.
revert_diff: snapshot changes when reverted.

const response = await fetch(
  `${process.env.API_BASE}/v1/edits/${process.env.EDIT_ID}`,
  { headers: { "X-API-Key": process.env.KNOWLIFY_API_KEY } },
);
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const edit = await response.json();
if (edit.is_failed) throw new Error(edit.error_message || "Edit failed");
if (edit.status === "complete") {
  console.log({ applied: edit.result?.video_synced, url: edit.result?.link });
} else if (edit.status === "reverted") {
  console.log("The edit has been reverted");
}

An edit can finish scene synchronization before the combined MP4 is assembled. If result.link is null, poll video status using video_uuid until is_complete is true and video_url is available. Treat that URL as the video’s current output; a later edit can replace it. Signed Knowlify media URLs expire after one hour, so fetch a fresh status response when needed. Poll about every five seconds, back off on errors, and impose a timeout. Progress is approximate and can skip stages; clients must not depend on seeing every intermediate stage. If the edit waits for approval or clarification, stop polling for completion. Read required_action and take the matching edit action. Automatic plan approval remains the default. A completed edit can be reverted if it meets the snapshot and ordering requirements.

Overview

Guides

Endpoints

Response

​Response

Response