> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# VideoDB

> VideoDB is a video infrastructure platform for storing, searching, understanding, editing, and generating video, audio, and image content.

![VideoDB logo](https://mintcdn.com/composio-preview/DMB8UrgJmE7r-ZQ5/images/toolkits/video_db.svg?fit=max\&auto=format\&n=DMB8UrgJmE7r-ZQ5\&q=85\&s=a6baafc654f844082809a64eb871e834)

* **Category:** video & audio
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 11
* **Triggers:** 0
* **Slug:** `VIDEO_DB`
* **Version:** 20261101\_00

## Tools

> [accordion] Ask Collection
>
> **Slug:** `VIDEO_DB_ASK_COLLECTION`
>
> Queue a grounded question-answer request over a VideoDB collection's Search V2 indexes. This search-family call is metered and requires Search V2 indexes. The returned status only confirms the async request state, not a successful answer. Pass response\_id to GET\_ASYNC\_RESULT and inspect the terminal result.
>
> #### Input Parameters
>
> **mode** `string`
>
> Optional provider-supported answer mode; omit to use the provider default.
>
> **top\_k** `integer`
>
> Maximum supporting matches to consider (1-100). Defaults to 15.
>
> **question** `string` *required*
>
> Question to answer from indexed media.
>
> **collection\_id** `string` *required*
>
> Collection whose indexed media should ground the answer.
>
> **include\_sources** `boolean`
>
> Whether the eventual answer should include supporting source shots. Defaults to false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Collection
>
> **Slug:** `VIDEO_DB_CREATE_COLLECTION`
>
> Create a VideoDB collection for organizing and searching media. Collections are private by default.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Human-readable collection name.
>
> **is\_public** `boolean`
>
> Whether the collection should be public. Defaults to false for safety.
>
> **description** `string`
>
> Optional purpose or contents of the collection.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Async Result
>
> **Slug:** `VIDEO_DB_GET_ASYNC_RESULT`
>
> Check one VideoDB async operation by response ID. Returns its current state or terminal provider result without polling repeatedly, and fails when a completed nested provider response reports success:false.
>
> #### Input Parameters
>
> **response\_id** `string` *required*
>
> Response ID returned by INGEST\_MEDIA or ASK\_COLLECTION.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Collection
>
> **Slug:** `VIDEO_DB_GET_COLLECTION`
>
> Get metadata for one VideoDB collection by ID.
>
> #### Input Parameters
>
> **collection\_id** `string` *required*
>
> Collection ID returned by LIST\_COLLECTIONS or CREATE\_COLLECTION.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Media
>
> **Slug:** `VIDEO_DB_GET_MEDIA`
>
> Get metadata for one VideoDB video, audio file, or image.
>
> #### Input Parameters
>
> **media\_id** `string` *required*
>
> Video, audio, or image ID returned by ingestion or LIST\_MEDIA.
>
> **media\_type** `string ("video" | "audio" | "image")` *required*
>
> Kind of media to retrieve: video, audio, or image.
>
> **collection\_id** `string`
>
> Collection ID when known; used as optional access context for the provider read endpoint.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Ingest Media
>
> **Slug:** `VIDEO_DB_INGEST_MEDIA`
>
> Ingest a video, audio file, or image from an HTTP(S) URL into a VideoDB collection; ingestion may complete synchronously or return an async response ID. This non-idempotent call is metered, so verify an ambiguous prior job before retrying to avoid duplicate charges.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Publicly reachable HTTP(S) URL of the media to ingest.
>
> **name** `string`
>
> Optional display name for the ingested media.
>
> **media\_type** `string ("video" | "audio" | "image")` *required*
>
> Kind of media at the URL. Sent as video, audio, or image.
>
> **callback\_url** `string`
>
> Optional HTTP(S) callback URL for provider completion notifications.
>
> **collection\_id** `string` *required*
>
> Destination collection ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Collections
>
> **Slug:** `VIDEO_DB_LIST_COLLECTIONS`
>
> List collections available to the connected VideoDB API key and identify the default collection.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Media
>
> **Slug:** `VIDEO_DB_LIST_MEDIA`
>
> List videos, audio files, or images in one VideoDB collection using one normalized media interface. Video results return at most one page and may include an opaque continuation cursor.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum videos in this page (1-100). Ignored for audio and images, whose list endpoints are unpaginated.
>
> **media\_type** `string ("video" | "audio" | "image")` *required*
>
> Media family to list: video, audio, or image.
>
> **next\_cursor** `string`
>
> Opaque continuation returned by a previous video listing. Omit on the first call; audio and image listings do not use it.
>
> **collection\_id** `string` *required*
>
> Collection whose media should be listed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Rename Media
>
> **Slug:** `VIDEO_DB_RENAME_MEDIA`
>
> Rename one VideoDB video, audio file, or image.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> New media name.
>
> **media\_id** `string` *required*
>
> Video, audio, or image ID.
>
> **media\_type** `string ("video" | "audio" | "image")` *required*
>
> Kind of media to rename: video, audio, or image.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Collection
>
> **Slug:** `VIDEO_DB_SEARCH_COLLECTION`
>
> Run synchronous semantic search over indexed media in a VideoDB collection. This metered call consumed 0.0015 credits per successful call during live Free\_v1 probing, including calls that returned empty fallback results.
>
> #### Input Parameters
>
> **query** `string` *required*
>
> Natural-language semantic search query.
>
> **top\_k** `integer`
>
> Maximum nearest matches to return (1-100).
>
> **filter** `string`
>
> Optional structured filter over fields or vector metadata supported by the selected indexes, supplied as a JSON object or array. Omit unless you know the selected index's filterable metadata schema.
>
> **index\_ids** `array`
>
> Optional index IDs to search.
>
> **index\_names** `array`
>
> Optional index names to search.
>
> **collection\_id** `string` *required*
>
> Collection to search.
>
> **return\_fields** `array`
>
> Optional index names to hydrate under each result's metadata.indexes object, such as \['scene'].
>
> **score\_threshold** `number`
>
> Optional minimum similarity score.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Collection
>
> **Slug:** `VIDEO_DB_UPDATE_COLLECTION`
>
> Update the name, description, or visibility of an existing VideoDB collection.
>
> #### Input Parameters
>
> **name** `string`
>
> New collection name.
>
> **is\_public** `boolean`
>
> New public visibility setting.
>
> **description** `string`
>
> New collection description.
>
> **collection\_id** `string` *required*
>
> Collection ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
