CLcloudglue
Frames

Get a specific frame extraction

Changed on

Retrieve details about a specific frame extraction including its frames

get/frames/{frame_extraction_id}

Request

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

Path parameters

frame_extraction_idstring uuid required

The ID of the frame extraction to retrieve

Query parameters

limitinteger

Number of frames to return

offsetinteger

Offset from the start of the frames list

Response

Frame extraction details

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

  • 1d5d6115c0d0Revision changes
    • breaking

      for the query request parameter limit, default value 50 was removed

    • breaking

      for the query request parameter offset, default value 0 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