CLcloudglue
Segments

Retrieve the current state of a segmentation job

Changed on

Retrieve the current state of a segmentation job

get/segments/{job_id}

Request

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

Path parameters

job_idstring uuid required

The unique identifier of the segmentation job

Response

Successful response with job details

job_idstring uuid required

Unique identifier for the segment job

file_idstring uuid required

ID of the file this segment belongs to

object'segments' required

Object type, always 'segments'

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

Current status of the segment job

criteria'shot' | 'narrative' required

Segment criteria used for this job

created_atinteger required

Unix timestamp in milliseconds when the job was created

total_segmentsinteger

Total number of segments generated (only present when status is 'completed')

total_shotsinteger

Total number of shots in the original video (only present when criteria is 'shot')

total_chaptersinteger

Total number of chapters in the video (only present when criteria is 'narrative')

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

  • f90a8032c6aeRevision changes
    • breaking

      the / response property's min was decreased from 1.00 to 0.60 for the response status

    • breaking

      the / response's property type changed from integer to number for status

    • breaking

      the / response's property type changed from integer to number for status