twelvelabs-js 1.2.2 → 1.2.4

package/Client.d.ts

@@ -50,7 +50,7 @@ export declare class TwelvelabsApiClient {
     get search(): Search;
     get analyzeAsync(): AnalyzeAsync;
     /**
-     * This method synchronously analyzes your videos and generates fully customizable text based on your prompts.
+     * This method analyzes your videos and returns the results directly in the response. It generates text based on your prompts and supports both Pegasus 1.2 and Pegasus 1.5 for general analysis (prompt-based text generation).
      *
      * <Accordion title="Input requirements">
      * - Minimum duration: 4 seconds
@@ -62,20 +62,21 @@ export declare class TwelvelabsApiClient {
      *
      * **When to use this method**:
      * - Analyze videos up to 1 hour
-     * - Retrieve immediate results without waiting for asynchronous processing
-     * - Stream text fragments in real-time for immediate processing and feedback
+     * - Retrieve immediate results without polling for task completion
+     * - Stream text fragments in real time for immediate processing and feedback
      *
      * **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 with custom segment definitions. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with the `model_name` parameter 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.
+     * <Note title="Note">
+     * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
      * </Note>
      */
     analyzeStream(request: TwelvelabsApi.AnalyzeStreamRequest, requestOptions?: TwelvelabsApiClient.RequestOptions): core.HttpResponsePromise<core.Stream<TwelvelabsApi.StreamAnalyzeResponse>>;
     private __analyzeStream;
     /**
-     * This method synchronously analyzes your videos and generates fully customizable text based on your prompts.
+     * This method analyzes your videos and returns the results directly in the response. It generates text based on your prompts and supports both Pegasus 1.2 and Pegasus 1.5 for general analysis (prompt-based text generation).
      *
      * <Accordion title="Input requirements">
      * - Minimum duration: 4 seconds
@@ -87,49 +88,26 @@ export declare class TwelvelabsApiClient {
      *
      * **When to use this method**:
      * - Analyze videos up to 1 hour
-     * - Retrieve immediate results without waiting for asynchronous processing
-     * - Stream text fragments in real-time for immediate processing and feedback
+     * - Retrieve immediate results without polling for task completion
+     * - Stream text fragments in real time for immediate processing and feedback
      *
      * **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 with custom segment definitions. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with the `model_name` parameter 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.
+     * <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.AnalyzeRequest} request
      * @param {TwelvelabsApiClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link TwelvelabsApi.BadRequestError}
+     * @throws {@link TwelvelabsApi.NotFoundError}
      * @throws {@link TwelvelabsApi.TooManyRequestsError}
      *
      * @example
-     *     await client.analyze({
-     *         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,
-     *         responseFormat: {
-     *             type: "json_schema",
-     *             jsonSchema: {
-     *                 "type": "object",
-     *                 "properties": {
-     *                     "title": {
-     *                         "type": "string"
-     *                     },
-     *                     "summary": {
-     *                         "type": "string"
-     *                     },
-     *                     "keywords": {
-     *                         "type": "array",
-     *                         "items": {
-     *                             "type": "string"
-     *                         }
-     *                     }
-     *                 }
-     *             }
-     *         },
-     *         maxTokens: 2000
-     *     })
+     *     await client.analyze({})
      */
     analyze(request: TwelvelabsApi.AnalyzeRequest, requestOptions?: TwelvelabsApiClient.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.NonStreamAnalyzeResponse>;
     private __analyze;

package/Client.js

@@ -100,7 +100,7 @@ class TwelvelabsApiClient {
         return ((_a = this._analyzeAsync) !== null && _a !== void 0 ? _a : (this._analyzeAsync = new Client_8.AnalyzeAsync(this._options)));
     }
     /**
-     * This method synchronously analyzes your videos and generates fully customizable text based on your prompts.
+     * This method analyzes your videos and returns the results directly in the response. It generates text based on your prompts and supports both Pegasus 1.2 and Pegasus 1.5 for general analysis (prompt-based text generation).
      *
      * <Accordion title="Input requirements">
      * - Minimum duration: 4 seconds
@@ -112,14 +112,15 @@ class TwelvelabsApiClient {
      *
      * **When to use this method**:
      * - Analyze videos up to 1 hour
-     * - Retrieve immediate results without waiting for asynchronous processing
-     * - Stream text fragments in real-time for immediate processing and feedback
+     * - Retrieve immediate results without polling for task completion
+     * - Stream text fragments in real time for immediate processing and feedback
      *
      * **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 with custom segment definitions. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with the `model_name` parameter 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.
+     * <Note title="Note">
+     * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
      * </Note>
      */
     analyzeStream(request, requestOptions) {
@@ -131,12 +132,12 @@ 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.4", "User-Agent": "twelvelabs-js/1.2.4", "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 }),
                 responseType: "sse",
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 600000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
@@ -165,6 +166,8 @@ class TwelvelabsApiClient {
                 switch (_response.error.statusCode) {
                     case 400:
                         throw new TwelvelabsApi.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new TwelvelabsApi.NotFoundError(_response.error.body, _response.rawResponse);
                     case 429:
                         throw new TwelvelabsApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                     default:
@@ -193,7 +196,7 @@ class TwelvelabsApiClient {
         });
     }
     /**
-     * This method synchronously analyzes your videos and generates fully customizable text based on your prompts.
+     * This method analyzes your videos and returns the results directly in the response. It generates text based on your prompts and supports both Pegasus 1.2 and Pegasus 1.5 for general analysis (prompt-based text generation).
      *
      * <Accordion title="Input requirements">
      * - Minimum duration: 4 seconds
@@ -205,49 +208,26 @@ class TwelvelabsApiClient {
      *
      * **When to use this method**:
      * - Analyze videos up to 1 hour
-     * - Retrieve immediate results without waiting for asynchronous processing
-     * - Stream text fragments in real-time for immediate processing and feedback
+     * - Retrieve immediate results without polling for task completion
+     * - Stream text fragments in real time for immediate processing and feedback
      *
      * **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 with custom segment definitions. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with the `model_name` parameter 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.
+     * <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.AnalyzeRequest} request
      * @param {TwelvelabsApiClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link TwelvelabsApi.BadRequestError}
+     * @throws {@link TwelvelabsApi.NotFoundError}
      * @throws {@link TwelvelabsApi.TooManyRequestsError}
      *
      * @example
-     *     await client.analyze({
-     *         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,
-     *         responseFormat: {
-     *             type: "json_schema",
-     *             jsonSchema: {
-     *                 "type": "object",
-     *                 "properties": {
-     *                     "title": {
-     *                         "type": "string"
-     *                     },
-     *                     "summary": {
-     *                         "type": "string"
-     *                     },
-     *                     "keywords": {
-     *                         "type": "array",
-     *                         "items": {
-     *                             "type": "string"
-     *                         }
-     *                     }
-     *                 }
-     *             }
-     *         },
-     *         maxTokens: 2000
-     *     })
+     *     await client.analyze({})
      */
     analyze(request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__analyze(request, requestOptions));
@@ -258,11 +238,11 @@ 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.4", "User-Agent": "twelvelabs-js/1.2.4", "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 }),
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 600000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
@@ -281,6 +261,8 @@ class TwelvelabsApiClient {
                 switch (_response.error.statusCode) {
                     case 400:
                         throw new TwelvelabsApi.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new TwelvelabsApi.NotFoundError(_response.error.body, _response.rawResponse);
                     case 429:
                         throw new TwelvelabsApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
                     default:

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

@@ -4,43 +4,56 @@
 import * as TwelvelabsApi from "../../index";
 /**
  * @example
- *     {
- *         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,
- *         responseFormat: {
- *             type: "json_schema",
- *             jsonSchema: {
- *                 "type": "object",
- *                 "properties": {
- *                     "title": {
- *                         "type": "string"
- *                     },
- *                     "summary": {
- *                         "type": "string"
- *                     },
- *                     "keywords": {
- *                         "type": "array",
- *                         "items": {
- *                             "type": "string"
- *                         }
- *                     }
- *                 }
- *             }
- *         },
- *         maxTokens: 2000
- *     }
+ *     {}
  */
 export interface AnalyzeRequest {
     /**
-     * The unique identifier of the video to analyze.
+     * The video understanding model to use for analysis.
+     * - `pegasus1.2`: General analysis (prompt-based text generation).
+     * - `pegasus1.5`: General analysis (prompt-based text generation) with video clipping, structured prompts with reference images, extended token limits, and video segmentation (async only). Does not support `analysis_mode=time_based_metadata` or `response_format.type=segment_definitions` — use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
+     *
+     * **Default:** `pegasus1.2`
+     */
+    modelName?: TwelvelabsApi.AnalyzeRequestModelName;
+    /**
+     * The unique identifier of the video to analyze. Use this parameter when the `model_name` parameter is `pegasus1.2`. Not supported with `pegasus1.5`.
      *
      * <Info> This parameter will be deprecated and removed in a future version. Use the [`video`](/v1.3/api-reference/analyze-videos/sync-analysis#request.body.video) parameter instead.</Info>
      */
     videoId?: string;
     video?: TwelvelabsApi.VideoContext;
-    prompt: TwelvelabsApi.AnalyzeTextPrompt;
+    /** A text prompt that guides the model on the desired format or content. Works with both Pegasus 1.2 and Pegasus 1.5. To include reference images in your prompt, use the `prompt_v2` parameter instead (Pegasus 1.5 only). Mutually exclusive with the `prompt_v2` parameter. */
+    prompt?: TwelvelabsApi.AnalyzeTextPrompt;
+    /** A structured prompt with `<@name>` placeholders for referencing images. Requires the `model_name` parameter set to `pegasus1.5`. Mutually exclusive with the `prompt` parameter. */
+    promptV2?: TwelvelabsApi.AnalyzePromptV2;
     temperature?: TwelvelabsApi.AnalyzeTemperature;
-    responseFormat?: TwelvelabsApi.ResponseFormat;
-    maxTokens?: TwelvelabsApi.AnalyzeMaxTokens;
+    /** Specifies the format of the response. When you omit this parameter, the platform returns unstructured text. Only the `json_schema` type is supported for synchronous analysis. */
+    responseFormat?: TwelvelabsApi.SyncResponseFormat;
+    /**
+     * The maximum number of tokens to generate. The allowed range depends on the model:
+     *
+     * | Model | Min | Max | Default |
+     * |-------|-----|-----|---------|
+     * | Pegasus 1.2 | 1 | 4,096 | 4,096 |
+     * | Pegasus 1.5 | 512 | 65,536 | 4,096 |
+     */
+    maxTokens?: number;
+    /**
+     * Start of the analysis window, in seconds. Use with `end_time` to analyze only a portion of the video. Requires `model_name` set to `pegasus1.5`.
+     *
+     * <Note title="Notes">
+     * - If omitted, defaults to `0`.
+     * - Must be less than `end_time` and less than the video duration. The clip (`end_time - start_time`) must be at least `4` seconds.
+     * </Note>
+     */
+    startTime?: number;
+    /**
+     * End of the analysis window, in seconds. Use with `start_time` to analyze only a portion of the video. Requires `model_name` set to `pegasus1.5`.
+     *
+     * <Note title="Notes">
+     * - If omitted, defaults to the video duration.
+     * - Must be greater than `start_time` and less than or equal to the video duration. The clip (`end_time - start_time`) must be at least `4` seconds.
+     * </Note>
+     */
+    endTime?: number;
 }

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

@@ -4,43 +4,56 @@
 import * as TwelvelabsApi from "../../index";
 /**
  * @example
- *     {
- *         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,
- *         responseFormat: {
- *             type: "json_schema",
- *             jsonSchema: {
- *                 "type": "object",
- *                 "properties": {
- *                     "title": {
- *                         "type": "string"
- *                     },
- *                     "summary": {
- *                         "type": "string"
- *                     },
- *                     "keywords": {
- *                         "type": "array",
- *                         "items": {
- *                             "type": "string"
- *                         }
- *                     }
- *                 }
- *             }
- *         },
- *         maxTokens: 2000
- *     }
+ *     {}
  */
 export interface AnalyzeStreamRequest {
     /**
-     * The unique identifier of the video to analyze.
+     * The video understanding model to use for analysis.
+     * - `pegasus1.2`: General analysis (prompt-based text generation).
+     * - `pegasus1.5`: General analysis (prompt-based text generation) with video clipping, structured prompts with reference images, extended token limits, and video segmentation (async only). Does not support `analysis_mode=time_based_metadata` or `response_format.type=segment_definitions` — use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
+     *
+     * **Default:** `pegasus1.2`
+     */
+    modelName?: TwelvelabsApi.AnalyzeStreamRequestModelName;
+    /**
+     * The unique identifier of the video to analyze. Use this parameter when the `model_name` parameter is `pegasus1.2`. Not supported with `pegasus1.5`.
      *
      * <Info> This parameter will be deprecated and removed in a future version. Use the [`video`](/v1.3/api-reference/analyze-videos/sync-analysis#request.body.video) parameter instead.</Info>
      */
     videoId?: string;
     video?: TwelvelabsApi.VideoContext;
-    prompt: TwelvelabsApi.AnalyzeTextPrompt;
+    /** A text prompt that guides the model on the desired format or content. Works with both Pegasus 1.2 and Pegasus 1.5. To include reference images in your prompt, use the `prompt_v2` parameter instead (Pegasus 1.5 only). Mutually exclusive with the `prompt_v2` parameter. */
+    prompt?: TwelvelabsApi.AnalyzeTextPrompt;
+    /** A structured prompt with `<@name>` placeholders for referencing images. Requires the `model_name` parameter set to `pegasus1.5`. Mutually exclusive with the `prompt` parameter. */
+    promptV2?: TwelvelabsApi.AnalyzePromptV2;
     temperature?: TwelvelabsApi.AnalyzeTemperature;
-    responseFormat?: TwelvelabsApi.ResponseFormat;
-    maxTokens?: TwelvelabsApi.AnalyzeMaxTokens;
+    /** Specifies the format of the response. When you omit this parameter, the platform returns unstructured text. Only the `json_schema` type is supported for synchronous analysis. */
+    responseFormat?: TwelvelabsApi.SyncResponseFormat;
+    /**
+     * The maximum number of tokens to generate. The allowed range depends on the model:
+     *
+     * | Model | Min | Max | Default |
+     * |-------|-----|-----|---------|
+     * | Pegasus 1.2 | 1 | 4,096 | 4,096 |
+     * | Pegasus 1.5 | 512 | 65,536 | 4,096 |
+     */
+    maxTokens?: number;
+    /**
+     * Start of the analysis window, in seconds. Use with `end_time` to analyze only a portion of the video. Requires `model_name` set to `pegasus1.5`.
+     *
+     * <Note title="Notes">
+     * - If omitted, defaults to `0`.
+     * - Must be less than `end_time` and less than the video duration. The clip (`end_time - start_time`) must be at least `4` seconds.
+     * </Note>
+     */
+    startTime?: number;
+    /**
+     * End of the analysis window, in seconds. Use with `start_time` to analyze only a portion of the video. Requires `model_name` set to `pegasus1.5`.
+     *
+     * <Note title="Notes">
+     * - If omitted, defaults to the video duration.
+     * - Must be greater than `start_time` and less than or equal to the video duration. The clip (`end_time - start_time`) must be at least `4` seconds.
+     * </Note>
+     */
+    endTime?: number;
 }

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,17 @@ 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",
+     *         videoId: "6298d673f1090f1100476d4c",
+     *         analysisMode: "general"
      *     })
      */
     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 analysis modes: general analysis (prompt-based text generation) and video segmentation with custom segment definitions. Video segmentation requires Pegasus 1.5.
      *
      * <Accordion title="Input requirements">
      * - Minimum duration: 4 seconds
@@ -54,6 +58,8 @@ export declare class Tasks {
      * </Accordion>
      *
      * **When to use this method**:
+     * - Generate custom text from your video using a prompt (general analysis)
+     * - Extract timestamped metadata with custom segment definitions from your video (Pegasus 1.5 only)
      * - Analyze videos longer than 1 hour
      * - Process videos asynchronously without blocking your application
      *
@@ -78,6 +84,7 @@ export declare class Tasks {
      *
      * @example
      *     await client.analyzeAsync.tasks.create({
+     *         customId: "prod-segment-analysis-42",
      *         video: {
      *             type: "url",
      *             url: "https://example.com/video.mp4"
@@ -86,6 +93,93 @@ 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
+     *     })
+     *
+     * @example
+     *     await client.analyzeAsync.tasks.create({
+     *         modelName: "pegasus1.5",
+     *         video: {
+     *             type: "url",
+     *             url: "https://example.com/video.mp4"
+     *         },
+     *         prompt: "Summarize the key events in this clip.",
+     *         maxTokens: 4096,
+     *         startTime: 10,
+     *         endTime: 60
+     *     })
+     *
+     * @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: "scenes",
+     *                     description: "Scene changes.",
+     *                     timeRanges: [{
+     *                             startTime: 0,
+     *                             endTime: 4
+     *                         }, {
+     *                             startTime: 10,
+     *                             endTime: 14
+     *                         }]
+     *                 }]
+     *         }
+     *     })
+     *
+     * @example
+     *     await client.analyzeAsync.tasks.create({
+     *         modelName: "pegasus1.5",
+     *         video: {
+     *             type: "url",
+     *             url: "https://example.com/video.mp4"
+     *         },
+     *         promptV2: {
+     *             inputText: "Is there a <@tiger-1> in the video?",
+     *             mediaSources: [{
+     *                     name: "tiger-1",
+     *                     mediaType: "image",
+     *                     url: "https://example.com/tiger.jpg"
+     *                 }]
+     *         },
+     *         maxTokens: 4096
+     *     })
      */
     create(request: TwelvelabsApi.analyzeAsync.CreateAsyncAnalyzeRequest, requestOptions?: Tasks.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.CreateAnalyzeTaskResponse>;
     private __create;