CLcloudglue
Collections

List all media description data for files in a collection

Changed on

List all media description data for files in a collection. This API is only available when a collection is created with collection_type 'media-descriptions'

get/collections/{collection_id}/media-descriptions

Request

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

Path parameters

collection_idstring required

The ID of the collection

Query parameters

limitinteger

Maximum number of files to return

offsetinteger

Number of files to skip

order'added_at' | 'filename'

Order the files by a specific field

sort'asc' | 'desc'

Sort the files in ascending or descending order

added_beforestring date

Filter files added before a specific date (YYYY-MM-DD format), in UTC timezone

added_afterstring date

Filter files added after a specific date (YYYY-MM-DD format), in UTC timezone

response_format'json' | 'markdown'

Format for the response

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_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

A list of media description data in the collection

object'list' required

Object type, always 'list'

totalinteger required

Total number of files with media description data matching the query

limitinteger required

Number of items returned in this response

offsetinteger required

Offset from the start of the list

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