Get a video
/api/v1alpha1/videos/{video_id}Returns one video and where it has got to in processing.
- Access: an alpha-enabled API key with the
READ_VIDEOSpermission. - Watch:
status,progress, and the nestederrorobject tell you whether to wait, investigate, or start a run. - Not found: a video in another workspace is deliberately indistinguishable from one that does not exist.
Authorization
apiKey In: header
Path Parameters
Identifier of a video, as returned in id by the upload intent.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/api/v1alpha1/videos/vid_0190b5d4-7e1f-7a2b-9c3d-1234567890ab" \ -H "Authorization: Bearer $DEEPFRAME_API_KEY"{ "created_at": "2026-08-08T10:00:00.000Z", "duration": 183.75, "error": { "code": "budget_exhausted", "detail": "", "next_action": "", "title": "" }, "error_message": "The video could not be processed.", "filename": "warehouse-inspection-2026-08-08.mp4", "frame_count": 4410, "id": "vid_0190b5d4-7e1f-7a2b-9c3d-1234567890ab", "progress": 100, "source": "user", "status": "completed", "thumbnail_url": "https://cdn.example.test/media/vid_0190b5d4/thumbnail.jpg", "updated_at": "2026-08-08T10:06:12.000Z"}Create a direct or multipart video upload POST
Opens a server-selected direct or multipart upload session. The request contains only the original filename and exact filesize; the server determines content type from the filename and measures duration during processing. Video bytes go directly to storage and never pass through this API. Files up to 200 MiB use one PUT, and larger files use 10 MiB multipart chunks. The response reports the selected strategy.
Get a video upload session GET
Returns the owner-scoped upload session and persisted resume progress without changing activity state or issuing storage targets. Use POST /api/v1alpha1/videos/{videoid}/upload/targets to mint fresh targets. Internal storage identifiers are never returned.