Skip to main content
GET
/
describe
List all media description jobs
curl --request GET \
  --url https://api.cloudglue.dev/v1/describe \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "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"
    }
  ],
  "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.

Query Parameters

​
limit
integer
default:20

Maximum number of description jobs to return

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

Number of description jobs to skip

​
status
enum<string>

Filter description jobs by status

Available options:
pending,
processing,
completed,
failed,
not_applicable
​
created_before
string<date>

Filter description jobs created before a specific date (YYYY-MM-DD format), in UTC timezone

​
created_after
string<date>

Filter description jobs created after a specific date (YYYY-MM-DD format), in UTC timezone

​
url
string

Filter description jobs by the input URL used for description

​
response_format
enum<string>
default:json

Format for the response

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

Include the data in the response. If false, the response will only include the job information and not the data to minimize the response size.

​
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 description jobs

​
object
enum<string>
required

Object type, always 'list'

Available options:
list
​
data
object[]
required

Array of describe job objects

​
total
integer
required

Total number of describe jobs matching the query

​
limit
integer
required

Number of items returned in this response

​
offset
integer
required

Offset from the start of the list