Documentation Index Fetch the complete documentation index at: https://docs.knowlify.com/llms.txt
Use this file to discover all available pages before exploring further.
Overview After submitting an edit , use the returned edit_id to poll for progress. The endpoint accepts the same X-API-Key you used to create the edit, and only the original submitter (or an active member of the submitter’s organization) may read the edit.
GET {API_BASE}/v1/edits/{edit_id}
Your API_BASE is shown in the Developer tab of your dashboard. The default production base is https://api.knowlify.com.
Authentication Send your key in the X-API-Key header — the same key (personal or organization) that submitted the edit.
X-API-Key: kn_ < 64 hex char s >
See Authentication for details on key issuance, rotation, and JWT alternatives.
Path parameters The edit ID returned by POST /v1/edits.
Code examples curl "https://api.knowlify.com/v1/edits/e942890a-7776-4029-82d6-ce733d0a2cb2" \ -H "X-API-Key: kn_YOUR_KEY_HERE"
Response The edit ID (echoes the path parameter).
The video this edit was submitted against.
Current state. One of:
queued — another edit on the same video is in flight; this one will run after it finishes.processing — phase 1 (Claude edit) is running.applying — phase 3 (video sync) is running.complete — all three phases finished successfully.error — a phase failed. See error_message.reverted — this edit was undone by POST /v1/edits/{edit_id}/revert true when status is complete or reverted.
true when status is error. Inspect error_message.
One of queued, editing, regenerating_frames, applying_edits, done.
Coarse 0–100 progress estimate. Updates at phase boundaries (5 → 40 → 75 → 100); it does not advance continuously inside a phase.
Present during regenerating_frames — the scene numbers being regenerated.
Present once status is complete or reverted. The new video URL, or null when phase 3 was skipped because the target video had never been rendered. See video_synced.
Scenes whose content was modified by the edit.
New scenes inserted by the edit.
Scenes removed by the edit.
Scenes whose video clips were regenerated during phase 3.
Scenes whose clips were carried forward unchanged.
false when the target video had no rendered timestamps and phase 3 was skipped — the planner reflects the edit but no new video was produced.
Present only on status: "reverted" responses. Contains changed_scene_numbers, added_scene_numbers, deleted_scene_numbers describing what the revert restored.
Human-readable failure reason. null on healthy edits.
ISO-8601 timestamp when the edit was accepted.
ISO-8601 timestamp of the last status change. Use this to detect stalled edits.
Example response (mid-flight) { "edit_id" : "e942890a-7776-4029-82d6-ce733d0a2cb2" , "video_uuid" : "550e8400-e29b-41d4-a716-446655440000" , "status" : "processing" , "is_complete" : false , "is_failed" : false , "progress" : { "stage" : "regenerating_frames" , "percent" : 40 , "scene_numbers" : [ 2 ] }, "result" : null , "error_message" : null , "created_at" : "2026-05-25T15:30:01.000000+00:00" , "updated_at" : "2026-05-25T15:30:42.123000+00:00" }
Example response (complete) { "edit_id" : "e942890a-7776-4029-82d6-ce733d0a2cb2" , "video_uuid" : "550e8400-e29b-41d4-a716-446655440000" , "status" : "complete" , "is_complete" : true , "is_failed" : false , "progress" : { "stage" : "done" , "percent" : 100 }, "result" : { "link" : "https://animation-encoder-videos.s3.us-west-2.amazonaws.com/<uuid>.mp4" , "changed_scene_numbers" : [ 2 ], "added_scene_numbers" : [], "deleted_scene_numbers" : [], "regenerated_scenes" : [ 2 ], "kept_scenes" : [ 1 , 3 , 4 , 5 ], "video_synced" : true }, "error_message" : null , "created_at" : "2026-05-25T15:30:01.000000+00:00" , "updated_at" : "2026-05-25T15:32:18.500000+00:00" }
Poll at most once every 5 seconds — progress.percent advances at phase boundaries, not per-scene. Production integrations should subscribe to Supabase realtime updates on the external_edits table instead. Reach out for a Supabase anon key scoped to your account.
Limits & errors
The polling endpoint shares the 10 requests / 60 seconds rate limit with POST /v1/edits. See Rate Limits .
Full status code reference: Errors .
