Files
File Segments
Describe

Get describe for a file segment

Changed on

Get a specific describe output for a file segment by job ID

get/files/{file_id}/segments/{segment_id}/describes/{job_id}

Request

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

Path parameters

file_idstring uuid required

The ID of the file

segment_idstring uuid required

The ID of the segment

job_idstring uuid required

The ID of the describe job

Query parameters

response_format'json' | 'markdown'

Output format for the describe data

Response

Describe for the segment

job_idstring uuid required

The ID of the describe job

segment_idstring uuid required

The ID of the video segment

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

Status of the describe job

created_atinteger required

Unix timestamp in milliseconds when the job was created

completed_atinteger

Unix timestamp in milliseconds when the job completed

start_timenumber required

Start time of the segment in seconds

end_timenumber required

End time of the segment in seconds

file_idstring uuid required

The ID of the file

segmentation_idstring uuid

The ID of the segmentation job

object'segment_describe' required

Object type

Changes