This quickstart guide provides a simplified introduction to generating text from video 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 Generate text from video section.

Prerequisites

• To use the platform, you need an API key:

  1

  If you don’t have an account, sign up for a free account.

  2

  Go to the API Key page.

  3

  Select the Copy icon next to your key.

• Ensure the TwelveLabs SDK is installed on your computer:

  PythonNode.js

  $
  pip install twelvelabs

• 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.

Starter code

You can copy and paste the code below to generate text from video. Replace the placeholders surrounded by <> with your values.

1
from twelvelabs import TwelveLabs
2
3
client = TwelveLabs(api_key="<YOUR_API_KEY>")
4
5
index = client.index.create(name="<YOUR_INDEX_NAME>", models=[{"name": "pegasus1.2", "options": ["visual", "audio"]}])
6
print(f"Created index: id={index.id} name={index.name}")
7
8
task = client.task.create(index_id=index.id, url="<YOUR_VIDEO_URL>")
9
print(f"Created task: id={task.id}")
10
task.wait_for_done(sleep_interval=50, callback=lambda t: print(f"  Status={t.status}"))
11
if task.status != "ready":
12
    raise RuntimeError(f"Indexing failed with status {task.status}")
13
print(f"Upload complete. The unique identifier of your video is {task.video_id}.")
14
15
gist = client.generate.gist(video_id=task.video_id,types=["title", "topic", "hashtag"])
16
print(f"Title={gist.title}\nTopics={gist.topics}\nHashtags={gist.hashtags}")

Step-by-step guide