twelvelabs-js 1.2.3 → 1.2.4

package/api/types/SyncResponseFormat.d.ts

@@ -24,23 +24,30 @@ export interface SyncResponseFormat {
      *
      * | Type | Supported keywords | Notes |
      * |------|-------------------|-------|
-     * | `integer` | `maximum`, `exclusiveMaximum`, `minimum`, `exclusiveMinimum`. | - `maximum`: Sets the highest allowed value (inclusive).<br/>- `exclusiveMaximum`: Sets the highest allowed value (exclusive).<br/>-`minimum`: Sets the lowest allowed value (inclusive).<br/>- `exclusiveMinimum`: Sets the lowest allowed value (exclusive).<br/>These constraints are supported only for the `integer` type. |
+     * | `integer` | `maximum`, `exclusiveMaximum`, `minimum`, `exclusiveMinimum`. | - `maximum`: Sets the highest allowed value (inclusive).<br/>- `exclusiveMaximum`: Sets the highest allowed value (exclusive).<br/>- `minimum`: Sets the lowest allowed value (inclusive).<br/>- `exclusiveMinimum`: Sets the lowest allowed value (exclusive).<br/>These constraints are supported only for the `integer` type. |
      * | `string` | `pattern`, `format` | - `pattern`: A regular expression that the string must match.<br/>- `format`: Validates predefined formats. It accepts the following values: `uuid`, `date-time`, `date`, and `time`.<br/>See string limitations below. |
      * | `object` | `properties`, `required` | - `properties`: Defines object properties and their schemas. - `required`: Specifies mandatory properties.<br/>See object limitations below. |
-     * | `array` | `items`, `minItems` | `minItems` accepts only `0` or `1` |
+     * | `array` | `items`, `minItems` | `minItems` accepts only `0` or `1`.<br/>See array limitations below. |
      *
      *
      * **String limitations**
      *
-     * The platform validates strings using the `pattern` and `format` constraints only. When you include `minLength` or `maxLength` keywords in your schema, the platform returns an error: "String length constraints (minLength) are not supported."
+     * When you use the `string` type:
+     * - The platform validates strings using only `pattern` and `format`. Including `minLength` or `maxLength` causes a 422 error: "String length constraints (minLength) are not supported." Remove these keywords from your schema.
      *
      *
      * **Object limitations**
      *
      * When you use the `object` type:
-     * - The platform always ignores the `additionalProperties` setting.
-     * - The sequence of the properties is fixed.
-     * - The first property should be required. If the first property is optional, the platform moves the first required property to the first position.
+     * - The platform does not support the `additionalProperties` keyword. Including it causes a 422 error. Remove it from your schema.
+     * - The platform returns properties in declaration order.
+     * - Make the first property required. If the first property is optional, the platform moves the first required property to the beginning.
+     *
+     *
+     * **Array limitations**
+     *
+     * When you use the `array` type:
+     * - The platform does not support `uniqueItems` or `maxItems`. Including either keyword causes a 422 error. Remove them from your schema.
      *
      *
      * **Constant and enumerated values**
@@ -70,6 +77,18 @@ export interface SyncResponseFormat {
      * For details, see the [JSON Schema documentation on $defs](https://json-schema.org/understanding-json-schema/structuring#defs).
      *
      *
+     * **Reserved property names (`start_time` / `end_time`)**
+     *
+     * For `pegasus1.5`, properties named `start_time` or `end_time` in your response schema receive special type handling. These are unrelated to the top-level `start_time` / `end_time` request parameters. The model outputs these values as floating-point seconds, and the platform converts them based on the declared type at any nesting depth (including inside array `items`):
+     *
+     * | Declared type | Platform behavior |
+     * |---------------|-------------------|
+     * | `number` | Passes the value through without conversion. |
+     * | `integer` | Rounds the value to the nearest integer before returning it. |
+     * | `string` (no `format`) | Converts the value to the `hh:mm:ss.fff` format. |
+     *
+     * All other property names in your schema remain unconstrained by these rules.
+     *
      *
      * **Response validation**
      *

package/api/types/TokenUsage.d.ts

@@ -6,5 +6,7 @@
  */
 export interface TokenUsage {
     /** The number of tokens in the generated text. */
-    outputTokens?: number;
+    outputTokens: number;
+    /** The number of tokens consumed by the input (prompt and video). Omitted for Pegasus 1.5. */
+    inputTokens?: number;
 }

package/api/types/index.d.ts

@@ -13,6 +13,8 @@ export * from "./VideosListRequestHeight";
 export * from "./VideosListRequestSize";
 export * from "./ConflictErrorBody";
 export * from "./ForbiddenErrorBody";
+export * from "./AnalyzeStreamRequestModelName";
+export * from "./AnalyzeRequestModelName";
 export * from "./Url";
 export * from "./One";
 export * from "./Two";
@@ -131,6 +133,8 @@ export * from "./AsyncResponseFormat";
 export * from "./SyncResponseFormatType";
 export * from "./SyncResponseFormat";
 export * from "./SegmentDefinition";
+export * from "./AnalyzePromptV2";
+export * from "./AnalyzeTimeRange";
 export * from "./SegmentFieldType";
 export * from "./SegmentFieldItemsType";
 export * from "./SegmentFieldItems";
@@ -145,6 +149,8 @@ export * from "./AnalyzeTaskResponseVideoSourceType";
 export * from "./AnalyzeTaskResponseVideoSourceSystemMetadata";
 export * from "./AnalyzeTaskResponseVideoSource";
 export * from "./AnalyzeTaskResponseRequestParamsAnalysisMode";
+export * from "./AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem";
+export * from "./AnalyzeTaskResponseRequestParamsPromptV2";
 export * from "./AnalyzeTaskResponseRequestParamsResponseFormatType";
 export * from "./AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems";
 export * from "./AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem";

package/api/types/index.js

@@ -29,6 +29,8 @@ __exportStar(require("./VideosListRequestHeight"), exports);
 __exportStar(require("./VideosListRequestSize"), exports);
 __exportStar(require("./ConflictErrorBody"), exports);
 __exportStar(require("./ForbiddenErrorBody"), exports);
+__exportStar(require("./AnalyzeStreamRequestModelName"), exports);
+__exportStar(require("./AnalyzeRequestModelName"), exports);
 __exportStar(require("./Url"), exports);
 __exportStar(require("./One"), exports);
 __exportStar(require("./Two"), exports);
@@ -147,6 +149,8 @@ __exportStar(require("./AsyncResponseFormat"), exports);
 __exportStar(require("./SyncResponseFormatType"), exports);
 __exportStar(require("./SyncResponseFormat"), exports);
 __exportStar(require("./SegmentDefinition"), exports);
+__exportStar(require("./AnalyzePromptV2"), exports);
+__exportStar(require("./AnalyzeTimeRange"), exports);
 __exportStar(require("./SegmentFieldType"), exports);
 __exportStar(require("./SegmentFieldItemsType"), exports);
 __exportStar(require("./SegmentFieldItems"), exports);
@@ -161,6 +165,8 @@ __exportStar(require("./AnalyzeTaskResponseVideoSourceType"), exports);
 __exportStar(require("./AnalyzeTaskResponseVideoSourceSystemMetadata"), exports);
 __exportStar(require("./AnalyzeTaskResponseVideoSource"), exports);
 __exportStar(require("./AnalyzeTaskResponseRequestParamsAnalysisMode"), exports);
+__exportStar(require("./AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem"), exports);
+__exportStar(require("./AnalyzeTaskResponseRequestParamsPromptV2"), exports);
 __exportStar(require("./AnalyzeTaskResponseRequestParamsResponseFormatType"), exports);
 __exportStar(require("./AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems"), exports);
 __exportStar(require("./AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem"), exports);

package/dist/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,21 +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. 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.
+     * - 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
@@ -88,50 +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. 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.
+     * - 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/dist/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,15 +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. 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.
+     * - 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) {
@@ -132,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.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),
+                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,
             });
@@ -166,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:
@@ -194,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
@@ -206,50 +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. 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.
+     * - 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));
@@ -260,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.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),
+                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,
             });
@@ -283,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/dist/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;
+    /** 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;
-    maxTokens?: TwelvelabsApi.AnalyzeMaxTokens;
+    /**
+     * 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/dist/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;
+    /** 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;
-    maxTokens?: TwelvelabsApi.AnalyzeMaxTokens;
+    /**
+     * 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/dist/api/resources/analyzeAsync/resources/tasks/client/Client.d.ts

@@ -40,13 +40,14 @@ export declare class Tasks {
      *         status: "queued",
      *         videoUrl: "https://example.com/video.mp4",
      *         assetId: "69abc123def456789012abcd",
-     *         analysisMode: "time_based_metadata"
+     *         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. It supports two modes: general analysis (prompt-based text generation) with Pegasus 1.2 and video segmentation with Pegasus 1.5.
+     * 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
@@ -57,8 +58,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)
+     * - 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
      *
@@ -83,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"
@@ -123,6 +125,61 @@ export declare class Tasks {
      *         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;