CLcloudglue
Extract

Retrieve the current state of an extraction job

Changed on

Retrieve the current state of an extraction job. Results are paginated with a default limit of 50 segment entities per request (maximum 100). Use limit and offset parameters to paginate through all segment entities.

get/extract/{job_id}

Request

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

Path parameters

job_idstring required

The unique identifier of the extraction job

Query parameters

limitinteger

Maximum number of segment entities to return

offsetinteger

Number of segment entities to skip

include_thumbnailsboolean

When true, include a file-level thumbnail_url in the data object and a per-segment thumbnail_url on each segment entity

include_chaptersboolean

Include narrative chapters in the response (when segmentation strategy is 'narrative')

include_shotsboolean

Include shot boundaries in the response (when segmentation strategy is 'shot-detector')

Response

Successful response with job details

job_idstring required
status'pending' | 'processing' | 'completed' | 'failed' | 'not_applicable' required
urlstring

The URL of the processed video

created_atinteger

Unix timestamp in milliseconds when the job was created

segmentation_idstring

The ID of the segmentation job used for this extraction

totalinteger

Total number of segment entities available. Only present when status is 'completed'.

limitinteger

Maximum number of segment entities returned per request. Only present when status is 'completed'.

offsetinteger

Number of segment entities skipped. Only present when status is 'completed'.

errorstring

Error message if status is 'failed'

total_chaptersinteger

Total number of chapters (only present when include_chapters=true and segmentation strategy is 'narrative')

total_shotsinteger

Total number of shots (only present when include_shots=true and segmentation strategy is 'shot-detector')

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

  • 915ee485b763Revision changes
    • info

      added the optional property / to the response with the status