Skip to main content
GET
/
files
/
{file_id}
/
segments
/
{segment_id}
/
describes
/
{job_id}
Get describe for a file segment
curl --request GET \
  --url https://api.cloudglue.dev/v1/files/{file_id}/segments/{segment_id}/describes/{job_id} \
  --header 'Authorization: Bearer <token>'
{
  "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"
  }
}

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

​
job_id
string<uuid>
required

The ID of the describe job

Query Parameters

​
response_format
enum<string>
default:json

Output format for the describe data

Available options:
json,
markdown

Response

Describe for the segment

Describe output for a specific video segment

​
job_id
string<uuid>
required

The ID of the describe job

​
segment_id
string<uuid>
required

The ID of the video segment

​
status
enum<string>
required

Status of the describe job

Available options:
pending,
processing,
completed,
failed,
not_applicable
​
describe_config
object
required

Configuration for media description from videos

​
created_at
integer
required

Unix timestamp in milliseconds when the job was created

​
start_time
number
required

Start time of the segment in seconds

​
end_time
number
required

End time of the segment in seconds

​
file_id
string<uuid>
required

The ID of the file

​
object
enum<string>
required

Object type

Available options:
segment_describe
​
completed_at
integer

Unix timestamp in milliseconds when the job completed

​
segmentation_id
string<uuid>

The ID of the segmentation job

​
data
object

The describe output data. When response_format=json, contains visual_scene_description, speech, scene_text, and audio_description arrays. When response_format=markdown, contains a content string.