Skip to main content
VideoDB logo
  • Category: video & audio
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 11
  • Triggers: 0
  • Slug: VIDEO_DB
  • Version: 20261101_00

Tools

Slug: VIDEO_DB_ASK_COLLECTIONQueue 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

string
Optional provider-supported answer mode; omit to use the provider default.
integer
Maximum supporting matches to consider (1-100). Defaults to 15.
string
required
Question to answer from indexed media.
string
required
Collection whose indexed media should ground the answer.
boolean
Whether the eventual answer should include supporting source shots. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VIDEO_DB_CREATE_COLLECTIONCreate a VideoDB collection for organizing and searching media. Collections are private by default.

Input Parameters

string
required
Human-readable collection name.
boolean
Whether the collection should be public. Defaults to false for safety.
string
Optional purpose or contents of the collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VIDEO_DB_GET_ASYNC_RESULTCheck 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

string
required
Response ID returned by INGEST_MEDIA or ASK_COLLECTION.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VIDEO_DB_GET_COLLECTIONGet metadata for one VideoDB collection by ID.

Input Parameters

string
required
Collection ID returned by LIST_COLLECTIONS or CREATE_COLLECTION.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VIDEO_DB_GET_MEDIAGet metadata for one VideoDB video, audio file, or image.

Input Parameters

string
required
Video, audio, or image ID returned by ingestion or LIST_MEDIA.
string ("video" | "audio" | "image")
required
Kind of media to retrieve: video, audio, or image.
string
Collection ID when known; used as optional access context for the provider read endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VIDEO_DB_INGEST_MEDIAIngest 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

string
required
Publicly reachable HTTP(S) URL of the media to ingest.
string
Optional display name for the ingested media.
string ("video" | "audio" | "image")
required
Kind of media at the URL. Sent as video, audio, or image.
string
Optional HTTP(S) callback URL for provider completion notifications.
string
required
Destination collection ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VIDEO_DB_LIST_COLLECTIONSList collections available to the connected VideoDB API key and identify the default collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VIDEO_DB_LIST_MEDIAList 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

integer
Maximum videos in this page (1-100). Ignored for audio and images, whose list endpoints are unpaginated.
string ("video" | "audio" | "image")
required
Media family to list: video, audio, or image.
string
Opaque continuation returned by a previous video listing. Omit on the first call; audio and image listings do not use it.
string
required
Collection whose media should be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VIDEO_DB_RENAME_MEDIARename one VideoDB video, audio file, or image.

Input Parameters

string
required
New media name.
string
required
Video, audio, or image ID.
string ("video" | "audio" | "image")
required
Kind of media to rename: video, audio, or image.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VIDEO_DB_SEARCH_COLLECTIONRun 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

string
required
Natural-language semantic search query.
integer
Maximum nearest matches to return (1-100).
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.
array
Optional index IDs to search.
array
Optional index names to search.
string
required
Collection to search.
array
Optional index names to hydrate under each result’s metadata.indexes object, such as [‘scene’].
number
Optional minimum similarity score.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VIDEO_DB_UPDATE_COLLECTIONUpdate the name, description, or visibility of an existing VideoDB collection.

Input Parameters

string
New collection name.
boolean
New public visibility setting.
string
New collection description.
string
required
Collection ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not