Titles, topics, and hashtags
This guide shows how you can generate the following types of text:
- Titles are brief phrases that capture the main idea of a video, making it easy to understand and categorize.
- Topics identify the central themes of the video for effective categorization.
- Hashtags are keywords that summarize a video, enhancing its searchability on social media.
You can generate one or more types of text in a single API call.
Prerequisites
-
To use the platform, you need an API key:
-
Ensure the TwelveLabs SDK is installed on your computer:
-
The videos you wish to use must meet the following requirements:
- Video resolution: Must be at least 360x360 and must not exceed 3840x2160.
- Aspect ratio: Must be one of 1:1, 4:3, 4:5, 5:4, 16:9, or 9:16.
- Video and audio formats: Your video files must be encoded in the video and audio formats listed on the FFmpeg Formats Documentation page. For videos in other formats, contact us at support@twelvelabs.io.
- Duration: Must be between 4 seconds and 60 minutes (3600s). In a future release, the maximum duration will be 2 hours (7,200 seconds).
- File size: Must not exceed 2 GB.
If you require different options, contact us at support@twelvelabs.io.
Complete example
This complete example shows how to create an index, upload a video, and generate a title, topics and hashtags. Ensure you replace the placeholders surrounded by <>
with your values.
Step-by-step guide
Python
Node.js
Import the SDK and initialize the client
Create a client instance to interact with the TwelveLabs Video Understanding platform.
Function call: You call the constructor of the TwelveLabs
class.
Parameters:
api_key
: The API key to authenticate your requests to the platform.
Return value: An object of type TwelveLabs
configured for making API calls.
Specify the index containing your videos
Indexes help you organize and search through related videos efficiently. This example creates a new index, but you can also use an existing index by specifying its unique identifier. See the Indexes page for more details on creating an index.
Function call: You call the index.create
function.
Parameters:
name
: The name of the index.models
: An object specifying your model configuration. This example enables the Pegasus video understanding model and thevisual
andaudio
model options.
Return value: An object containing, among other information, a field named id
representing the unique identifier of the newly created index.
Upload videos
To perform any downstream tasks, you must first upload your videos, and the platform must finish processing them.
Function call: You call the task.create
function. This starts a video indexing task, which is an object of type Task
that tracks the status of your video upload and indexing process.
Parameters:
index_id
: The unique identifier of your index.file
orurl
: The path or the publicly accessible URL of your video file.
Return value: An object of type Task
containing, among other information, the following fields:
video_id
: The unique identifier of your videostatus
: The status of your video indexing task.
Note
You can also upload multiple videos in a single API call. For details, see the Cloud-to-cloud integrations page.
Monitor the indexing process
The platform requires some time to index videos. Check the status of the video indexing task until it’s completed.
Function call: You call the task.wait_for_done
function.
Parameters:
sleep_interval
: The time interval, in seconds, between successive status checks. In this example, the method checks the status every five seconds.callback
: A callback function that the SDK executes each time it checks the status. Note that the callback function takes a parameter of typeTask
representig the video indexing task you’ve created in the previous step. Use it to display the status of your video indexing task.
Return value: An object containing, among other information, a field named status
representing the status of your task. Wait until the value of this field is ready
.
Generate titles, topics, and hashtags
Function call: You call the generate.gist
method.
Parameters:
video_id
: The unique identifier of the video for which you want to generate text.types
: An array of strings representing the types of text you want to generate. It can take one or more of the following values:["title", "topic", "hashtag"]
.
Return value: An object containing, among other information, one or more of the following fields of type string:title
,topics
,hashtags
.