VideoDB icon

VideoDB

Interact with the VideoDB API
Join our community

Actions37

Overview

The node integrates with the VideoDB API to perform various video-related operations. Specifically, the "Index Scenes" operation allows users to create scene indexes for a given video within a collection. This involves extracting scenes based on either shot changes or fixed time intervals, optionally guided by prompts and configurable models.

This node is beneficial in scenarios where automated video analysis is needed, such as:

  • Creating searchable scene indexes for large video libraries.
  • Enhancing video metadata with scene segmentation.
  • Preparing videos for further AI-based processing or content summarization.

For example, a user can select a video from their collection, specify the extraction method (shot-based or time-based), provide custom configuration and prompts, and receive a structured index of scenes that can be used for navigation or further analysis.

Properties

Name Meaning
Collection Name or ID Select or specify the collection containing the video to be indexed.
Video Name or ID Select or specify the video within the chosen collection to index scenes for.
Name Optional name to assign to the created scene index.
Extraction Type Method for scene extraction: "Shot Based" (detects scene changes) or "Time Based" (fixed intervals).
Extraction Config (JSON) JSON configuration object to customize the scene extraction process.
Prompt Text prompt to guide the indexing process, potentially influencing model behavior.
Model Name Name of the model to use for indexing scenes.
Model Config (JSON) JSON configuration object to customize the model's parameters.
Scenes (JSON) JSON list of scenes to be indexed, allowing manual specification or overrides.
Callback URL URL to be called upon completion of the indexing process, useful for asynchronous workflows.

Output

The node outputs a JSON object representing the response from the VideoDB API after performing the scene indexing operation. This typically includes details about the created scene index, such as scene boundaries, timestamps, and any metadata returned by the API.

If the API supports binary data output (not indicated here), it would represent media or related files, but this node primarily deals with JSON responses describing scene indexes.

Dependencies

  • Requires an API key credential for authenticating with the VideoDB API.
  • The base URL for the API defaults to https://api.videodb.io but can be customized via credentials.
  • The node uses HTTP requests authenticated with the provided API key.
  • No other external dependencies are indicated.

Troubleshooting

  • Missing or invalid API key: Ensure the API key credential is correctly configured; otherwise, authentication will fail.
  • Invalid collection or video ID: Selecting or specifying non-existent IDs will cause errors; use the dropdown options or verify IDs manually.
  • Malformed JSON in config fields: The extraction and model config properties expect valid JSON; invalid JSON will cause parsing errors.
  • Callback URL issues: If using a callback URL, ensure it is reachable and correctly handles incoming requests.
  • API rate limits or downtime: Network or API service issues may cause request failures; check connectivity and API status.

Common error messages usually relate to authentication failures, invalid parameters, or network errors. Reviewing the input parameters and API credentials typically resolves these.

Links and References

Discussion