twelvelabs-js 1.2.7 → 1.2.9

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

@@ -71,6 +71,8 @@ export declare class Tasks {
      * - If you want to both search and analyze your videos, the most restrictive requirements apply.
      * - This method allows you to upload files up to 2 GB in size. To upload larger files, use the [Multipart Upload API](/v1.3/api-reference/upload-content/multipart-uploads)
      *
+     * Indexes have limits on video hours and video count. For details, see the [Video hours and video count limits](/v1.3/docs/concepts/indexes#video-hours-and-video-count-limits) section.
+     *
      * <Note title="Note">
      * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
      * </Note>

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

@@ -136,7 +136,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, "tasks"),
                     method: "GET",
-                    headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.7", "User-Agent": "twelvelabs-js/1.2.7", "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.9", "User-Agent": "twelvelabs-js/1.2.9", "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",
@@ -219,6 +219,8 @@ class Tasks {
      * - If you want to both search and analyze your videos, the most restrictive requirements apply.
      * - This method allows you to upload files up to 2 GB in size. To upload larger files, use the [Multipart Upload API](/v1.3/api-reference/upload-content/multipart-uploads)
      *
+     * Indexes have limits on video hours and video count. For details, see the [Video hours and video count limits](/v1.3/docs/concepts/indexes#video-hours-and-video-count-limits) section.
+     *
      * <Note title="Note">
      * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
      * </Note>
@@ -257,7 +259,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, "tasks"),
                 method: "POST",
-                headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.7", "User-Agent": "twelvelabs-js/1.2.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.9", "User-Agent": "twelvelabs-js/1.2.9", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 requestType: "file",
                 duplex: _maybeEncodedRequest.duplex,
                 body: _maybeEncodedRequest.body,
@@ -325,7 +327,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, `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.7", "User-Agent": "twelvelabs-js/1.2.7", "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.9", "User-Agent": "twelvelabs-js/1.2.9", "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 : 600000,
@@ -395,7 +397,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, `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.7", "User-Agent": "twelvelabs-js/1.2.7", "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.9", "User-Agent": "twelvelabs-js/1.2.9", "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 : 600000,

package/api/types/AnalyzeBatchStatusResponse.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as TwelvelabsApi from "../index";
+/**
+ * A batch object that includes item counts for each item status.
+ */
+export interface AnalyzeBatchStatusResponse extends TwelvelabsApi.AnalyzeBatchSummary {
+    /** The number of items in the `queued` status. */
+    queuedItems: number;
+    /** The number of items in the `processing` status. */
+    processingItems: number;
+    /** The number of items that completed successfully. */
+    readyItems: number;
+    /** The number of items that failed. */
+    failedItems: number;
+    /** The number of items that were canceled, either because the batch was canceled while the item was in the `queued` status, or because the batch expired before the item finished processing. */
+    canceledItems: number;
+    /** The delivery status of each webhook endpoint for the batch completion notification. Present only after the platform sends the webhook notifications. To register webhooks, see the [Webhooks](/v1.3/docs/advanced/webhooks) page. */
+    webhooks?: TwelvelabsApi.AnalyzeTaskWebhookInfo[];
+}

package/api/types/AnalyzeBatchStatusResponse.js

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

package/api/types/AnalyzeBatchSummary.d.ts

@@ -0,0 +1,28 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as TwelvelabsApi from "../index";
+/**
+ * A batch object that summarizes the batch.
+ */
+export interface AnalyzeBatchSummary {
+    /** The unique identifier of the batch. Use this value to retrieve the batch status or results. */
+    batchId: string;
+    /** The analysis mode applied to every item in this batch. */
+    analysisMode: TwelvelabsApi.AnalyzeBatchSummaryAnalysisMode;
+    /** The model used for every item in this batch. */
+    modelName: string;
+    status: TwelvelabsApi.BatchStatus;
+    /** The number of items submitted in the batch. */
+    totalItems: number;
+    /** The date and time, in the RFC 3339 format, when the batch was created. */
+    createdAt: Date;
+    /** The date and time, in the RFC 3339 format, when the batch expires (the `created_at` field value plus 24 hours). Unfinished items at expiration are canceled. Items that finished before then remain retrievable for 30 days after creation, when the batch and its results are deleted. */
+    expiresAt: Date;
+    /** The date and time, in the RFC 3339 format, when the batch status became `completed`. Present only when the status is `completed`. */
+    completedAt?: Date;
+    /** The date and time, in the RFC 3339 format, when the batch status became `canceled`. Present only when the status is `canceled`. */
+    canceledAt?: Date;
+    /** The date and time, in the RFC 3339 format, when the batch status became `expired`. Present only when the status is `expired`. */
+    expiredAt?: Date;
+}

package/api/types/AnalyzeBatchSummary.js

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

package/api/types/AnalyzeBatchSummaryAnalysisMode.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The analysis mode applied to every item in this batch.
+ */
+export type AnalyzeBatchSummaryAnalysisMode = "general" | "time_based_metadata";
+export declare const AnalyzeBatchSummaryAnalysisMode: {
+    readonly General: "general";
+    readonly TimeBasedMetadata: "time_based_metadata";
+};

package/api/types/AnalyzeBatchSummaryAnalysisMode.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.AnalyzeBatchSummaryAnalysisMode = void 0;
+exports.AnalyzeBatchSummaryAnalysisMode = {
+    General: "general",
+    TimeBasedMetadata: "time_based_metadata",
+};

package/api/types/Asset.d.ts

@@ -18,22 +18,20 @@ export interface Asset {
      */
     method?: TwelvelabsApi.AssetMethod;
     /**
-     * Indicates the current status of the asset.
+     * Indicates the current processing status of the asset.
+     *
+     * A newly uploaded asset starts in the `processing` status and transitions asynchronously to `ready` on success or to `failed` on error, typically within a few seconds to a few minutes. Poll the [Retrieve an asset](/v1.3/api-reference/upload-content/direct-uploads/retrieve) endpoint until the status is `ready` before you use the asset in downstream workflows.
      *
      * **Values**:
-     * - `failed`: The platform failed to process the upload
-     * - `processing`: The platform is processing the uploaded file
-     * - `ready`: The asset is ready to use
+     * - `processing`: The asset is not yet usable. This can mean the upload is still in progress (for example, the platform is still fetching the file from a URL, or a multipart upload has not completed), or the upload has finished and the platform is validating the file. The `technical_metadata` field is omitted from the response.
+     * - `ready`: The platform validated the asset successfully, and the asset is ready to use.
+     * - `failed`: The platform could not process the file. The `error` field describes the reason, and the `technical_metadata` field may be partially populated.
      */
     status?: TwelvelabsApi.AssetStatus;
     /** The name of the file used to create the asset. */
     filename?: string;
     /** The MIME type of the asset file. */
     fileType?: string;
-    /** The file size of the asset in bytes. This field is absent while the asset is still being processed. */
-    size?: number;
-    /** The duration of the asset in seconds. Only present for video and audio assets. This field is absent for image assets or while the asset is still being processed. */
-    duration?: number;
     /** The date and time, in RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the asset was created. */
     createdAt?: Date;
     /** User-defined metadata for this asset. This field is absent when no metadata has been set. */

package/api/types/AssetDetail.d.ts

@@ -8,4 +8,11 @@ import * as TwelvelabsApi from "../index";
 export interface AssetDetail extends TwelvelabsApi.Asset {
     hls?: TwelvelabsApi.AssetHls;
     thumbnail?: TwelvelabsApi.AssetThumbnail;
+    technicalMetadata?: TwelvelabsApi.TechnicalMetadata;
+    /** The file size of the asset in bytes. The platform finalizes this value when the asset reaches the `ready` status. */
+    size?: number;
+    /** The duration of the asset in seconds. Only present for video and audio assets; absent for images. The platform finalizes this value when the asset reaches the `ready` status. */
+    duration?: number;
+    /** The reason the asset failed. The platform returns this field only when `status` is `failed`. */
+    error?: TwelvelabsApi.AssetError;
 }

package/api/types/AssetError.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * An object that describes why an asset failed processing.
+ */
+export interface AssetError {
+    /** A human-readable message describing the failure, such as a corrupted or unsupported file, a file the platform could not access, or a video that failed a playability check. The exact text is not part of the contract. Do not parse it. */
+    message: string;
+}

package/api/types/AssetError.js

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

package/api/types/AssetStatus.d.ts

@@ -2,12 +2,14 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 /**
- * Indicates the current status of the asset.
+ * Indicates the current processing status of the asset.
+ *
+ * A newly uploaded asset starts in the `processing` status and transitions asynchronously to `ready` on success or to `failed` on error, typically within a few seconds to a few minutes. Poll the [Retrieve an asset](/v1.3/api-reference/upload-content/direct-uploads/retrieve) endpoint until the status is `ready` before you use the asset in downstream workflows.
  *
  * **Values**:
- * - `failed`: The platform failed to process the upload
- * - `processing`: The platform is processing the uploaded file
- * - `ready`: The asset is ready to use
+ * - `processing`: The asset is not yet usable. This can mean the upload is still in progress (for example, the platform is still fetching the file from a URL, or a multipart upload has not completed), or the upload has finished and the platform is validating the file. The `technical_metadata` field is omitted from the response.
+ * - `ready`: The platform validated the asset successfully, and the asset is ready to use.
+ * - `failed`: The platform could not process the file. The `error` field describes the reason, and the `technical_metadata` field may be partially populated.
  */
 export type AssetStatus = "failed" | "processing" | "ready";
 export declare const AssetStatus: {

package/api/types/AudioStream.d.ts

@@ -0,0 +1,28 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The technical properties of a single audio stream within the media file.
+ */
+export interface AudioStream {
+    /** The zero-based index of the stream within the media file. */
+    index?: number;
+    /** The codec of the audio stream. */
+    codec?: string;
+    /** The descriptive long name of the audio codec. */
+    codecLong?: string;
+    /** The sample rate of the audio stream, in hertz. */
+    sampleRate?: number;
+    /** The bit depth of the audio stream. */
+    bitDepth?: number;
+    /** The number of channels in the audio stream. */
+    channels?: number;
+    /** The channel layout of the audio stream. */
+    channelLayout?: string;
+    /** The bit rate of the audio stream, in bits per second. */
+    bitrateBps?: number;
+    /** The language of the audio stream, when present. */
+    language?: string;
+    /** The duration of the audio stream, in seconds. */
+    durationSeconds?: number;
+}

package/api/types/AudioStream.js

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

package/api/types/BatchDefaults.d.ts

@@ -0,0 +1,46 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as TwelvelabsApi from "../index";
+/**
+ * Default values applied to every item that does not override them. Every field is optional. Items in the `requests` array override these values. To override the `prompt` or `response_format` field, provide the full object on the item. You cannot change only some of its nested fields.
+ */
+export interface BatchDefaults {
+    prompt?: TwelvelabsApi.BatchPrompt;
+    responseFormat?: TwelvelabsApi.AsyncResponseFormat;
+    temperature?: TwelvelabsApi.AnalyzeTemperature;
+    /** The maximum number of tokens to generate per item. The allowed range depends on the model and analysis mode (see the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint for the per-mode table). */
+    maxTokens?: number;
+    /**
+     * Minimum duration for each extracted segment, in seconds. Applies only when the `analysis_mode` field is `time_based_metadata`.
+     *
+     * **Min:** 2
+     */
+    minSegmentDuration?: number;
+    /**
+     * Maximum duration for each extracted segment, in seconds. Must be greater than or equal to the `min_segment_duration` field. Applies only when the `analysis_mode` field is `time_based_metadata`.
+     *
+     * **Min:** 2
+     */
+    maxSegmentDuration?: number;
+    /**
+     * Start of the analysis window, in seconds, applied to every item. Use with `end_time` to analyze only the `[start_time, end_time)` portion of each video.
+     *
+     * <Note title="Notes">
+     * - If omitted, defaults to `0`.
+     * - Must be less than `end_time`.
+     * - Mutually exclusive with `response_format.segment_definitions[].time_ranges`.
+     * </Note>
+     */
+    startTime?: number;
+    /**
+     * End of the analysis window, in seconds, applied to every item. Use with `start_time` to analyze only the `[start_time, end_time)` portion of each video.
+     *
+     * <Note title="Notes">
+     * - If omitted, defaults to the video duration.
+     * - Must be greater than `start_time`.
+     * - Mutually exclusive with `response_format.segment_definitions[].time_ranges`.
+     * </Note>
+     */
+    endTime?: number;
+}

package/api/types/BatchDefaults.js

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

package/api/types/BatchItemError.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Failure details for a single batch item.
+ */
+export interface BatchItemError {
+    /** A machine-readable error code identifying the failure category. Omitted until the per-item error catalog is wired through; until then, only `message` is guaranteed. */
+    code?: string;
+    /** A human-readable explanation of the failure. */
+    message: string;
+}

package/api/types/BatchItemError.js

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

package/api/types/BatchItemRequest.d.ts

@@ -0,0 +1,36 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as TwelvelabsApi from "../index";
+/**
+ * A single analysis request inside a batch. Identify the video in the `video` field. Every other field is optional and overrides the matching field in the `defaults` object.
+ */
+export interface BatchItemRequest {
+    /** Identifies the asset to analyze. */
+    video: TwelvelabsApi.BatchVideoContext;
+    /**
+     * An optional identifier you set per item when you create the batch. Use this field to map batch results back to records in your system, for example, to correlate each result with the source video in your database.
+     *
+     * The platform stores this value unchanged. It appears in:
+     * - **Batch responses**: the array named `items` in the Create a batch response, and each line returned by the [`GET`](/v1.3/api-reference/analyze-videos/batch-analysis/retrieve-batch-results) method of the `/analyze/batches/{batch_id}/results` endpoint.
+     * - **Task responses**: each batch request creates an analysis task. The `custom_id` field appears in the [`GET`](/v1.3/api-reference/analyze-videos/retrieve-analysis-task-status-results) method of the `/analyze/tasks/{task_id}` endpoint, the [`GET`](/v1.3/api-reference/analyze-videos/list-async-analysis-tasks) method of the `/analyze/tasks` endpoint, and the `analyze.task.ready` and `analyze.task.failed` webhook payloads.
+     *
+     * **Format**: 1–64 characters. Alphanumeric, hyphens (`-`), and underscores (`_`) only. An empty string is rejected with a `400 Bad Request`.
+     *
+     * The value must be unique within a batch. Submitting two items with the same value in the `custom_id` field in the same batch returns a `400 Bad Request`. Items without a custom identifier still receive a unique task identifier generated by the platform in results.
+     */
+    customId?: string;
+    prompt?: TwelvelabsApi.BatchPrompt;
+    responseFormat?: TwelvelabsApi.AsyncResponseFormat;
+    temperature?: TwelvelabsApi.AnalyzeTemperature;
+    /** Override the `defaults.max_tokens` value for this item. */
+    maxTokens?: number;
+    /** Override the `defaults.min_segment_duration` value for this item. */
+    minSegmentDuration?: number;
+    /** Override the `defaults.max_segment_duration` value for this item. */
+    maxSegmentDuration?: number;
+    /** Override the `defaults.start_time` value for this item. */
+    startTime?: number;
+    /** Override the `defaults.end_time` value for this item. */
+    endTime?: number;
+}

package/api/types/BatchItemRequest.js

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

package/api/types/BatchItemStatus.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The status of a result entry. This field is different from the batch status. For the meaning of each value, see the [Item statuses](/v1.3/api-reference/analyze-videos/batch-analysis/the-batch-object#item-statuses) section on the **The batch object** page.
+ */
+export type BatchItemStatus = "queued" | "processing" | "ready" | "failed" | "canceled";
+export declare const BatchItemStatus: {
+    readonly Queued: "queued";
+    readonly Processing: "processing";
+    readonly Ready: "ready";
+    readonly Failed: "failed";
+    readonly Canceled: "canceled";
+};

package/api/types/BatchItemStatus.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BatchItemStatus = void 0;
+exports.BatchItemStatus = {
+    Queued: "queued",
+    Processing: "processing",
+    Ready: "ready",
+    Failed: "failed",
+    Canceled: "canceled",
+};

package/api/types/BatchPrompt.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as TwelvelabsApi from "../index";
+/**
+ * A structured prompt with `<@name>` placeholders for referencing images. Not supported when `analysis_mode` is `time_based_metadata`.
+ */
+export interface BatchPrompt {
+    /** The text of the prompt. Use `<@name>` placeholders to reference images declared in `media_sources` (Example: `"Is there a <@tiger-1> in the video?"`). This text counts toward the [context window](/v1.3/docs/concepts/models/pegasus#context-window). */
+    inputText: string;
+    /** Reference images for the `<@name>` placeholders in the prompt. Maximum 4 sources. */
+    mediaSources?: TwelvelabsApi.SmeMediaSource[];
+}

package/api/types/BatchPrompt.js

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

package/api/types/BatchResultItem.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as TwelvelabsApi from "../index";
+/**
+ * One result entry per item. Result entries in the `ready` status include the `data` field. Result entries in the `failed` status include the `error` field. Result entries in the `queued`, `processing`, or `canceled` status include neither field.
+ */
+export interface BatchResultItem {
+    /** The unique task identifier generated by the platform for this item. */
+    taskId: string;
+    /** The custom identifier you provided when you created the batch. If you did not provide one, this field is `null`. */
+    customId?: string;
+    status: TwelvelabsApi.BatchItemStatus;
+    /** Contains the analysis result for an item in the `ready` status. The analysis text is in this object's nested `data` field. The envelope uses the same schema as the `result` field in the [`GET`](/v1.3/api-reference/analyze-videos/retrieve-analysis-task-status-results) method of the `/analyze/tasks/{task_id}` endpoint. */
+    data?: TwelvelabsApi.AnalyzeTaskResult;
+    error?: TwelvelabsApi.BatchItemError;
+}

package/api/types/BatchResultItem.js

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

package/api/types/BatchStatus.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The status of a batch. For the meaning of each value, see the [Batch statuses](/v1.3/api-reference/analyze-videos/batch-analysis/the-batch-object#batch-statuses) section on the **The batch object** page.
+ */
+export type BatchStatus = "pending" | "processing" | "canceling" | "canceled" | "completed" | "expired";
+export declare const BatchStatus: {
+    readonly Pending: "pending";
+    readonly Processing: "processing";
+    readonly Canceling: "canceling";
+    readonly Canceled: "canceled";
+    readonly Completed: "completed";
+    readonly Expired: "expired";
+};

package/api/types/BatchStatus.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BatchStatus = void 0;
+exports.BatchStatus = {
+    Pending: "pending",
+    Processing: "processing",
+    Canceling: "canceling",
+    Canceled: "canceled",
+    Completed: "completed",
+    Expired: "expired",
+};

package/api/types/BatchVideoContext.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as TwelvelabsApi from "../index";
+/**
+ * Identifies the asset to analyze.
+ */
+export interface BatchVideoContext {
+    /** Set this field to `asset_id` to indicate that you're providing the video as an asset. */
+    type: TwelvelabsApi.BatchVideoContextType;
+    /** The unique identifier of an asset from a [direct](/v1.3/api-reference/upload-content/direct-uploads) or [multipart](/v1.3/api-reference/upload-content/multipart-uploads) upload. The asset status must be `ready`. Use the [Retrieve an asset](/v1.3/api-reference/upload-content/direct-uploads/retrieve) method to check the status. */
+    assetId: string;
+}

package/api/types/BatchVideoContext.js

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

package/api/types/BatchVideoContextType.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Set this field to `asset_id` to indicate that you're providing the video as an asset.
+ */
+export type BatchVideoContextType = "asset_id";
+export declare const BatchVideoContextType: {
+    readonly AssetId: "asset_id";
+};

package/api/types/BatchVideoContextType.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.BatchVideoContextType = void 0;
+exports.BatchVideoContextType = {
+    AssetId: "asset_id",
+};

package/api/types/CreateAnalyzeBatchResponse.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as TwelvelabsApi from "../index";
+/**
+ * Response when creating a new batch.
+ */
+export interface CreateAnalyzeBatchResponse {
+    /** The unique identifier of the batch. */
+    batchId: string;
+    status: TwelvelabsApi.BatchStatus;
+    /** The number of items submitted in the batch. */
+    totalItems: number;
+    /** The date and time, in the RFC 3339 format, when the batch was created. */
+    createdAt: Date;
+    /** The date and time, in the RFC 3339 format, when the batch expires (the `created_at` field value plus 24 hours). Unfinished items at expiration are canceled. Items that finished before then remain retrievable for 30 days after creation, when the batch and its results are deleted. */
+    expiresAt: Date;
+    /** One entry per submitted item. Each entry pairs the unique task identifier generated by the platform with the custom identifier you provided when you created the batch. */
+    items: TwelvelabsApi.CreatedBatchItem[];
+}

package/api/types/CreateAnalyzeBatchResponse.js

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

package/api/types/CreatedBatchItem.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * One submitted item in the Create a batch response.
+ */
+export interface CreatedBatchItem {
+    /** The unique task identifier generated by the platform for this item. Use this value with the [`GET`](/v1.3/api-reference/analyze-videos/retrieve-analysis-task-status-results) method of the `/analyze/tasks/{task_id}` endpoint to retrieve the task's status and results. */
+    taskId: string;
+    /** The custom identifier you provided when you created the batch. If you did not provide one, this field is `null`. */
+    customId?: string;
+}

package/api/types/CreatedBatchItem.js

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

package/api/types/EmbeddingTaskResponse.d.ts

@@ -15,7 +15,7 @@ export interface EmbeddingTaskResponse {
      * **Values**:
      * - `processing`: The platform is creating the embeddings
      * - `ready`: Processing is complete. Embeddings are available in the `data` field
-     * - `failed`: The task failed. The `data` field is `null`
+     * - `failed`: The task failed. The `data` field is `null`, and the [`error.message`](/v1.3/api-reference/create-embeddings-v2/retrieve-embeddings#response.body.error.message) field contains the reason
      */
     status: TwelvelabsApi.EmbeddingTaskResponseStatus;
     createdAt?: TwelvelabsApi.CreatedAt;

package/api/types/EmbeddingTaskResponseError.d.ts

@@ -8,8 +8,8 @@ export interface EmbeddingTaskResponseError {
     /**
      * A human-readable message that describes why the task failed. Possible values:
      * - "The embedding service is temporarily unstable. Please try again later."
-     * - "We could not process your media for embedding. Please verify the input file and try again."
      * - "The embedding task failed. Please try again later."
+     * - "We could not process your media for embedding. Please verify the input file and try again." For the steps to fix the file, see the [How do I fix a file that could not be processed for embedding?](/v1.3/docs/resources/frequently-asked-questions#how-do-i-fix-a-file-that-could-not-be-processed-for-embedding) section on the **Frequently asked questions** page.
      */
     message: string;
 }

package/api/types/EmbeddingTaskResponseStatus.d.ts

@@ -8,7 +8,7 @@
  * **Values**:
  * - `processing`: The platform is creating the embeddings
  * - `ready`: Processing is complete. Embeddings are available in the `data` field
- * - `failed`: The task failed. The `data` field is `null`
+ * - `failed`: The task failed. The `data` field is `null`, and the [`error.message`](/v1.3/api-reference/create-embeddings-v2/retrieve-embeddings#response.body.error.message) field contains the reason
  */
 export type EmbeddingTaskResponseStatus = "processing" | "ready" | "failed";
 export declare const EmbeddingTaskResponseStatus: {