Skip to main content
GET
/
describe
/
{job_id}
Retrieve the current state of a media description job
curl --request GET \
  --url https://api.cloudglue.dev/v1/describe/{job_id} \
  --header 'Authorization: Bearer <token>'
{
  "job_id": "<string>",
  "status": "pending",
  "url": "<string>",
  "duration_seconds": 123,
  "thumbnail_url": "<string>",
  "created_at": 123,
  "describe_config": {
    "enable_summary": true,
    "enable_speech": true,
    "enable_visual_scene_description": true,
    "enable_scene_text": true,
    "enable_audio_description": true
  },
  "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
      }
    ]
  },
  "error": "<string>",
  "segmentation_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

​
job_id
string
required

The unique identifier of the description job

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

​
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
​
include_thumbnails
boolean
default:false

When true, include a file-level thumbnail_url on the response, per-segment thumbnail_url on each segment_summary entry, and inject thumbnail images into markdown output

Response

Successful response with job details

​
job_id
string
required
​
status
enum<string>
required
Available options:
pending,
processing,
completed,
failed,
not_applicable
​
url
string

The URL of the processed video

​
duration_seconds
number

Duration of the video in seconds

​
thumbnail_url
string<uri>

URL of the file-level thumbnail for the video. Only present when include_thumbnails=true.

​
created_at
integer

Unix timestamp in milliseconds when the job was created

​
describe_config
object

Configuration for media description from videos

​
data
object
​
error
string

Error message if status is 'failed'

​
segmentation_id
string<uuid>

The ID of the segmentation job if the describe was run with a segmentation