Skip to main content
POST
/
files
/
{file_id}
/
frames
Create a new frame extraction for a file
curl --request POST \
  --url https://api.cloudglue.dev/v1/files/{file_id}/frames \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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_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,
  "data": {
    "object": "list",
    "frames": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "timestamp": 123,
        "thumbnail_url": "<string>"
      }
    ],
    "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 to extract frames from

Body

application/json

Frame extraction configuration

Frame extraction configuration (root level) with optional thumbnails configuration. Configuration for frame extraction. Currently only supports uniform strategy.

​
strategy
enum<string>
required

Frame extraction strategy - currently only 'uniform' is supported

Available options:
uniform
​
thumbnails_config
object

Configuration for frame thumbnails. Optional.

​
uniform_config
object

Configuration for uniform frame extraction

​
start_time_seconds
number

Optional: The start time of the video in seconds to start extracting frames from

Required range: x >= 0
​
end_time_seconds
number

Optional: The end time of the video in seconds to stop extracting frames at

Required range: x >= 0

Response

Frame extraction created successfully

​
frame_extraction_id
string<uuid>
required

Unique identifier for the frame extraction job

​
status
enum<string>
required

Status of the frame extraction job

Available options:
pending,
processing,
completed,
failed
​
created_at
number
required

Unix timestamp of when the frame extraction was created

Required range: x >= 0
​
file_id
string<uuid>
required

ID of the file this frame extraction belongs to

​
frame_extraction_config
object
required

Configuration for frame extraction. Currently only supports uniform strategy.

​
frame_count
number

Total number of frames extracted (only present when status is completed)

Required range: x >= 0
​
data
object

Frame data with pagination (only present when status is completed and frames exist)

⌘I