Collections

Create a new collection to organize and process video files

Changed on

Create a new collection to organize and process video files. Collections are used to group files together and process them in a consistent way.

post/collections

Request

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

Request body

collection_type'media-descriptions' | 'entities' | 'rich-transcripts' | 'face-analysis' | 'metadata' | 'moments' required

Type of collection, determines how videos are processed and what data is extracted.

Collection Types:

  • media-descriptions: Generate comprehensive media descriptions with speech, visual, and text analysis (use describe_config)
  • entities: Extract structured data/entities from videos (requires extract_config)
  • rich-transcripts: Generate rich transcriptions with speech and visual descriptions (use transcribe_config). For backward compatibility only, new collections should use media-descriptions instead.
  • face-analysis: Detect and index faces in videos for face matching and search (use face_detection_config)
  • metadata: Index connector source metadata + user metadata into file-level search documents WITHOUT downloading or processing the media. Free to index. Supports google-drive, dropbox, zoom, gong, recall, grain, and iconik URLs. No processing configs are accepted.

⚠️ Important: Only provide the config that matches your collection_type. Other configs will be ignored.

namestring required

Name of the collection (must be unique within an organization)

descriptionstring nullable

Description of the collection's purpose or contents, null if none provided

Response

Successful collection creation

idstring required

Unique identifier for the collection

object'collection' required

Object type, always 'collection'

namestring required

Name of the collection

descriptionstring nullable

Description of the collection's purpose or contents, null if none provided

collection_type'media-descriptions' | 'entities' | 'rich-transcripts' | 'face-analysis' | 'metadata' | 'moments' required

Type of collection, determines how videos are processed and what data is extracted

created_atinteger required

Unix timestamp in milliseconds when the collection was created

file_countinteger required

Number of files in the collection

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