twelvelabs-js 1.2.2 → 1.2.3

package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem {
+    name: string;
+    mediaType: string;
+    url?: string;
+    assetId?: string;
+}

package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.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/AnalyzeTaskResponseRequestParamsResponseFormatType.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type AnalyzeTaskResponseRequestParamsResponseFormatType = "json_schema" | "segment_definitions";
+export declare const AnalyzeTaskResponseRequestParamsResponseFormatType: {
+    readonly JsonSchema: "json_schema";
+    readonly SegmentDefinitions: "segment_definitions";
+};

package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatType.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.AnalyzeTaskResponseRequestParamsResponseFormatType = void 0;
+exports.AnalyzeTaskResponseRequestParamsResponseFormatType = {
+    JsonSchema: "json_schema",
+    SegmentDefinitions: "segment_definitions",
+};

package/api/types/AnalyzeTaskResponseVideoSource.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as TwelvelabsApi from "../index";
+/**
+ * The video source you provided. Only present for tasks that use direct video input (`url`, `base64_string`, or `asset_id`).
+ */
+export interface AnalyzeTaskResponseVideoSource {
+    /** The type of video source. */
+    type?: TwelvelabsApi.AnalyzeTaskResponseVideoSourceType;
+    /** The video URL. Present when `type` is `url`. */
+    url?: string;
+    /** The asset ID. Present when `type` is `asset_id`. */
+    assetId?: string;
+    /** The video ID. Present when `type` is `video_id`. Deprecated — use `asset_id` instead. */
+    videoId?: string;
+    /** System-extracted video metadata. Present on a best-effort basis once the video has been processed. */
+    systemMetadata?: TwelvelabsApi.AnalyzeTaskResponseVideoSourceSystemMetadata;
+}

package/api/types/AnalyzeTaskResponseVideoSource.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/AnalyzeTaskResponseVideoSourceSystemMetadata.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * System-extracted video metadata. Present on a best-effort basis once the video has been processed.
+ */
+export interface AnalyzeTaskResponseVideoSourceSystemMetadata {
+    /** The video duration in seconds. */
+    duration?: number;
+}

package/api/types/AnalyzeTaskResponseVideoSourceSystemMetadata.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/AnalyzeTaskResponseVideoSourceType.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The type of video source.
+ */
+export type AnalyzeTaskResponseVideoSourceType = "url" | "base64_string" | "asset_id" | "video_id";
+export declare const AnalyzeTaskResponseVideoSourceType: {
+    readonly Url: "url";
+    readonly Base64String: "base64_string";
+    readonly AssetId: "asset_id";
+    readonly VideoId: "video_id";
+};

package/api/types/AnalyzeTaskResponseVideoSourceType.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnalyzeTaskResponseVideoSourceType = void 0;
+exports.AnalyzeTaskResponseVideoSourceType = {
+    Url: "url",
+    Base64String: "base64_string",
+    AssetId: "asset_id",
+    VideoId: "video_id",
+};

package/api/types/AnalyzeTaskResult.d.ts

@@ -8,7 +8,16 @@ import * as TwelvelabsApi from "../index";
 export interface AnalyzeTaskResult {
     /** The unique identifier for the generation session. */
     generationId: string;
-    data: TwelvelabsApi.GeneratedTextData;
+    /**
+     * The generated text for this analysis task. The format depends on the `analysis_mode` used when creating the task:
+     *
+     * - **When `analysis_mode` is not set**: A plain-text string containing the generated text based on the prompt you provided.
+     * - **When `analysis_mode` is `time_based_metadata`** (requires `model_name` set to `pegasus1.5`): A JSON-encoded string containing an object keyed by segment definition (the `id` field). Each key maps to an array of segment objects with the following fields:
+     *   - `start_time` (number): The start time of the segment in seconds.
+     *   - `end_time` (number): The end time of the segment in seconds.
+     *   - `metadata` (object): The custom fields you defined in the request's `segment_definitions[].fields`.
+     */
+    data: string;
     finishReason: TwelvelabsApi.FinishReason;
     /** The number of tokens used in the generation. */
     usage: TwelvelabsApi.AnalyzeTaskResultUsage;

package/api/types/Asset.d.ts

@@ -14,6 +14,7 @@ export interface Asset {
      * **Values**:
      * - `direct`: Uploaded from your local file system
      * - `url`: Uploaded from a publicly accessible URL
+     * - `multipart`: Uploaded using the multipart upload flow
      */
     method?: TwelvelabsApi.AssetMethod;
     /**
@@ -29,6 +30,10 @@ export interface 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;
 }

package/api/types/AssetDetail.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as TwelvelabsApi from "../index";
+/**
+ * An asset with additional processing details such as HLS streaming and thumbnail information.
+ */
+export interface AssetDetail extends TwelvelabsApi.Asset {
+    hls?: TwelvelabsApi.AssetHls;
+    thumbnail?: TwelvelabsApi.AssetThumbnail;
+}

package/api/types/AssetDetail.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/AssetHls.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as TwelvelabsApi from "../index";
+/**
+ * HLS streaming details for the asset. Present only when HLS generation has been requested. Omitted otherwise.
+ */
+export interface AssetHls {
+    /** The URL of the HLS manifest file for streaming. Only present when the status of the HLS stream is `ready`. */
+    manifestUrl?: string;
+    /**
+     * The status of the HLS stream.
+     *
+     * **Values**:
+     * - `pending`: The platform has not yet started HLS generation
+     * - `processing`: The platform is generating HLS segments
+     * - `ready`: The HLS stream is ready for playback
+     * - `error`: HLS generation failed
+     */
+    status?: TwelvelabsApi.AssetHlsStatus;
+}

package/api/types/AssetHls.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/AssetHlsStatus.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The status of the HLS stream.
+ *
+ * **Values**:
+ * - `pending`: The platform has not yet started HLS generation
+ * - `processing`: The platform is generating HLS segments
+ * - `ready`: The HLS stream is ready for playback
+ * - `error`: HLS generation failed
+ */
+export type AssetHlsStatus = "pending" | "processing" | "ready" | "error";
+export declare const AssetHlsStatus: {
+    readonly Pending: "pending";
+    readonly Processing: "processing";
+    readonly Ready: "ready";
+    readonly Error: "error";
+};

package/api/types/AssetHlsStatus.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssetHlsStatus = void 0;
+exports.AssetHlsStatus = {
+    Pending: "pending",
+    Processing: "processing",
+    Ready: "ready",
+    Error: "error",
+};

package/api/types/AssetMethod.d.ts

@@ -7,9 +7,11 @@
  * **Values**:
  * - `direct`: Uploaded from your local file system
  * - `url`: Uploaded from a publicly accessible URL
+ * - `multipart`: Uploaded using the multipart upload flow
  */
-export type AssetMethod = "direct" | "url";
+export type AssetMethod = "direct" | "url" | "multipart";
 export declare const AssetMethod: {
     readonly Direct: "direct";
     readonly Url: "url";
+    readonly Multipart: "multipart";
 };

package/api/types/AssetMethod.js

@@ -7,4 +7,5 @@ exports.AssetMethod = void 0;
 exports.AssetMethod = {
     Direct: "direct",
     Url: "url",
+    Multipart: "multipart",
 };

package/api/types/AssetThumbnail.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as TwelvelabsApi from "../index";
+/**
+ * Thumbnail details for the asset. Present only when thumbnail generation has been requested. Omitted otherwise.
+ */
+export interface AssetThumbnail {
+    /** The URL of the representative thumbnail image. Only present when the status of the thumbnail is `ready`. */
+    representativeUrl?: string;
+    /**
+     * The status of the thumbnail.
+     *
+     * **Values**:
+     * - `pending`: The platform has not yet started thumbnail generation
+     * - `processing`: The platform is generating the thumbnail
+     * - `ready`: The thumbnail is ready
+     * - `error`: Thumbnail generation failed
+     */
+    status?: TwelvelabsApi.AssetThumbnailStatus;
+}

package/api/types/AssetThumbnail.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/AssetThumbnailStatus.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The status of the thumbnail.
+ *
+ * **Values**:
+ * - `pending`: The platform has not yet started thumbnail generation
+ * - `processing`: The platform is generating the thumbnail
+ * - `ready`: The thumbnail is ready
+ * - `error`: Thumbnail generation failed
+ */
+export type AssetThumbnailStatus = "pending" | "processing" | "ready" | "error";
+export declare const AssetThumbnailStatus: {
+    readonly Pending: "pending";
+    readonly Processing: "processing";
+    readonly Ready: "ready";
+    readonly Error: "error";
+};

package/api/types/AssetThumbnailStatus.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssetThumbnailStatus = void 0;
+exports.AssetThumbnailStatus = {
+    Pending: "pending",
+    Processing: "processing",
+    Ready: "ready",
+    Error: "error",
+};

package/api/types/AsyncResponseFormat.d.ts

@@ -0,0 +1,89 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as TwelvelabsApi from "../index";
+/**
+ * Controls the response format. When you omit this parameter, you receive unstructured text.
+ * - `json_schema`: Return structured JSON that conforms to your schema.
+ * - `segment_definitions`: Extract timestamped metadata with custom fields from your video. Requires `model_name` set to `pegasus1.5` and `analysis_mode` set to `time_based_metadata`.
+ */
+export interface AsyncResponseFormat {
+    /**
+     * The response format to use.
+     * - `json_schema`: Return structured JSON that conforms to your schema.
+     * - `segment_definitions`: Extract timestamped metadata with custom fields from your video. Requires `model_name` set to `pegasus1.5` and `analysis_mode` set to `time_based_metadata`.
+     */
+    type: TwelvelabsApi.AsyncResponseFormatType;
+    /**
+     * Contains the JSON schema that defines the response structure. The schema must adhere to the [JSON Schema Draft 2020-12](https://json-schema.org/draft/2020-12) specification.
+     *
+     * **Supported types**
+     * - `array`
+     * - `boolean`
+     * - `integer`
+     * - `null`
+     * - `number`
+     * - `object`
+     * - `string`
+     *
+     * **Supported constraints**
+     *
+     * | 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. |
+     * | `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` |
+     *
+     *
+     * **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."
+     *
+     *
+     * **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.
+     *
+     *
+     * **Constant and enumerated values**
+     *
+     * The `const` and `enum` keywords support the following types:
+     * - `boolean`
+     * - `null`
+     * - `number`
+     * - `string`
+     *
+     *
+     * **Schema composition**
+     *
+     * The platform supports only `anyOf` for [schema composition](https://json-schema.org/understanding-json-schema/reference/combining).
+     *
+     *
+     * **Annotations**
+     *
+     * The platform accepts but ignores JSON schema annotations like `title`, `$comments`, and `description`.
+     *
+     * **Subschema references**
+     *
+     * You can reference subschemas using `$ref` with these requirements:
+     * - Define subschemas within `$defs`.
+     * - Use valid URIs that point to the internal subschema.
+     *
+     * For details, see the [JSON Schema documentation on $defs](https://json-schema.org/understanding-json-schema/structuring#defs).
+     *
+     *
+     *
+     * **Response validation**
+     *
+     * Check the `FinishReason` field to verify your JSON response is complete:
+     * - When `FinishReason` is `stop`, the generation completed normally, and the JSON is valid and complete.
+     * - When `FinishReason` is `length`, the platform truncates the response at the token limit. This may result in truncated, invalid JSON that fails to parse.
+     */
+    jsonSchema?: Record<string, unknown>;
+    /** Define the types of segments to extract from your video. Minimum 1, maximum 10 definitions. */
+    segmentDefinitions?: TwelvelabsApi.SegmentDefinition[];
+}

package/api/types/AsyncResponseFormat.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/AsyncResponseFormatType.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The response format to use.
+ * - `json_schema`: Return structured JSON that conforms to your schema.
+ * - `segment_definitions`: Extract timestamped metadata with custom fields from your video. Requires `model_name` set to `pegasus1.5` and `analysis_mode` set to `time_based_metadata`.
+ */
+export type AsyncResponseFormatType = "json_schema" | "segment_definitions";
+export declare const AsyncResponseFormatType: {
+    readonly JsonSchema: "json_schema";
+    readonly SegmentDefinitions: "segment_definitions";
+};

package/api/types/AsyncResponseFormatType.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.AsyncResponseFormatType = void 0;
+exports.AsyncResponseFormatType = {
+    JsonSchema: "json_schema",
+    SegmentDefinitions: "segment_definitions",
+};

package/api/types/ConflictErrorBody.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ConflictErrorBody {
+    /** A string representing the code associated with the error. See the [Error codes](/v1.3/api-reference/error-codes) page for details. */
+    code?: string;
+    /** A human-readable string describing the error, intended to be suitable for display in a user interface. */
+    message?: string;
+    /** The URL of the relevant documentation page. */
+    docsUrl?: string;
+}

package/api/types/ConflictErrorBody.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/Entity.d.ts

@@ -8,6 +8,8 @@ import * as TwelvelabsApi from "../index";
 export interface Entity {
     /** The unique identifier of the entity. */
     id?: string;
+    /** The unique identifier of the entity collection this entity belongs to. */
+    entityCollectionId?: string;
     /** The name of the entity. */
     name?: string;
     /** A description of the entity. */

package/api/types/IndexedAsset.d.ts

@@ -8,6 +8,8 @@ import * as TwelvelabsApi from "../index";
 export interface IndexedAsset {
     /** A string representing the unique identifier of your indexed asset. */
     id?: string;
+    /** The unique identifier of the associated asset. */
+    assetId?: string;
     /** A string indicating the date and time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), that the indexing task was created. */
     createdAt?: string;
     /** A string indicating the date and time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), that the indexing task was last updated. The platform updates this field every time the indexing task transitions to a different state. */

package/api/types/IndexedAssetSummary.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as TwelvelabsApi from "../index";
+/**
+ * The identifier and index of an indexed asset that references the specified asset.
+ */
+export interface IndexedAssetSummary {
+    /** The unique identifier of the indexed asset. */
+    id?: string;
+    index?: TwelvelabsApi.IndexedAssetSummaryIndex;
+}

package/api/types/IndexedAssetSummary.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/IndexedAssetSummaryIndex.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The index to which the indexed asset belongs.
+ */
+export interface IndexedAssetSummaryIndex {
+    /** The unique identifier of the index. */
+    id?: string;
+    /** The name of the index. */
+    name?: string;
+}

package/api/types/IndexedAssetSummaryIndex.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/IndexedAssetsListRequestDuration.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface IndexedAssetsListRequestDuration {
+    gte?: number;
+    lte?: number;
+}

package/api/types/IndexedAssetsListRequestDuration.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/IndexedAssetsListRequestFps.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface IndexedAssetsListRequestFps {
+    gte?: number;
+    lte?: number;
+}

package/api/types/IndexedAssetsListRequestFps.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/IndexedAssetsListRequestHeight.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface IndexedAssetsListRequestHeight {
+    gte?: number;
+    lte?: number;
+}

package/api/types/IndexedAssetsListRequestHeight.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/IndexedAssetsListRequestSize.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface IndexedAssetsListRequestSize {
+    gte?: number;
+    lte?: number;
+}

package/api/types/IndexedAssetsListRequestSize.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/IndexedAssetsListRequestWidth.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface IndexedAssetsListRequestWidth {
+    gte?: number;
+    lte?: number;
+}

package/api/types/IndexedAssetsListRequestWidth.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/InternalEntity.d.ts

@@ -5,11 +5,33 @@ import * as TwelvelabsApi from "../index";
 /**
  * An object that extends the Entity schema with additional collection information.
  */
-export interface InternalEntity extends TwelvelabsApi.Entity {
+export interface InternalEntity {
     /** The unique identifier of the entity collection the entity belongs to. */
     entityCollectionId?: string;
     /** The name of the entity collection the entity belongs to. */
     entityCollectionName?: string;
     /** An array of URLs for the assets associated with the entity. */
     assetUrls?: string[];
+    /** The unique identifier of the entity. */
+    id?: string;
+    /** The name of the entity. */
+    name?: string;
+    /** A description of the entity. */
+    description?: string;
+    /** Custom metadata for the entity. */
+    metadata?: Record<string, unknown>;
+    /** An array of asset IDs associated with the entity. */
+    assetIds?: string[];
+    /**
+     * The current status of the entity creation process.
+     *
+     * **Values**:
+     * - `processing`: The entity is being processed and is not yet ready for use in searches.
+     * - `ready`: The entity is fully processed and can be used in search queries.
+     */
+    status?: TwelvelabsApi.EntityStatus;
+    /** The date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the entity was created. */
+    createdAt?: Date;
+    /** The date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the entity was last updated. */
+    updatedAt?: Date;
 }