CLcloudglue
Describe

Retrieve the current state of a media description job

Changed on

Retrieve the current state of a media description job

get/describe/{job_id}

Request

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

Path parameters

job_idstring required

The unique identifier of the description job

Query parameters

response_format'json' | 'markdown' | 'speech_srt' | 'speech_vtt' | 'speech_markdown' | 'speech_text'

Format for the response. Use speech_srt or speech_vtt for subtitle formats, speech_markdown for a diarized transcript, or speech_text for plain timestamped text.

start_time_secondsnumber

Start time in seconds to filter out results by

end_time_secondsnumber

End time in seconds to filter out results by

modalitiesstring[]

The modalities to output in the response. Can be used to return smaller data sets. Comma separated list of strings. Defaults to all modalities available / previously extracted. Accepted values are speech,visual_scene_description,scene_text, audio_description, summary, segment_summary, title

include_thumbnailsboolean

When true, include a file-level thumbnail_url on the response, per-segment thumbnail_url on each segment_summary entry, and inject thumbnail images into markdown output

include_word_timestampsboolean

When true, include a words array on each speech entry with word-level start_time and end_time. Not available for YouTube sources. Only applies when response_format=json.

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')

include_metadataboolean

Include the file's user-defined metadata and source metadata. In markdown these render as a ## Metadata section; in JSON they populate file.metadata and file.source_metadata.

Response

Successful response with job details

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

The URL of the processed video

duration_secondsnumber

Duration of the video in seconds

thumbnail_urlstring uri

URL of the file-level thumbnail for the video. Only present when include_thumbnails=true.

created_atinteger

Unix timestamp in milliseconds when the job was created

use_in_default_indexboolean

Whether this describe job's search documents are included in the default index.

errorstring

Error message if status is 'failed'

segmentation_idstring uuid

The ID of the segmentation job if the describe was run with a segmentation

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

  • 85130a1f5247Revision changes
    • info

      added the optional property / to the response with the status