twelvelabs

What it is and what it does

The TwelveLabs SDK is a Python client library that wraps the TwelveLabs video understanding platform's HTTP API, reducing boilerplate code for common workflows. It provides object-oriented interfaces for creating video indexes, uploading video assets (from URLs or local files), monitoring processing status, and querying videos using natural language text or image-based search across visual and audio modalities.

The SDK is built on httpx for HTTP communication and pydantic for data validation, supporting Python 3.8 through 3.12. Typical workflows involve creating an index configured with specific AI models (such as Marengo for search or Pegasus for text generation), uploading videos, waiting for indexing to complete asynchronously, and then performing downstream tasks like semantic video search or content analysis. The platform handles video understanding internally; the SDK's role is to orchestrate these operations and parse results.

Use it for:

• Build a video search engine that finds clips matching natural language queries across a library of indexed videos.
• Automate video ingestion and indexing workflows by uploading files and monitoring processing status programmatically.
• Generate text summaries or descriptions of video content by indexing with the Pegasus model and calling analysis endpoints.
• Integrate video understanding into a larger application (e.g., a content management or discovery platform) without writing raw HTTP calls.
• Search video archives by visual content (objects, scenes) or audio (spoken words, sounds) using multimodal queries.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Python SDK for the TwelveLabs video understanding platform, providing methods to create indexes, upload videos, and perform search and analysis tasks on video content.

Yes, if you are building on the TwelveLabs platform and want to avoid writing raw HTTP boilerplate. The SDK is actively maintained, has low install friction, and supports current Python versions. However, verify the license terms first—they are not declared in the package metadata. Also confirm that the free tier API key and rate limits suit your use case, as the SDK is a client library and all video processing happens on TwelveLabs' servers.

Install

twelvelabs on PyPI

pip install twelvelabs

uv add twelvelabs

poetry add twelvelabs

Installing twelvelabs

Before you install

Low install friction with pure-Python wheels and a small dependency footprint (httpx, pydantic, and typing utilities). Active maintenance as of 22 days ago.

License in practice

License treatment is unclear; no SPDX identifier or raw license text is available in the package metadata. Verify the actual license terms before use in proprietary or copyleft-sensitive projects.

Quickstart

pip install twelvelabs

from twelvelabs import TwelveLabs

client = TwelveLabs(api_key="<YOUR_API_KEY>")
index = client.indexes.create(
    index_name="my_index",
    models=[{"model_name": "marengo3.0", "model_options": ["visual", "audio"]}]
)
print(f"Created index: id={index.id}")

Requires a TwelveLabs API key and account (free tier available); Python 3.8 or newer.

Verify before relying

• Whether the license is open-source, proprietary, or dual-licensed (metadata is unclear).
• Actual API rate limits and pricing tier constraints for the free account tier.
• Whether video files larger than 4 GB are supported despite the guide mentioning 4 GB as a limit for the guide only.

Package facts

Evidence: twelvelabs-1.3.1-py3-none-any.whl

Tags

More Python Modules packages