CLcloudglue
Collections

Retrieve media description data for a specific file in a collection

Changed on

Retrieve media description data for a specific file in a collection. This API is only available when the collection is created with collection_type 'media-descriptions'

get/collections/{collection_id}/videos/{file_id}/media-descriptions

Request

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

Path parameters

collection_idstring required

The ID of the collection

file_idstring required

The ID of the file

Query parameters

response_format'json' | 'markdown'

Format for the response

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 and per-segment thumbnail_url on each segment_summary entry

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

Media description data

collection_idstring required

Unique identifier for the collection

file_idstring required

Unique identifier for the file

thumbnail_urlstring uri

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

contentstring

Content string returned based on formatting, e.g. set to markdown text when response_format=markdown is requested

titlestring

Generated title of the video

summarystring

Generated video level summary

duration_secondsnumber

Duration of the video in seconds

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

    • info

      added the optional property to the response with the status

  • c02e52ec2e28Revision changes
    • info

      added the new optional query request parameter include_metadata

    • info

      added the optional property / to the response with the status