CLcloudglue
Describe

List all media description jobs

Changed on

List all media description jobs with optional filtering

get/describe

Request

  • Base URL
    https://api.cloudglue.dev/v1
  • Auth
    HTTP bearer

Query parameters

limitinteger

Maximum number of description jobs to return

offsetinteger

Number of description jobs to skip

status'pending' | 'processing' | 'completed' | 'failed' | 'not_applicable'

Filter description jobs by status

created_beforestring date

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

created_afterstring date

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

urlstring

Filter description jobs by the input URL used for description

response_format'json' | 'markdown'

Format for the response

include_databoolean

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.

modalitiesstring[]

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

include_metadataboolean

Include the file's user-defined metadata and source metadata. In markdown these render as a ## Metadata section; in JSON they populate file.metadata and file.source_metadata.

Response

A list of description jobs

object'list' required

Object type, always 'list'

totalinteger required

Total number of describe jobs matching the query

limitinteger required

Number of items returned in this response

offsetinteger required

Offset from the start of the list

Changes

  • 23d3f240819fRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 85130a1f5247Revision changes
    • info

      added the optional property /// to the response with the status