Skip to main content
GET
/
collections
/
{collection_id}
/
media-descriptions
List all media description data for files in a collection
curl --request GET \
  --url https://api.cloudglue.dev/v1/collections/{collection_id}/media-descriptions \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "file_id": "<string>",
      "added_at": 123,
      "object": "collection_file",
      "data": {
        "content": "<string>",
        "title": "<string>",
        "summary": "<string>",
        "segment_summary": [
          {
            "title": "<string>",
            "summary": "<string>",
            "start_time": 123,
            "end_time": 123,
            "thumbnail_url": "<string>"
          }
        ],
        "visual_scene_description": [
          {
            "text": "<string>",
            "start_time": 123,
            "end_time": 123
          }
        ],
        "scene_text": [
          {
            "text": "<string>",
            "start_time": 123,
            "end_time": 123
          }
        ],
        "speech": [
          {
            "speaker": "<string>",
            "text": "<string>",
            "start_time": 123,
            "end_time": 123
          }
        ],
        "audio_description": [
          {
            "text": "<string>",
            "start_time": 123,
            "end_time": 123
          }
        ]
      },
      "duration_seconds": 123
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}
For details on how to create a video collection, see Create Collection

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
collection_id
string
required

The ID of the collection

Query Parameters

​
limit
integer
default:20

Maximum number of files to return

Required range: x <= 100
​
offset
integer
default:0

Number of files to skip

​
order
enum<string>
default:added_at

Order the files by a specific field

Available options:
added_at,
filename
​
sort
enum<string>
default:desc

Sort the files in ascending or descending order

Available options:
asc,
desc
​
added_before
string<date>

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

​
added_after
string<date>

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

​
response_format
enum<string>
default:json

Format for the response

Available options:
json,
markdown
​
modalities
enum<string>[]

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

Available options:
speech,
visual_scene_description,
scene_text,
audio_description,
summary,
segment_summary,
title

Response

A list of media description data in the collection

​
object
enum<string>
required

Object type, always 'list'

Available options:
list
​
data
object[]
required

Array of media description data

​
total
integer
required

Total number of files with media description data matching the query

​
limit
integer
required

Number of items returned in this response

​
offset
integer
required

Offset from the start of the list