Add Media to Collection
Add a video or audio file to a collection. This is the recommended endpoint for adding media files to collections.
Media Type Handling:
- Video files: Processed with full visual analysis (scene description, text extraction, etc.)
- Audio files: Visual features automatically disabled; only speech and audio analysis available
Audio File Restrictions:
- Audio files cannot be added to face-analysis collections
- Shot-detector segmentation is not available for audio files
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the collection to add the media file to
Body
File association parameters
- Option 1
- Option 2
The ID of the file to add to the collection
Segmentation job id to use. If not provided will use default to uniform 20s segmentation. Cannot be provided together with segmentation_config.
Configuration for video segmentation. Cannot be provided together with segmentation_id.
Response
Successful file addition
ID of the collection
ID of the file
Object type, always 'collection_file'
collection_file Unix timestamp in milliseconds when the file was added to the collection
Overall processing status of the file in this collection
pending, processing, completed, failed, not_applicable The file object
Segmentation information for this file in the collection. Only present when the file has been segmented.