CLcloudglue
Transcribe

Create a new transcription job

Changed on

Creates a new transcription job for video content.

Note: For most use cases, you should use the /describe endpoint instead. This API will be deprecated in the future and only supports speech level understanding.

post/transcribe

Request

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

Request body

urlstring required

Input video 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, 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.

enable_summaryboolean

Whether to generate video-level and segment-level (moment-level) summaries and titles

enable_speechboolean

Whether to generate speech transcript

enable_visual_scene_descriptionboolean

Whether to generate visual scene description

enable_scene_textboolean

Whether to generate scene text extraction

enable_audio_descriptionboolean

Whether to generate audio description

include_metadataboolean

Include the file's user-defined metadata and source metadata on the returned file object.

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

errorstring

Error message if status is 'failed'

Changes

  • 23d3f240819fRevision 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

  • c02e52ec2e28Revision changes
    • info

      added the new optional request property /

    • info

      added the optional property to the response with the status