API Reference
SDKsSample appsIntegrationsDiscordPlayground

Node.js SDK

📣

Important

The 1.3 version of the API includes significant improvements but also introduces breaking changes. If you are using v1.2, refer to the Migration guide page for a detailed list of changes, migration instructions, and code examples.

The Twelve Labs JavaScript SDK provides a robust interface for interacting with the Twelve Labs Video Understanding Platform. It simplifies authentication and efficiently processes asynchronous tasks.

📘

Notes:

  • This section provides an overview of the key methods and their usage. However, it is a partial list of all available methods and fields in the SDK.
  • The SDK is designed to closely follow the structure of the Twelve Labs API. In most cases, you'll find a corresponding method in the SDK for each method in the API.
  • The documentation uses params as a generic name for the first parameter of methods that accept multiple properties in an object.
  • While the API uses snake case for function and parameter names, the JavaScript SDK adopts camel case. For example, an API parameter like video_id is videoId in the SDK.

Sample applications

To get started quickly, see the sample applications below that demonstrate the capabilities of the Twelve Labs JavaScript SDK. These applications show how to implement common use cases and the best practices for using the SDK.