For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sample appsIntegrationsDiscordPlaygroundDevEx repo
GuidesSDK ReferenceAPI Reference
GuidesSDK ReferenceAPI Reference
  • Python SDK
    • The TwelveLabs class
    • Manage indexes
    • Upload content
    • Index content
    • Manage videos
    • Manage entities
    • Search
    • Create embeddings v2
    • Create embeddings v1
    • Analyze and segment videos
  • Node.js SDK
    • The TwelveLabs class
    • Manage indexes
    • Upload content
    • Index content
    • Manage videos
    • Manage entities
    • Search
    • Create embeddings v2
    • Create embeddings v1
    • Analyze and segment videos
LogoLogo
Sample appsIntegrationsDiscordPlaygroundDevEx repo
On this page
  • Methods
  • The constructor
  • Parameters
  • Return value
Node.js SDK

The TwelveLabs class

Was this page helpful?
Previous

Manage indexes

Next
Built with

The TwelveLabs class is the main entry point for the SDK. It initializes the client and provides access to all the resources.

Methods

The constructor

Description: The constructor creates a new instance of the TwelveLabs class.

Function signature and example:

1constructor({ apiKey, timeoutInSeconds }: {
2 apiKey?: string;
3 timeoutInSeconds?: number;
4});

Parameters

NameTypeRequiredDescription
apiKeystringNoYour TwelveLabs API key. If not provided, the TWELVE_LABS_API_KEY environment variable will be used.
timeoutInSecondsnumberNoRequest timeout in seconds. Defaults to 600. For long-running endpoints (embed or analyze with large inputs), pass a higher value. For fast-fail behavior, pass a lower value, or override per call by passing { timeoutInSeconds: N } as the second argument to any SDK method.

Return value

Implicitly returns the newly created instance.