Skip to main content
GET
/
files
/
{file_id}
/
frames
List frame extractions for a file
curl --request GET \
  --url https://api.cloudglue.dev/v1/files/{file_id}/frames \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "frame_extraction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending",
      "created_at": 1,
      "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "frame_extraction_config": {
        "strategy": "uniform",
        "uniform_config": {
          "frames_per_second": 1,
          "max_width": 1024
        },
        "thumbnails_config": {
          "enable_frame_thumbnails": true
        },
        "start_time_seconds": 1,
        "end_time_seconds": 1
      },
      "frame_count": 1
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

file_id
string<uuid>
required

The ID of the file

Query Parameters

limit
integer
default:50

Number of frame extractions to return

Required range: 1 <= x <= 100
offset
integer
default:0

Offset from the start of the list

Required range: x >= 0

Response

List of frame extractions

object
enum<string>
required

Object type, always 'list'

Available options:
list
data
object[]
required

Array of frame extraction objects

total
integer
required

Total number of frame extractions matching the query

limit
integer
required

Number of items returned in this response

offset
integer
required

Offset from the start of the list

I