CLcloudglue
Describe

Update describe job

Changed on

Toggle the use_in_default_index flag on an existing describe job. Enabling this makes the file searchable by default in the deep search and response APIs.

patch/describe/{job_id}

Request

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

Path parameters

job_idstring required

The unique identifier of the description job

Request body

use_in_default_indexboolean required

When true, the video's search documents will be added to the account's default index. When false, existing default index search documents are removed.

Response

Successful response

job_idstring required
status'pending' | 'processing' | 'completed' | 'failed' | 'not_applicable' required
urlstring

The URL of the processed video

duration_secondsnumber

Duration of the video in seconds

thumbnail_urlstring uri

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

created_atinteger

Unix timestamp in milliseconds when the job was created

use_in_default_indexboolean

Whether this describe job's search documents are included in the default index.

errorstring

Error message if status is 'failed'

segmentation_idstring uuid

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

total_chaptersinteger

Total number of chapters (only present when include_chapters=true and segmentation strategy is 'narrative')

total_shotsinteger

Total number of shots (only present when include_shots=true and segmentation strategy is 'shot-detector')

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