Extract

Create a new extract job

Changed on

Extract structured data from a video

post/extract

Request

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

Request body

urlstring required

Input media URL. Supports URIs of files uploaded to Cloudglue Files endpoint, public YouTube video URLs, public TikTok video URLs, public Loom share URLs, public HTTP URLs (including direct image URLs such as JPEG/PNG/WebP), and files which have been granted access to Cloudglue via data connectors.

Note that YouTube videos are currently limited to speech level understanding only. Public TikTok video URLs will be scraped and stored automatically — subject to charges. For files via our Data connectors, see our documentation on data connectors for setup information.

promptstring

A natural language prompt describing the data you want to extract. Required if no schema is provided.

schemaobject

A more rigid structure if you already know the JSON layout you want. Required if no prompt is provided.

enable_video_level_entitiesboolean

Whether to extract entities at the video level. Mutually exclusive with enable_segment_level_entities - only one can be true.

enable_segment_level_entitiesboolean

Whether to extract entities at the segment level. Mutually exclusive with enable_video_level_entities - only one can be true.

enable_transcript_modeboolean

When enabled, extract entities from transcript only (similar to YouTube path). Useful for speech-heavy content.

enable_metadata_modeboolean

When enabled, extract entities from the file's metadata document (filename, file details, user metadata, and connector source metadata) instead of the media content. File-level entities only; flat 1 credit per file; works on metadata-only files without ingesting their media. Mutually exclusive with enable_transcript_mode.

include_chaptersboolean

Include narrative chapters in the response when segmentation strategy is 'narrative'. Only affects cached completed results; newly created pending jobs do not include chapters.

include_shotsboolean

Include shot boundaries in the response when segmentation strategy is 'shot-detector'. Only affects cached completed results; newly created pending jobs do not include shots.

segmentation_idstring uuid

Segmentation job id to use. If not provided will use default to uniform 20s segmentation. Cannot be provided together with segmentation_config.

Response

Successful response

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

The URL of the processed video

created_atinteger

Unix timestamp in milliseconds when the job was created

segmentation_idstring

The ID of the segmentation job used for this extraction

totalinteger

Total number of segment entities available. Only present when status is 'completed'.

limitinteger

Maximum number of segment entities returned per request. Only present when status is 'completed'.

offsetinteger

Number of segment entities skipped. Only present when status is 'completed'.

errorstring

Error message if status is 'failed'

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

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status