Skip to content
DeepFrame Alpha
日本語
Videos

List videos

GET/api/v1alpha1/videos

Returns the videos in your workspace, newest first.

  • Access: an alpha-enabled API key with the READ_VIDEOS permission.
  • Filters: status.
  • Paging: limit defaults to 25, maximum 100. Pass next_cursor back unchanged as cursor.

Each row carries the public id used as the video_id in other video calls. To analyse a video, pass a workflow_id you already have to POST /api/v1alpha1/runs.

Authorization

apiKey
AuthorizationBearer <token>

In: header

Query Parameters

cursor?string

Opaque cursor returned as next_cursor by the previous response. Pass it byte-for-byte as cursor; do not decode, edit, or construct it.

limit?number

Number of resources to return in one page. The default is 25 and the accepted range is 1-100.

Formatint32
Range1 <= value <= 100
Default25
status?string

Coarse processing status: queued is waiting to start; processing is extracting, analyzing, or indexing; completed is searchable; failed ended with an error. Omit it to return all visible videos.

Value in

  • "queued"
  • "processing"
  • "completed"
  • "failed"

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" \  -H "Authorization: Bearer $DEEPFRAME_API_KEY"
{  "data": [    {      "created_at": "2026-08-08T10:00:00.000Z",      "duration": 183.75,      "filename": "warehouse-inspection-2026-08-08.mp4",      "frame_count": 4410,      "id": "vid_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",      "progress": 100,      "source": "user",      "status": "completed",      "updated_at": "2026-08-08T10:06:12.000Z"    }  ],  "has_more": false,  "next_cursor": "MDEyMzQ1Njc4OWFitSLKnTQIcJAwDPi07V5EGs76Im3F8rCuUshrBnHuUJY7_8Ie8Stea_TKuhKhDw5XkRdkBI3IKkvsKT9Kp60Wpx7CoTCGQW8FnalDILVbuy8wxvWWf_B8SA"}

Overview

Previous Page

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.