twelvelabs-js 1.2.2 → 1.2.3

package/Client.d.ts

@@ -67,6 +67,7 @@ export declare class TwelvelabsApiClient {
      *
      * **Do not use this method for**:
      * - Videos longer than 1 hour. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
+     * - Video segmentation. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with `model_name` set to `pegasus1.5` instead.
      *
      * <Note title="Notes">
      * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
@@ -92,6 +93,7 @@ export declare class TwelvelabsApiClient {
      *
      * **Do not use this method for**:
      * - Videos longer than 1 hour. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
+     * - Video segmentation. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with `model_name` set to `pegasus1.5` instead.
      *
      * <Note title="Notes">
      * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.

package/Client.js

@@ -117,6 +117,7 @@ class TwelvelabsApiClient {
      *
      * **Do not use this method for**:
      * - Videos longer than 1 hour. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
+     * - Video segmentation. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with `model_name` set to `pegasus1.5` instead.
      *
      * <Note title="Notes">
      * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
@@ -131,7 +132,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.2.2", "User-Agent": "twelvelabs-js/1.2.2", "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.3", "User-Agent": "twelvelabs-js/1.2.3", "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 }),
@@ -210,6 +211,7 @@ class TwelvelabsApiClient {
      *
      * **Do not use this method for**:
      * - Videos longer than 1 hour. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
+     * - Video segmentation. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with `model_name` set to `pegasus1.5` instead.
      *
      * <Note title="Notes">
      * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
@@ -258,7 +260,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.2.2", "User-Agent": "twelvelabs-js/1.2.2", "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.3", "User-Agent": "twelvelabs-js/1.2.3", "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/README.md

@@ -19,7 +19,7 @@ Ensure that the following prerequisites are met before using the SDK:
   3. If you need to create a new key, select the **Create API Key** button. Enter a name and set the expiration period. The default is 12 months.
   4. Select the **Copy** icon next to your key to copy it to your clipboard.
 - Your video files must meet the following requirements:
-    - **For this guide**: Files up to 4 GB when using publicly accessible URLs or 200 MB for local files
+    - **For this guide**: Files up to 4 GB.
     - **Model capabilities**: See the complete requirements for [Marengo](https://docs.twelvelabs.io/v1.3/docs/concepts/models/marengo#video-file-requirements) and [Pegasus](https://docs.twelvelabs.io/v1.3/docs/concepts/models/pegasus#video-file-requirements) for resolution, aspect ratio, and supported formats.
 
     For upload size limits and processing modes, see the [Upload and processing methods](https://docs.twelvelabs.io/v1.3/docs/concepts/upload-methods) page.
@@ -105,6 +105,25 @@ console.log(`Created asset: id=${asset.id}`);
 
 The `client.assets.create` method returns an object that includes, among other information, a field named `id` representing the unique identifier of your asset. Use this identifier in subsequent steps.
 
+## Check the status of the asset
+
+You only need this step for files larger than 200 MB. The platform processes files up to 200 MB synchronously and sets the asset status to ready. For larger files, check the asset status until it is ready.
+
+To check the status of the asset, call the `client.assets.retrieve` method with the unique identifier of your asset as a paremeter:
+
+```js
+console.log("Waiting for asset to be ready...");
+let readyAsset = await client.assets.retrieve(asset.id);
+while (readyAsset.status !== "ready" && readyAsset.status !== "failed") {
+  await new Promise((resolve) => setTimeout(resolve, 5000));
+  readyAsset = await client.assets.retrieve(asset.id);
+}
+if (readyAsset.status === "failed") {
+  throw new Error(`Asset processing failed: id=${asset.id}`);
+}
+console.log("Asset is ready");
+```
+
 ## Index your video
 
 To index your video, call the `client.indexes.indexedAssets.create` method with the following parameters:

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

@@ -41,6 +41,6 @@ export interface AnalyzeRequest {
     video?: TwelvelabsApi.VideoContext;
     prompt: TwelvelabsApi.AnalyzeTextPrompt;
     temperature?: TwelvelabsApi.AnalyzeTemperature;
-    responseFormat?: TwelvelabsApi.ResponseFormat;
+    responseFormat?: TwelvelabsApi.SyncResponseFormat;
     maxTokens?: TwelvelabsApi.AnalyzeMaxTokens;
 }

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

@@ -41,6 +41,6 @@ export interface AnalyzeStreamRequest {
     video?: TwelvelabsApi.VideoContext;
     prompt: TwelvelabsApi.AnalyzeTextPrompt;
     temperature?: TwelvelabsApi.AnalyzeTemperature;
-    responseFormat?: TwelvelabsApi.ResponseFormat;
+    responseFormat?: TwelvelabsApi.SyncResponseFormat;
     maxTokens?: TwelvelabsApi.AnalyzeMaxTokens;
 }

package/api/errors/ConflictError.d.ts

@@ -2,8 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as errors from "../../errors/index";
-import * as TwelvelabsApi from "../index";
 import * as core from "../../core";
 export declare class ConflictError extends errors.TwelvelabsApiError {
-    constructor(body: TwelvelabsApi.ErrorResponse, rawResponse?: core.RawResponse);
+    constructor(body?: unknown, rawResponse?: core.RawResponse);
 }

package/api/errors/index.d.ts

@@ -1,6 +1,6 @@
 export * from "./BadRequestError";
 export * from "./NotFoundError";
 export * from "./InternalServerError";
+export * from "./ConflictError";
 export * from "./ForbiddenError";
 export * from "./TooManyRequestsError";
-export * from "./ConflictError";

package/api/errors/index.js

@@ -17,6 +17,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BadRequestError"), exports);
 __exportStar(require("./NotFoundError"), exports);
 __exportStar(require("./InternalServerError"), exports);
+__exportStar(require("./ConflictError"), exports);
 __exportStar(require("./ForbiddenError"), exports);
 __exportStar(require("./TooManyRequestsError"), exports);
-__exportStar(require("./ConflictError"), exports);

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

@@ -37,13 +37,16 @@ export declare class Tasks {
      *     await client.analyzeAsync.tasks.list({
      *         page: 1,
      *         pageLimit: 10,
-     *         status: "queued"
+     *         status: "queued",
+     *         videoUrl: "https://example.com/video.mp4",
+     *         assetId: "69abc123def456789012abcd",
+     *         analysisMode: "time_based_metadata"
      *     })
      */
     list(request?: TwelvelabsApi.analyzeAsync.TasksListRequest, requestOptions?: Tasks.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.analyzeAsync.TasksListResponse>;
     private __list;
     /**
-     * This method asynchronously analyzes your videos and generates fully customizable text based on your prompts.
+     * This method asynchronously analyzes your videos. It supports two modes: general analysis (prompt-based text generation) with Pegasus 1.2 and video segmentation with Pegasus 1.5.
      *
      * <Accordion title="Input requirements">
      * - Minimum duration: 4 seconds
@@ -54,6 +57,8 @@ export declare class Tasks {
      * </Accordion>
      *
      * **When to use this method**:
+     * - Generate custom text from your video using a prompt (Pegasus 1.2 only)
+     * - Extract timestamped metadata with custom fields from your video (Pegasus 1.5 only)
      * - Analyze videos longer than 1 hour
      * - Process videos asynchronously without blocking your application
      *
@@ -86,6 +91,38 @@ export declare class Tasks {
      *         temperature: 0.2,
      *         maxTokens: 1000
      *     })
+     *
+     * @example
+     *     await client.analyzeAsync.tasks.create({
+     *         modelName: "pegasus1.5",
+     *         video: {
+     *             type: "url",
+     *             url: "https://example.com/video.mp4"
+     *         },
+     *         analysisMode: "time_based_metadata",
+     *         responseFormat: {
+     *             type: "segment_definitions",
+     *             segmentDefinitions: [{
+     *                     id: "scene",
+     *                     description: "A distinct scene or setting change in the video",
+     *                     fields: [{
+     *                             name: "sentiment",
+     *                             type: "string",
+     *                             description: "The emotional tone of this segment",
+     *                             enum: ["positive", "negative", "neutral"]
+     *                         }, {
+     *                             name: "key_objects",
+     *                             type: "array",
+     *                             description: "Notable objects visible in this segment",
+     *                             items: {
+     *                                 type: "string"
+     *                             }
+     *                         }]
+     *                 }]
+     *         },
+     *         minSegmentDuration: 5,
+     *         maxSegmentDuration: 30
+     *     })
      */
     create(request: TwelvelabsApi.analyzeAsync.CreateAsyncAnalyzeRequest, requestOptions?: Tasks.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.CreateAnalyzeTaskResponse>;
     private __create;

package/api/resources/analyzeAsync/resources/tasks/client/Client.js

@@ -71,7 +71,10 @@ class Tasks {
      *     await client.analyzeAsync.tasks.list({
      *         page: 1,
      *         pageLimit: 10,
-     *         status: "queued"
+     *         status: "queued",
+     *         videoUrl: "https://example.com/video.mp4",
+     *         assetId: "69abc123def456789012abcd",
+     *         analysisMode: "time_based_metadata"
      *     })
      */
     list(request = {}, requestOptions) {
@@ -80,7 +83,7 @@ class Tasks {
     __list() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b;
-            const { page, pageLimit, status } = request;
+            const { page, pageLimit, status, videoUrl, assetId, analysisMode } = request;
             const _queryParams = {};
             if (page != null) {
                 _queryParams["page"] = page.toString();
@@ -93,10 +96,19 @@ class Tasks {
                     unrecognizedObjectKeys: "strip",
                 });
             }
+            if (videoUrl != null) {
+                _queryParams["video_url"] = videoUrl;
+            }
+            if (assetId != null) {
+                _queryParams["asset_id"] = assetId;
+            }
+            if (analysisMode != null) {
+                _queryParams["analysis_mode"] = serializers.analyzeAsync.TasksListRequestAnalysisMode.jsonOrThrow(analysisMode, { unrecognizedObjectKeys: "strip" });
+            }
             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/tasks"),
                 method: "GET",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "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.3", "User-Agent": "twelvelabs-js/1.2.3", "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",
@@ -145,7 +157,7 @@ class Tasks {
         });
     }
     /**
-     * This method asynchronously analyzes your videos and generates fully customizable text based on your prompts.
+     * This method asynchronously analyzes your videos. It supports two modes: general analysis (prompt-based text generation) with Pegasus 1.2 and video segmentation with Pegasus 1.5.
      *
      * <Accordion title="Input requirements">
      * - Minimum duration: 4 seconds
@@ -156,6 +168,8 @@ class Tasks {
      * </Accordion>
      *
      * **When to use this method**:
+     * - Generate custom text from your video using a prompt (Pegasus 1.2 only)
+     * - Extract timestamped metadata with custom fields from your video (Pegasus 1.5 only)
      * - Analyze videos longer than 1 hour
      * - Process videos asynchronously without blocking your application
      *
@@ -188,6 +202,38 @@ class Tasks {
      *         temperature: 0.2,
      *         maxTokens: 1000
      *     })
+     *
+     * @example
+     *     await client.analyzeAsync.tasks.create({
+     *         modelName: "pegasus1.5",
+     *         video: {
+     *             type: "url",
+     *             url: "https://example.com/video.mp4"
+     *         },
+     *         analysisMode: "time_based_metadata",
+     *         responseFormat: {
+     *             type: "segment_definitions",
+     *             segmentDefinitions: [{
+     *                     id: "scene",
+     *                     description: "A distinct scene or setting change in the video",
+     *                     fields: [{
+     *                             name: "sentiment",
+     *                             type: "string",
+     *                             description: "The emotional tone of this segment",
+     *                             enum: ["positive", "negative", "neutral"]
+     *                         }, {
+     *                             name: "key_objects",
+     *                             type: "array",
+     *                             description: "Notable objects visible in this segment",
+     *                             items: {
+     *                                 type: "string"
+     *                             }
+     *                         }]
+     *                 }]
+     *         },
+     *         minSegmentDuration: 5,
+     *         maxSegmentDuration: 30
+     *     })
      */
     create(request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
@@ -198,7 +244,7 @@ class Tasks {
             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/tasks"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "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.3", "User-Agent": "twelvelabs-js/1.2.3", "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.analyzeAsync.CreateAsyncAnalyzeRequest.jsonOrThrow(request, {
@@ -279,7 +325,7 @@ class Tasks {
             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/tasks/${encodeURIComponent(taskId)}`),
                 method: "GET",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "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.3", "User-Agent": "twelvelabs-js/1.2.3", "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,
@@ -347,7 +393,7 @@ class Tasks {
             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/tasks/${encodeURIComponent(taskId)}`),
                 method: "DELETE",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "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.3", "User-Agent": "twelvelabs-js/1.2.3", "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,
@@ -362,12 +408,7 @@ class Tasks {
                     case 404:
                         throw new TwelvelabsApi.NotFoundError(_response.error.body, _response.rawResponse);
                     case 409:
-                        throw new TwelvelabsApi.ConflictError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
-                            unrecognizedObjectKeys: "passthrough",
-                            allowUnrecognizedUnionMembers: true,
-                            allowUnrecognizedEnumValues: true,
-                            breadcrumbsPrefix: ["response"],
-                        }), _response.rawResponse);
+                        throw new TwelvelabsApi.ConflictError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.TwelvelabsApiError({
                             statusCode: _response.error.statusCode,

package/api/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts

@@ -13,11 +13,82 @@ import * as TwelvelabsApi from "../../../../../../index";
  *         temperature: 0.2,
  *         maxTokens: 1000
  *     }
+ *
+ * @example
+ *     {
+ *         modelName: "pegasus1.5",
+ *         video: {
+ *             type: "url",
+ *             url: "https://example.com/video.mp4"
+ *         },
+ *         analysisMode: "time_based_metadata",
+ *         responseFormat: {
+ *             type: "segment_definitions",
+ *             segmentDefinitions: [{
+ *                     id: "scene",
+ *                     description: "A distinct scene or setting change in the video",
+ *                     fields: [{
+ *                             name: "sentiment",
+ *                             type: "string",
+ *                             description: "The emotional tone of this segment",
+ *                             enum: ["positive", "negative", "neutral"]
+ *                         }, {
+ *                             name: "key_objects",
+ *                             type: "array",
+ *                             description: "Notable objects visible in this segment",
+ *                             items: {
+ *                                 type: "string"
+ *                             }
+ *                         }]
+ *                 }]
+ *         },
+ *         minSegmentDuration: 5,
+ *         maxSegmentDuration: 30
+ *     }
  */
 export interface CreateAsyncAnalyzeRequest {
+    /**
+     * The video understanding model to use for analysis.
+     * - `pegasus1.2` (default): Analyzes pre-indexed videos. Pass a `video_id` to reference your video.
+     * - `pegasus1.5`: Analyzes videos directly from a URL, asset, or base64 string. Supports video segmentation with custom segment definitions.
+     */
+    modelName?: TwelvelabsApi.analyzeAsync.CreateAsyncAnalyzeRequestModelName;
     video: TwelvelabsApi.VideoContext;
-    prompt: TwelvelabsApi.AnalyzeTextPrompt;
+    /**
+     * A natural-language text that provides instructions for analyzing the video. Required for general-mode analysis. Not supported when `analysis_mode` is `time_based_metadata`.
+     *
+     * <Note title="Notes">
+     * - Even though the model behind this endpoint is trained to a high degree of accuracy, the preciseness of the generated text may vary based on the nature and quality of the video and the clarity of the prompt.
+     * - Your prompts can be instructive or descriptive, or you can also phrase them as questions.
+     * - The maximum length of a prompt is 2,000 tokens.
+     * </Note>
+     *
+     * **Examples**:
+     *
+     * - Based on this video, I want to generate five keywords for SEO (Search Engine Optimization).
+     * - 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.
+     */
+    prompt?: string;
+    /** Sets the analysis mode to `time_based_metadata`, which segments your video into time-based intervals and extracts custom metadata for each segment. Requires `model_name` set to `pegasus1.5` and `response_format.type` set to `segment_definitions`. */
+    analysisMode?: TwelvelabsApi.analyzeAsync.CreateAsyncAnalyzeRequestAnalysisMode;
     temperature?: TwelvelabsApi.AnalyzeTemperature;
-    maxTokens?: TwelvelabsApi.AnalyzeMaxTokens;
-    responseFormat?: TwelvelabsApi.ResponseFormat;
+    /**
+     * The maximum number of tokens to generate. The allowed range depends on the model:
+     * - `pegasus1.2`: **Min:** 1, **Max:** 4,096
+     * - `pegasus1.5`: **Min:** 2,048, **Max:** 32,768, **Default:** 32,768
+     */
+    maxTokens?: number;
+    responseFormat?: TwelvelabsApi.AsyncResponseFormat;
+    /**
+     * Minimum duration for each extracted segment, in seconds. Set this to prevent the model from creating very short segments. Requires `model_name` set to `pegasus1.5` and `analysis_mode` set to `time_based_metadata`.
+     *
+     * **Min:** 2
+     */
+    minSegmentDuration?: number;
+    /**
+     * Maximum duration for each extracted segment, in seconds. Set this to break long continuous sections into shorter segments. Must be greater than or equal to `min_segment_duration`. Requires `model_name` set to `pegasus1.5` and `analysis_mode` set to `time_based_metadata`.
+     *
+     * **Min:** 2
+     */
+    maxSegmentDuration?: number;
 }

package/api/resources/analyzeAsync/resources/tasks/client/requests/TasksListRequest.d.ts

@@ -7,7 +7,20 @@ import * as TwelvelabsApi from "../../../../../../index";
  *     {
  *         page: 1,
  *         pageLimit: 10,
- *         status: "queued"
+ *         status: "queued",
+ *         videoUrl: "https://example.com/video.mp4",
+ *         assetId: "69abc123def456789012abcd",
+ *         analysisMode: "time_based_metadata"
+ *     }
+ *
+ * @example
+ *     {
+ *         page: 1,
+ *         pageLimit: 10,
+ *         status: "queued",
+ *         videoUrl: "https://example.com/video.mp4",
+ *         assetId: "69abc123def456789012abcd",
+ *         analysisMode: "time_based_metadata"
  *     }
  */
 export interface TasksListRequest {
@@ -29,4 +42,16 @@ export interface TasksListRequest {
      * Possible values: `queued`, `pending`, `processing`, `ready`, `failed`.
      */
     status?: TwelvelabsApi.AnalyzeTaskStatus;
+    /**
+     * Filter tasks by exact video source URL.
+     */
+    videoUrl?: string;
+    /**
+     * Filter tasks by asset ID.
+     */
+    assetId?: string;
+    /**
+     * Filter tasks by the analysis mode used when creating the task.
+     */
+    analysisMode?: TwelvelabsApi.analyzeAsync.TasksListRequestAnalysisMode;
 }

package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Sets the analysis mode to `time_based_metadata`, which segments your video into time-based intervals and extracts custom metadata for each segment. Requires `model_name` set to `pegasus1.5` and `response_format.type` set to `segment_definitions`.
+ */
+export type CreateAsyncAnalyzeRequestAnalysisMode = "time_based_metadata";
+export declare const CreateAsyncAnalyzeRequestAnalysisMode: {
+    readonly TimeBasedMetadata: "time_based_metadata";
+};

package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateAsyncAnalyzeRequestAnalysisMode = void 0;
+exports.CreateAsyncAnalyzeRequestAnalysisMode = {
+    TimeBasedMetadata: "time_based_metadata",
+};

package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The video understanding model to use for analysis.
+ * - `pegasus1.2` (default): Analyzes pre-indexed videos. Pass a `video_id` to reference your video.
+ * - `pegasus1.5`: Analyzes videos directly from a URL, asset, or base64 string. Supports video segmentation with custom segment definitions.
+ */
+export type CreateAsyncAnalyzeRequestModelName = "pegasus1.2" | "pegasus1.5";
+export declare const CreateAsyncAnalyzeRequestModelName: {
+    readonly Pegasus12: "pegasus1.2";
+    readonly Pegasus15: "pegasus1.5";
+};

package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateAsyncAnalyzeRequestModelName = void 0;
+exports.CreateAsyncAnalyzeRequestModelName = {
+    Pegasus12: "pegasus1.2",
+    Pegasus15: "pegasus1.5",
+};

package/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type TasksListRequestAnalysisMode = "time_based_metadata";
+export declare const TasksListRequestAnalysisMode: {
+    readonly TimeBasedMetadata: "time_based_metadata";
+};

package/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TasksListRequestAnalysisMode = void 0;
+exports.TasksListRequestAnalysisMode = {
+    TimeBasedMetadata: "time_based_metadata",
+};

package/api/resources/analyzeAsync/resources/tasks/types/index.d.ts

@@ -1 +1,4 @@
+export * from "./TasksListRequestAnalysisMode";
 export * from "./TasksListResponse";
+export * from "./CreateAsyncAnalyzeRequestModelName";
+export * from "./CreateAsyncAnalyzeRequestAnalysisMode";

package/api/resources/analyzeAsync/resources/tasks/types/index.js

@@ -14,4 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./TasksListRequestAnalysisMode"), exports);
 __exportStar(require("./TasksListResponse"), exports);
+__exportStar(require("./CreateAsyncAnalyzeRequestModelName"), exports);
+__exportStar(require("./CreateAsyncAnalyzeRequestAnalysisMode"), exports);

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

@@ -38,10 +38,11 @@ export declare class Assets {
      * @example
      *     await client.assets.list({
      *         page: 1,
-     *         pageLimit: 10
+     *         pageLimit: 10,
+     *         filename: "meeting"
      *     })
      */
-    list(request?: TwelvelabsApi.AssetsListRequest, requestOptions?: Assets.RequestOptions): Promise<core.Page<TwelvelabsApi.Asset>>;
+    list(request?: TwelvelabsApi.AssetsListRequest, requestOptions?: Assets.RequestOptions): Promise<core.Page<TwelvelabsApi.AssetDetail>>;
     /**
      * 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.
      *
@@ -51,7 +52,7 @@ export declare class Assets {
      * - **Local file**: Set the `method` parameter to `direct` and use the `file` parameter to specify the file.
      * - **Publicly accessible URL**: Set the `method` parameter to `url` and use the `url` parameter to specify the URL of your file.
      *
-     * **File size**: 200MB maximum for local file uploads, 4GB maximum for URL uploads.
+     * **File size**: Up to 4 GB.
      *
      * **Additional requirements** depend on your workflow:
      * - **Search**: [Marengo requirements](/v1.3/docs/concepts/models/marengo#video-file-requirements)
@@ -86,20 +87,30 @@ export declare class Assets {
      * @example
      *     await client.assets.retrieve("6298d673f1090f1100476d4c")
      */
-    retrieve(assetId: string, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.Asset>;
+    retrieve(assetId: string, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.AssetDetail>;
     private __retrieve;
     /**
      * This method deletes the specified asset. This action cannot be undone.
      *
+     * By default, the platform checks whether any indexed assets reference the asset. If references exist, the platform rejects the request with a `409 Conflict` error. To skip this check and delete the asset anyway, set the `force` query parameter to `true`. The platform unlinks any entity associations.
+     *
+     * Before deleting, you can inspect existing references:
+     * - [`GET`](/v1.3/api-reference/index-content/list-indexed-assets-by-asset) `/assets/{asset_id}/indexed-assets` returns a list of the indexed assets that will block deletion unless the `force` query parameter is set to `true`.
+     * - [`GET`](/v1.3/api-reference/entities/list-entities-by-asset) `/assets/{asset_id}/entities` returns a list of the entities whose associations the platform will unlink.
+     *
      * @param {string} assetId - The unique identifier of the asset to delete.
+     * @param {TwelvelabsApi.AssetsDeleteRequest} request
      * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link TwelvelabsApi.BadRequestError}
+     * @throws {@link TwelvelabsApi.ConflictError}
      *
      * @example
-     *     await client.assets.delete("6298d673f1090f1100476d4c")
+     *     await client.assets.delete("6298d673f1090f1100476d4c", {
+     *         force: true
+     *     })
      */
-    delete(assetId: string, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<void>;
+    delete(assetId: string, request?: TwelvelabsApi.AssetsDeleteRequest, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "x-api-key": string;