twelvelabs-js 1.1.0 → 1.2.0

package/Client.d.ts

@@ -9,7 +9,6 @@ import { Indexes } from "./api/resources/indexes/client/Client";
 import { Assets } from "./api/resources/assets/client/Client";
 import { MultipartUpload } from "./api/resources/multipartUpload/client/Client";
 import { EntityCollections } from "./api/resources/entityCollections/client/Client";
-import { ManageEntities } from "./api/resources/manageEntities/client/Client";
 import { Embed } from "./api/resources/embed/client/Client";
 import { Search } from "./api/resources/search/client/Client";
 export declare namespace TwelvelabsApiClient {
@@ -17,7 +16,7 @@ export declare namespace TwelvelabsApiClient {
         environment?: core.Supplier<environments.TwelvelabsApiEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey?: core.Supplier<string | undefined>;
+        apiKey: core.Supplier<string>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -37,19 +36,22 @@ export declare class TwelvelabsApiClient {
     protected _assets: Assets | undefined;
     protected _multipartUpload: MultipartUpload | undefined;
     protected _entityCollections: EntityCollections | undefined;
-    protected _manageEntities: ManageEntities | undefined;
     protected _embed: Embed | undefined;
     protected _search: Search | undefined;
-    constructor(_options?: TwelvelabsApiClient.Options);
+    constructor(_options: TwelvelabsApiClient.Options);
     get tasks(): Tasks;
     get indexes(): Indexes;
     get assets(): Assets;
     get multipartUpload(): MultipartUpload;
     get entityCollections(): EntityCollections;
-    get manageEntities(): ManageEntities;
     get embed(): Embed;
     get search(): Search;
     /**
+     *
+     * <Note title="Deprecation notice">
+     *   This endpoint will be sunset and removed. Use the [`POST`](/v1.3/api-reference/analyze-videos/analyze) method of the `/analyze` endpoint. Pass the [`response_format`](/v1.3/api-reference/analyze-videos/analyze#request.body.response_format) parameter to specify the format of the response as structured JSON. For migration instructions, see the [Release notes](/v1.3/docs/get-started/release-notes#predefined-formats-for-video-analysis-will-be-sunset-and-removed) page.
+     * </Note>
+     *
      * This endpoint analyzes videos and generates summaries, chapters, or highlights. Optionally, you can provide a prompt to customize the output.
      *
      * <Note title="Note">
@@ -73,12 +75,12 @@ export declare class TwelvelabsApiClient {
     summarize(request: TwelvelabsApi.SummarizeRequest, requestOptions?: TwelvelabsApiClient.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.SummarizeResponse>;
     private __summarize;
     /**
-     * This endpoint analyzes videos and generates titles, topics, and hashtags.
-     *
-     * <Note title="Note">
-     * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
+     * <Note title="Deprecation notice">
+     *   This endpoint will be sunset and removed on February 15, 2026. Instead, use the [`POST`](/v1.3/api-reference/analyze-videos/analyze) method of the `/analyze` endpoint, passing the [`response_format`](/v1.3/api-reference/analyze-videos/analyze#request.body.response_format) parameter to specify the format of the response as structured JSON. For migration instructions, see the [Release notes](/v1.3/docs/get-started/release-notes#predefined-formats-for-video-analysis-will-be-sunset-and-removed) page.
      * </Note>
      *
+     * This method analyzes videos and generates titles, topics, and hashtags.
+     *
      * @param {TwelvelabsApi.GistRequest} request
      * @param {TwelvelabsApiClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -93,41 +95,12 @@ export declare class TwelvelabsApiClient {
      */
     gist(request: TwelvelabsApi.GistRequest, requestOptions?: TwelvelabsApiClient.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.Gist>;
     private __gist;
-    /**
-     * <Warning>
-     * This endpoint is deprecated. Use the [`/analyze`](/v1.3/api-reference/analyze-videos/analyze) endpoint instead, which provides identical functionality.
-     * </Warning>
-     *
-     *
-     * This endpoint generates open-ended texts based on your videos, including but not limited to tables of content, action items, memos, and detailed analyses.
-     *
-     * <Note title="Notes">
-     * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
-     * - This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Open-ended analysis](/v1.3/docs/guides/analyze-videos/open-ended-analysis#streaming-responses) guide.
-     * </Note>
-     *
-     * @param {TwelvelabsApi.GenerateRequest} request
-     * @param {TwelvelabsApiClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link TwelvelabsApi.BadRequestError}
-     * @throws {@link TwelvelabsApi.TooManyRequestsError}
-     *
-     * @example
-     *     await client.generate({
-     *         videoId: "6298d673f1090f1100476d4c",
-     *         prompt: "I want to generate a description for my video with the following format - Title of the video, followed by a summary in 2-3 sentences, highlighting the main topic, key events, and concluding remarks.",
-     *         temperature: 0.2,
-     *         stream: true
-     *     })
-     */
-    generate(request: TwelvelabsApi.GenerateRequest, requestOptions?: TwelvelabsApiClient.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.GenerateResponse>;
-    private __generate;
     /**
      * This endpoint analyzes your videos and creates fully customizable text based on your prompts, including but not limited to tables of content, action items, memos, and detailed analyses.
      *
      * <Note title="Notes">
      * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
-     * - This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Open-ended analysis](/v1.3/docs/guides/analyze-videos/open-ended-analysis#streaming-responses).
+     * - This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Analyze videos](/v1.3/docs/guides/analyze-videos) page.
      * </Note>
      */
     analyzeStream(request: TwelvelabsApi.AnalyzeStreamRequest, requestOptions?: TwelvelabsApiClient.RequestOptions): core.HttpResponsePromise<core.Stream<TwelvelabsApi.StreamAnalyzeResponse>>;
@@ -137,7 +110,7 @@ export declare class TwelvelabsApiClient {
      *
      * <Note title="Notes">
      * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
-     * - This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Open-ended analysis](/v1.3/docs/guides/analyze-videos/open-ended-analysis#streaming-responses).
+     * - This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Analyze videos](/v1.3/docs/guides/analyze-videos) page.
      * </Note>
      *
      * @param {TwelvelabsApi.AnalyzeRequest} request
@@ -177,6 +150,6 @@ export declare class TwelvelabsApiClient {
     analyze(request: TwelvelabsApi.AnalyzeRequest, requestOptions?: TwelvelabsApiClient.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.NonStreamAnalyzeResponse>;
     private __analyze;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "x-api-key": string | undefined;
+        "x-api-key": string;
     }>;
 }

package/Client.js

@@ -60,11 +60,10 @@ const Client_2 = require("./api/resources/indexes/client/Client");
 const Client_3 = require("./api/resources/assets/client/Client");
 const Client_4 = require("./api/resources/multipartUpload/client/Client");
 const Client_5 = require("./api/resources/entityCollections/client/Client");
-const Client_6 = require("./api/resources/manageEntities/client/Client");
-const Client_7 = require("./api/resources/embed/client/Client");
-const Client_8 = require("./api/resources/search/client/Client");
+const Client_6 = require("./api/resources/embed/client/Client");
+const Client_7 = require("./api/resources/search/client/Client");
 class TwelvelabsApiClient {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     get tasks() {
@@ -87,19 +86,20 @@ class TwelvelabsApiClient {
         var _a;
         return ((_a = this._entityCollections) !== null && _a !== void 0 ? _a : (this._entityCollections = new Client_5.EntityCollections(this._options)));
     }
-    get manageEntities() {
-        var _a;
-        return ((_a = this._manageEntities) !== null && _a !== void 0 ? _a : (this._manageEntities = new Client_6.ManageEntities(this._options)));
-    }
     get embed() {
         var _a;
-        return ((_a = this._embed) !== null && _a !== void 0 ? _a : (this._embed = new Client_7.Embed(this._options)));
+        return ((_a = this._embed) !== null && _a !== void 0 ? _a : (this._embed = new Client_6.Embed(this._options)));
     }
     get search() {
         var _a;
-        return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new Client_8.Search(this._options)));
+        return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new Client_7.Search(this._options)));
     }
     /**
+     *
+     * <Note title="Deprecation notice">
+     *   This endpoint will be sunset and removed. Use the [`POST`](/v1.3/api-reference/analyze-videos/analyze) method of the `/analyze` endpoint. Pass the [`response_format`](/v1.3/api-reference/analyze-videos/analyze#request.body.response_format) parameter to specify the format of the response as structured JSON. For migration instructions, see the [Release notes](/v1.3/docs/get-started/release-notes#predefined-formats-for-video-analysis-will-be-sunset-and-removed) page.
+     * </Note>
+     *
      * This endpoint analyzes videos and generates summaries, chapters, or highlights. Optionally, you can provide a prompt to customize the output.
      *
      * <Note title="Note">
@@ -129,7 +129,7 @@ class TwelvelabsApiClient {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "summarize"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.1.0", "User-Agent": "twelvelabs-js/1.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.SummarizeRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -180,12 +180,12 @@ class TwelvelabsApiClient {
         });
     }
     /**
-     * This endpoint analyzes videos and generates titles, topics, and hashtags.
-     *
-     * <Note title="Note">
-     * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
+     * <Note title="Deprecation notice">
+     *   This endpoint will be sunset and removed on February 15, 2026. Instead, use the [`POST`](/v1.3/api-reference/analyze-videos/analyze) method of the `/analyze` endpoint, passing the [`response_format`](/v1.3/api-reference/analyze-videos/analyze#request.body.response_format) parameter to specify the format of the response as structured JSON. For migration instructions, see the [Release notes](/v1.3/docs/get-started/release-notes#predefined-formats-for-video-analysis-will-be-sunset-and-removed) page.
      * </Note>
      *
+     * This method analyzes videos and generates titles, topics, and hashtags.
+     *
      * @param {TwelvelabsApi.GistRequest} request
      * @param {TwelvelabsApiClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -207,7 +207,7 @@ class TwelvelabsApiClient {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "gist"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.1.0", "User-Agent": "twelvelabs-js/1.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.GistRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -257,98 +257,12 @@ class TwelvelabsApiClient {
             }
         });
     }
-    /**
-     * <Warning>
-     * This endpoint is deprecated. Use the [`/analyze`](/v1.3/api-reference/analyze-videos/analyze) endpoint instead, which provides identical functionality.
-     * </Warning>
-     *
-     *
-     * This endpoint generates open-ended texts based on your videos, including but not limited to tables of content, action items, memos, and detailed analyses.
-     *
-     * <Note title="Notes">
-     * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
-     * - This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Open-ended analysis](/v1.3/docs/guides/analyze-videos/open-ended-analysis#streaming-responses) guide.
-     * </Note>
-     *
-     * @param {TwelvelabsApi.GenerateRequest} request
-     * @param {TwelvelabsApiClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link TwelvelabsApi.BadRequestError}
-     * @throws {@link TwelvelabsApi.TooManyRequestsError}
-     *
-     * @example
-     *     await client.generate({
-     *         videoId: "6298d673f1090f1100476d4c",
-     *         prompt: "I want to generate a description for my video with the following format - Title of the video, followed by a summary in 2-3 sentences, highlighting the main topic, key events, and concluding remarks.",
-     *         temperature: 0.2,
-     *         stream: true
-     *     })
-     */
-    generate(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__generate(request, requestOptions));
-    }
-    __generate(request, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            const _response = yield core.fetcher({
-                url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "generate"),
-                method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.1.0", "User-Agent": "twelvelabs-js/1.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
-                contentType: "application/json",
-                requestType: "json",
-                body: serializers.GenerateRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-            });
-            if (_response.ok) {
-                return {
-                    data: serializers.GenerateResponse.parseOrThrow(_response.body, {
-                        unrecognizedObjectKeys: "passthrough",
-                        allowUnrecognizedUnionMembers: true,
-                        allowUnrecognizedEnumValues: true,
-                        breadcrumbsPrefix: ["response"],
-                    }),
-                    rawResponse: _response.rawResponse,
-                };
-            }
-            if (_response.error.reason === "status-code") {
-                switch (_response.error.statusCode) {
-                    case 400:
-                        throw new TwelvelabsApi.BadRequestError(_response.error.body, _response.rawResponse);
-                    case 429:
-                        throw new TwelvelabsApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
-                    default:
-                        throw new errors.TwelvelabsApiError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.body,
-                            rawResponse: _response.rawResponse,
-                        });
-                }
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.TwelvelabsApiError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                        rawResponse: _response.rawResponse,
-                    });
-                case "timeout":
-                    throw new errors.TwelvelabsApiTimeoutError("Timeout exceeded when calling POST /generate.");
-                case "unknown":
-                    throw new errors.TwelvelabsApiError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
-        });
-    }
     /**
      * This endpoint analyzes your videos and creates fully customizable text based on your prompts, including but not limited to tables of content, action items, memos, and detailed analyses.
      *
      * <Note title="Notes">
      * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
-     * - This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Open-ended analysis](/v1.3/docs/guides/analyze-videos/open-ended-analysis#streaming-responses).
+     * - This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Analyze videos](/v1.3/docs/guides/analyze-videos) page.
      * </Note>
      */
     analyzeStream(request, requestOptions) {
@@ -360,7 +274,7 @@ class TwelvelabsApiClient {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "analyze"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.1.0", "User-Agent": "twelvelabs-js/1.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: Object.assign(Object.assign({}, serializers.AnalyzeStreamRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" })), { stream: true }),
@@ -426,7 +340,7 @@ class TwelvelabsApiClient {
      *
      * <Note title="Notes">
      * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
-     * - This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Open-ended analysis](/v1.3/docs/guides/analyze-videos/open-ended-analysis#streaming-responses).
+     * - This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Analyze videos](/v1.3/docs/guides/analyze-videos) page.
      * </Note>
      *
      * @param {TwelvelabsApi.AnalyzeRequest} request
@@ -472,7 +386,7 @@ class TwelvelabsApiClient {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "analyze"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.1.0", "User-Agent": "twelvelabs-js/1.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: Object.assign(Object.assign({}, serializers.AnalyzeRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" })), { stream: false }),

package/api/client/requests/index.d.ts

@@ -1,5 +1,4 @@
 export { type SummarizeRequest } from "./SummarizeRequest";
 export { type GistRequest } from "./GistRequest";
-export { type GenerateRequest } from "./GenerateRequest";
 export { type AnalyzeStreamRequest } from "./AnalyzeStreamRequest";
 export { type AnalyzeRequest } from "./AnalyzeRequest";

package/api/resources/assets/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace Assets {
         environment?: core.Supplier<environments.TwelvelabsApiEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey?: core.Supplier<string | undefined>;
+        apiKey: core.Supplier<string>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -24,14 +24,11 @@ export declare namespace Assets {
 }
 export declare class Assets {
     protected readonly _options: Assets.Options;
-    constructor(_options?: Assets.Options);
+    constructor(_options: Assets.Options);
     /**
      * This method returns a list of assets in your account.
      *
-     * <Note title="Note">
-     * - The platform returns your assets sorted by creation date, with the newest at the top of the list.
-     * - The platform automatically deletes assets that are not associated with any entity after 72 hours.
-     * </Note>
+     * The platform returns your assets sorted by creation date, with the newest at the top of the list.
      *
      * @param {TwelvelabsApi.AssetsListRequest} request
      * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
@@ -46,7 +43,7 @@ export declare class Assets {
      */
     list(request?: TwelvelabsApi.AssetsListRequest, requestOptions?: Assets.RequestOptions): Promise<core.Page<TwelvelabsApi.Asset>>;
     /**
-     * This method creates an asset by uploading a file to the platform. Assets are files (such as images, audio, or video) that you can use in downstream workflows, including indexing, analyzing video content, and creating entities.
+     * This method creates an asset by uploading a file to the platform. Assets are media files that you can use in downstream workflows, including indexing, analyzing video content, and creating entities.
      *
      * **Supported content**: Video, audio, and images.
      *
@@ -62,6 +59,10 @@ export declare class Assets {
      * - **Entity search**: [Marengo image requirements](/v1.3/docs/concepts/models/marengo#image-file-requirements)
      * - **Create embeddings**: [Marengo requirements](/v1.3/docs/concepts/models/marengo#input-requirements)
      *
+     * <Note title="Note">
+     * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
+     * </Note>
+     *
      * @param {TwelvelabsApi.AssetsCreateRequest} request
      * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -101,6 +102,6 @@ export declare class Assets {
     delete(assetId: string, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "x-api-key": string | undefined;
+        "x-api-key": string;
     }>;
 }

package/api/resources/assets/client/Client.js

@@ -56,16 +56,13 @@ const serializers = __importStar(require("../../../../serialization/index"));
 const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors/index"));
 class Assets {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     /**
      * This method returns a list of assets in your account.
      *
-     * <Note title="Note">
-     * - The platform returns your assets sorted by creation date, with the newest at the top of the list.
-     * - The platform automatically deletes assets that are not associated with any entity after 72 hours.
-     * </Note>
+     * The platform returns your assets sorted by creation date, with the newest at the top of the list.
      *
      * @param {TwelvelabsApi.AssetsListRequest} request
      * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
@@ -111,7 +108,7 @@ class Assets {
                 const _response = yield core.fetcher({
                     url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "assets"),
                     method: "GET",
-                    headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.1.0", "User-Agent": "twelvelabs-js/1.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                    headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                     contentType: "application/json",
                     queryParameters: _queryParams,
                     requestType: "json",
@@ -173,7 +170,7 @@ class Assets {
         });
     }
     /**
-     * This method creates an asset by uploading a file to the platform. Assets are files (such as images, audio, or video) that you can use in downstream workflows, including indexing, analyzing video content, and creating entities.
+     * This method creates an asset by uploading a file to the platform. Assets are media files that you can use in downstream workflows, including indexing, analyzing video content, and creating entities.
      *
      * **Supported content**: Video, audio, and images.
      *
@@ -189,6 +186,10 @@ class Assets {
      * - **Entity search**: [Marengo image requirements](/v1.3/docs/concepts/models/marengo#image-file-requirements)
      * - **Create embeddings**: [Marengo requirements](/v1.3/docs/concepts/models/marengo#input-requirements)
      *
+     * <Note title="Note">
+     * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
+     * </Note>
+     *
      * @param {TwelvelabsApi.AssetsCreateRequest} request
      * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -220,7 +221,7 @@ class Assets {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "assets"),
                 method: "POST",
-                headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.1.0", "User-Agent": "twelvelabs-js/1.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 requestType: "file",
                 duplex: _maybeEncodedRequest.duplex,
                 body: _maybeEncodedRequest.body,
@@ -288,7 +289,7 @@ class Assets {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, `assets/${encodeURIComponent(assetId)}`),
                 method: "GET",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.1.0", "User-Agent": "twelvelabs-js/1.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -355,7 +356,7 @@ class Assets {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, `assets/${encodeURIComponent(assetId)}`),
                 method: "DELETE",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.1.0", "User-Agent": "twelvelabs-js/1.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/api/resources/assets/client/requests/AssetsCreateRequest.d.ts

@@ -16,9 +16,7 @@ export interface AssetsCreateRequest {
     /**
      * Specify this parameter to upload a file from a publicly accessible URL. This parameter is required when `method` is set to `url`.
      *
-     * <Note title="Note">
-     *   URL uploads are limited to 4GB.
-     * </Note>
+     * URL uploads have a maximum limit of 4GB.
      */
     url?: string;
     /** The optional filename of the asset. If not provided, the platform will determine the filename from the file or URL. */

package/api/resources/embed/client/Client.d.ts

@@ -11,7 +11,7 @@ export declare namespace Embed {
         environment?: core.Supplier<environments.TwelvelabsApiEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey?: core.Supplier<string | undefined>;
+        apiKey: core.Supplier<string>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -28,7 +28,7 @@ export declare class Embed {
     protected readonly _options: Embed.Options;
     protected _tasks: Tasks | undefined;
     protected _v2: V2 | undefined;
-    constructor(_options?: Embed.Options);
+    constructor(_options: Embed.Options);
     get tasks(): Tasks;
     get v2(): V2;
     /**
@@ -59,7 +59,8 @@ export declare class Embed {
      * <Note title="Notes">
      * - The Marengo video understanding model generates embeddings for all modalities in the same latent space. This shared space enables any-to-any searches across different types of content.
      * - You can create multiple types of embeddings in a single API call.
-     * - Audio embeddings combine generic sound and human speech in a single embedding. For videos with transcriptions, you can retrieve transcriptions and then [create text embeddings](/v1.3/api-reference/create-embeddings-v1/text-image-audio-embeddings/create-text-image-audio-embeddings) from these transcriptions.
+     * - Audio embeddings combine generic sound and human speech in a single embedding. For videos with transcriptions, you can retrieve transcriptions and then [create text embeddings](/v1.3/api-reference/create-embeddings-v1/text-image-audio-embeddings/create-text-image-audio-embeddings) from these
+     * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
      * </Note>
      *
      * @param {TwelvelabsApi.EmbedCreateRequest} request
@@ -75,6 +76,6 @@ export declare class Embed {
     create(request: TwelvelabsApi.EmbedCreateRequest, requestOptions?: Embed.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.EmbeddingResponse>;
     private __create;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "x-api-key": string | undefined;
+        "x-api-key": string;
     }>;
 }

package/api/resources/embed/client/Client.js

@@ -58,7 +58,7 @@ const errors = __importStar(require("../../../../errors/index"));
 const Client_1 = require("../resources/tasks/client/Client");
 const Client_2 = require("../resources/v2/client/Client");
 class Embed {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     get tasks() {
@@ -97,7 +97,8 @@ class Embed {
      * <Note title="Notes">
      * - The Marengo video understanding model generates embeddings for all modalities in the same latent space. This shared space enables any-to-any searches across different types of content.
      * - You can create multiple types of embeddings in a single API call.
-     * - Audio embeddings combine generic sound and human speech in a single embedding. For videos with transcriptions, you can retrieve transcriptions and then [create text embeddings](/v1.3/api-reference/create-embeddings-v1/text-image-audio-embeddings/create-text-image-audio-embeddings) from these transcriptions.
+     * - Audio embeddings combine generic sound and human speech in a single embedding. For videos with transcriptions, you can retrieve transcriptions and then [create text embeddings](/v1.3/api-reference/create-embeddings-v1/text-image-audio-embeddings/create-text-image-audio-embeddings) from these
+     * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
      * </Note>
      *
      * @param {TwelvelabsApi.EmbedCreateRequest} request
@@ -143,7 +144,7 @@ class Embed {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "embed"),
                 method: "POST",
-                headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.1.0", "User-Agent": "twelvelabs-js/1.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 requestType: "file",
                 duplex: _maybeEncodedRequest.duplex,
                 body: _maybeEncodedRequest.body,

package/api/resources/embed/resources/tasks/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace Tasks {
         environment?: core.Supplier<environments.TwelvelabsApiEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey?: core.Supplier<string | undefined>;
+        apiKey: core.Supplier<string>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -24,7 +24,7 @@ export declare namespace Tasks {
 }
 export declare class Tasks {
     protected readonly _options: Tasks.Options;
-    constructor(_options?: Tasks.Options);
+    constructor(_options: Tasks.Options);
     /**
      * <Note title="Note">
      *   This method will be deprecated in a future version. Migrate to the [Embed API v2](/v1.3/api-reference/create-embeddings-v2) for continued support and access to new features.
@@ -59,13 +59,17 @@ export declare class Tasks {
      *
      * This method creates a new video embedding task that uploads a video to the platform and creates one or multiple video embeddings.
      *
+     * <Note title="Note">
+     * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
+     * </Note>
+     *
      * Upload options:
      * - **Local file**: Use the `video_file` parameter
      * - **Publicly accessible URL**: Use the `video_url` parameter.
      *
      * Specify at least one option. If both are provided, `video_url` takes precedence.
      *
-     * Your video files must meet the [format requirements](/v1.3/docs/concepts/models/marengo#video-file-requirements).
+     * Your video files must meet the [requirements](/v1.3/docs/concepts/models/marengo#video-file-requirements).
      * This endpoint allows you to upload files up to 2 GB in size.  To upload larger files, use the [Multipart Upload API](/v1.3/api-reference/upload-content/multipart-uploads)
      *
      * <Note title="Notes">
@@ -121,6 +125,6 @@ export declare class Tasks {
     retrieve(taskId: string, request?: TwelvelabsApi.embed.TasksRetrieveRequest, requestOptions?: Tasks.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.embed.TasksRetrieveResponse>;
     private __retrieve;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "x-api-key": string | undefined;
+        "x-api-key": string;
     }>;
 }