Search
This quickstart guide provides a simplified introduction to searching video content using the TwelveLabs Video Understanding Platform. It includes:
- A basic working example
- Minimal implementation details
- Core parameters for common use cases
For a comprehensive guide, see the Search page.
Prerequisites
-
To use the platform, you need an API key:
-
Depending on the programming language you are using, install the TwelveLabs SDK by entering one of the following commands:
-
Your video files must meet the format requirements.
Starter code
Copy and paste the code below to make a search request, replacing the placeholders surrounded by <> with your values.
Step-by-step guide
Import the SDK and initialize the client
Create a client instance to interact with the TwelveLabs Video Understanding Platform.
Create an index
Indexes store and organize your video data, allowing you to group related videos. Create one before uploading videos. See the Indexes page for more details.
Upload videos
To perform any downstream tasks, you must first upload your videos, and the platform must finish indexing them.
Monitor the indexing process
The platform requires some time to index videos. Check the status of the video indexing task until it’s completed.