API Reference
SDKsSample appsIntegrationsDiscordPlayground

Typical workflows

This page provides an overview of common workflows for using the Twelve Labs JavaScript SDK. Each workflow consists of a series of steps, with links to detailed documentation for each step.

All workflows involving uploading video content to the platform require asynchronous processing. You must wait for the video processing to complete before proceeding with the subsequent steps.

Prerequisites

Ensure that the following prerequisites are met before using the JavaScript SDK:

  • Node.js 14 or newer must be installed on your machine.
  • You have an API key. If you don't have an account, please sign up for a free account. Then, to retrieve your API key, go to the API Key page, and select the Copy icon to the right of the key to copy it to your clipboard.

Install the SDK

Install the twelvelabs-js package:

yarn add twelvelabs-js # or npm i twelvelabs-js

Initialize the SDK

  1. Import the required packages:
import { TwelveLabs } from 'twelvelabs-js';
  1. Instantiate the SDK client with your API key.:
const client = new TwelveLabs({ apiKey: '<YOUR_API_KEY>' });

Search

Follow the steps in this section to search through your video content and find specific moments, scenes, or information.

Steps:

  1. Create an index, enabling the Marengo video understanding engine.
  2. Upload videos and monitor the processing.
  3. Perform a search request, using text or images as queries.

Notes:

  • The search scope is an individual index.
  • Results support pagination, filtering, sorting, and grouping.

Classify

Follow the steps in this section to organize your videos into manageable and useful categories, making them easier to find, access, and use.

Steps:

  1. Create an index, enabling the Marengo video understanding engine.
  2. Upload videos and monitor the processing.
  3. Classify a set of videos or all the videos within an index.

Notes:

  • Results support filtering and pagination.

Create text embeddings

This workflow guides you through creating embeddings for text.

Steps:

  1. Create text embeddings

Notes:

  • Creating text embeddings is a synchronous process.

Create video embeddings

This workflow guides you through creating embeddings for videos..

Steps:

  1. Upload a video and monitor the processing.
  2. Retrieve the embeddings.

Generate text from videos

Follow the steps in this section to generate texts based on your videos.

Steps:

  1. Create an index, enabling the Pegasus video understanding engine.
  2. Upload videos and monitor the processing.
  3. Depending on your use case, generate one of the following:

Note:

  • When generating open-ended texts, the platform supports streaming responses.

Extract video data

Follow the steps in this guide to extract various types of data from your videos, such as transcriptions, on-screen text, logos, and thumbnails.

Steps:

  1. Create an index, enabling the Marengo video understanding engine.
  2. Upload videos and monitor the processing.
  3. Depending on your use case: