Skip to content
Videos

Get a video

GET/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_VIDEOS permission.
  • Watch: status, progress, and the nested error object 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.
AuthorizationBearer <token>

In: header

Path Parameters

video_id*string

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"}