CLcloudglue
Files

Create a new frame extraction for a file

Changed on

Create a new frame extraction for a file using the specified frame extraction configuration. This is an async operation that returns immediately with a 'pending' status. Results are cached, so identical requests will return the same frame extraction.

post/files/{file_id}/frames

Request

  • Base URL
    https://api.cloudglue.dev/v1
  • Auth
    HTTP bearer

Path parameters

file_idstring uuid required

The ID of the file to extract frames from

Request body

strategy'uniform' required

Frame extraction strategy - currently only 'uniform' is supported

start_time_secondsnumber

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

end_time_secondsnumber

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

Response

Frame extraction created successfully

frame_extraction_idstring uuid required

Unique identifier for the frame extraction job

status'pending' | 'processing' | 'completed' | 'failed' required

Status of the frame extraction job

created_atnumber required

Unix timestamp in milliseconds when the frame extraction was created

file_idstring uuid required

ID of the file this frame extraction belongs to

frame_countnumber

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

Changes

  • 23d3f240819fRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 1d5d6115c0d0Revision changes
    • info

      the request property default value true was removed

    • info

      the request property default value true was removed

    • info

      the request property default value 1 was removed

    • info

      the request property default value 1024 was removed

    • info

      the response's property default value true was removed for the status

    • info

      the response's property default value 1 was removed for the status

    • info

      the response's property default value 1024 was removed for the status