Skip to main content
GET
/
collections
/
{collection_id}
/
videos
/
{file_id}
/
media-descriptions
Retrieve media description data for a specific file in a collection
curl --request GET \
  --url https://api.cloudglue.dev/v1/collections/{collection_id}/videos/{file_id}/media-descriptions \
  --header 'Authorization: Bearer <token>'
{
  "collection_id": "<string>",
  "file_id": "<string>",
  "content": "<string>",
  "title": "<string>",
  "summary": "<string>",
  "duration_seconds": 123,
  "segment_summary": [
    {
      "title": "<string>",
      "summary": "<string>",
      "start_time": 123,
      "end_time": 123
    }
  ],
  "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
    }
  ]
}
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

​
file_id
string
required

The ID of the file

Query Parameters

​
response_format
enum<string>
default:json

Format for the response

Available options:
json,
markdown
​
start_time_seconds
number

Start time in seconds to filter out results by

​
end_time_seconds
number

End time in seconds to filter out results by

Response

Media description data

​
collection_id
string
required

Unique identifier for the collection

​
file_id
string
required

Unique identifier for the file

​
content
string

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

​
title
string

Generated title of the video

​
summary
string

Generated video level summary

​
duration_seconds
number

Duration of the video in seconds

​
segment_summary
object[]

Array of summary information for each segment of the video

​
visual_scene_description
object[]

Array of visual descriptions

​
scene_text
object[]

Array of scene text extractions

​
speech
object[]

Array of speech transcriptions

​
audio_description
object[]

Array of audio descriptions