The TwelveLabs class is the main entry point for the SDK. It initializes the client and provides access to resources for uploading videos, managing indexes, performing searches, creating embeddings, and analyzing videos.

Methods

The initializer

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

Function signature and example:

1 def __init__(
2     self,
3     *,
4     api_key: typing.Optional[str] = None,
5     **kwargs,
6 )

Parameters

Name	Type	Required	Description
`api_key`	`typing.Optional[str]`	Yes	Your TwelveLabs API key. If not provided, the `TWELVE_LABS_API_KEY` environment variable will be used.
`**kwargs`	`dict`	No	Additional parameters to pass to the base client. You can pass a variable named `timeout` of type `float` to set the request timeout in seconds. The default timeout is 600 seconds, unless you use a custom `httpx` client. 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 via `request_options={"timeout_in_seconds": N}`.

Return value

None. This method initializes the instance.

Request options

Every method accepts an optional request_options argument for per-call configuration. Pass it as a keyword argument:

1 client.knowledge_stores.list(
2     request_options={"timeout_in_seconds": 30},
3 )

The request_options argument accepts the following fields:

Name	Type	Description
`timeout_in_seconds`	`int`	The request timeout, in seconds, for this call. Overrides the client’s default timeout of 600 seconds. For long-running endpoints (`embed` or `analyze` with large inputs), pass a higher value. For fast-fail behavior, pass a lower value.
`max_retries`	`int`	The maximum number of retries to attempt if the API call fails.
`additional_headers`	`Dict[str, Any]`	Additional headers to include in the request.
`additional_query_parameters`	`Dict[str, Any]`	Additional query parameters to include in the request.
`additional_body_parameters`	`Dict[str, Any]`	Additional body parameters to include in the request.