CLcloudglue
Files

Create a new segmentation for a file

Changed on

Create a new segmentation for a file using the specified segmentation configuration

post/files/{file_id}/segmentations

Request

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

Path parameters

file_idstring uuid required

The ID of the file to segment

Request body

strategy'uniform' | 'shot-detector' | 'manual' | 'narrative' required

Segmentation strategy - determines which config you must provide

start_time_secondsnumber

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

end_time_secondsnumber

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

Response

Segmentation created successfully

segmentation_idstring uuid required

Unique identifier for the segmentation job

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

Status of the segmentation job. If a job has the status 'not_applicable' it means that we were unable to find any appropriate scenes for this video. This can be possible if you use the shot-detector strategy.

created_atnumber required

Unix timestamp in milliseconds when the segmentation was created

file_idstring uuid required

ID of the file this segmentation belongs to

total_segmentsnumber

Total number of segments in this segmentation (only present when status is completed)

total_shotsnumber

Total number of shots in this segmentation (only present when status is completed and segmentation_config.strategy is 'shot-detector')

total_chaptersnumber

Total number of chapters in this segmentation (only present when status is completed and segmentation_config.strategy 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

    • 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

    • info

      the ///// request property's min was decreased from 1.00 to 0.60