Skip to main content
PUT
Update a collection

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

collection_id
string
required

The ID of the collection to update

Body

application/json

Collection update parameters

name
string

Name of the collection

description
string

Description of the collection

Response

Successful collection update

id
string
required

Unique identifier for the collection

object
enum<string>
required

Object type, always 'collection'

Available options:
collection
name
string
required

Name of the collection

collection_type
enum<string>
required

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

Available options:
media-descriptions,
entities,
rich-transcripts,
face-analysis
created_at
integer
required

Unix timestamp in milliseconds when the collection was created

file_count
integer
required

Number of files in the collection

description
string | null

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

extract_config
object

Configuration for automatic entity extraction from videos. Required when collection_type is 'entities'.

transcribe_config
object

Configuration for rich transcription from videos. Used when collection_type is 'rich-transcripts'. If not provided, default values will be used.

describe_config
object

Configuration for comprehensive media description from videos. Used when collection_type is 'media-descriptions'. If not provided, default values will be used.

default_segmentation_config
object

Default segmentation configuration used for files in this collection

default_thumbnails_config
object

Default thumbnails configuration used for files in this collection

face_detection_config
object | null

Configuration for face detection in videos. Only present when collection_type is 'face-analysis'.