Skip to main content
GET
/
files
/
{file_id}
/
segments
/
{segment_id}
/
describes
List describes for a file segment
curl --request GET \
  --url https://api.cloudglue.dev/v1/files/{file_id}/segments/{segment_id}/describes \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending",
      "describe_config": {
        "enable_summary": true,
        "enable_speech": true,
        "enable_visual_scene_description": true,
        "enable_scene_text": true,
        "enable_audio_description": false
      },
      "created_at": 123,
      "start_time": 123,
      "end_time": 123,
      "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object": "segment_describe",
      "completed_at": 123,
      "segmentation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "data": {
        "visual_scene_description": [
          {
            "text": "<string>",
            "start_time": 123,
            "end_time": 123
          }
        ],
        "speech": [
          {
            "text": "<string>",
            "start_time": 123,
            "end_time": 123,
            "speaker": "<string>"
          }
        ],
        "scene_text": [
          {
            "text": "<string>",
            "start_time": 123,
            "end_time": 123
          }
        ],
        "audio_description": [
          {
            "text": "<string>",
            "start_time": 123,
            "end_time": 123
          }
        ],
        "title": "<string>",
        "summary": "<string>",
        "start_time": 123,
        "end_time": 123,
        "segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
file_id
string<uuid>
required

The ID of the file

​
segment_id
string<uuid>
required

The ID of the segment

Query Parameters

​
status
string
default:completed

Filter by job status. Supports comma-separated values (e.g., 'completed,processing'). Defaults to 'completed'.

​
response_format
enum<string>
default:json

Output format for the describe data

Available options:
json,
markdown
​
include_data
boolean
default:false

Include the describe data in the response. If false, only job information is returned. Defaults to false.

​
limit
integer
default:50

Number of items to return

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

Offset from the start of the list

Required range: x >= 0

Response

List of describes for the segment

List of describe outputs for a video segment

​
object
enum<string>
required

Object type, always 'list'

Available options:
list
​
data
object[]
required

Array of segment describe objects

​
total
integer
required

Total number of describe jobs for this segment

​
limit
integer
required

Number of items returned in this response

​
offset
integer
required

Offset from the start of the list