Import videos | TwelveLabs

An import represents the process of uploading and indexing all videos from the specified integration.

This method initiates an asynchronous import and returns two lists:

Videos that will be imported.
Videos that will not be imported, typically because they do not meet the prerequisites of all enabled video understanding models for your index. Note that the most restrictive prerequisites among the enabled models will apply.

The actual uploading and indexing of videos occur asynchronously after you invoke this method. To monitor the status of each upload after invoking this method, use the Retrieve import status method.

Video requirements

The videos you wish to upload must meet the following requirements:

Video resolution: Must be at least 360x360 and must not exceed 3840x2160.
Aspect ratio: Must be between 1:1 and 1:2.4, or between 2.4:1 and 1:1. For example, you can use 1:1, 4:3, 4:5, 5:4, 16:9, 9:16, or 17:9.
Video and audio formats: Your video files must be encoded in the video and audio formats listed on the FFmpeg Formats Documentation page. For videos in other formats, contact us at support@twelvelabs.io.
Duration: For Marengo, it must be between 4 seconds and 2 hours (7,200s). For Pegasus, it must be between 4 seconds and 60 minutes (3600s). In a future release, the maximum duration for Pegasus will be 2 hours (7,200 seconds).
File size: Must not exceed 2 GB. If you require different options, contact us at support@twelvelabs.io.

If both Marengo and Pegasus are enabled for your index, the most restrictive prerequisites will apply.

Notes

Before importing videos, you must set up an integration. For details, see the Set up an integration section.
By default, the platform checks for duplicate files using hashes within the target index and will not upload the same video to the same index twice. However, the same video can exist in multiple indexes. To bypass duplicate checking entirely and import duplicate videos into the same index, set the value of the incremental_import parameter to false.
Only one import job can run at a time. To start a new import, wait for the current job to complete. Use the GET method of the /tasks/transfers/import/{integration-id}/logs endpoint to retrieve a list of your import jobs, including their creation time, completion time, and processing status for each video file.

An import represents the process of uploading and indexing all videos from the specified integration. This method initiates an asynchronous import and returns two lists: - Videos that will be imported. - Videos that will not be imported, typically because they do not meet the prerequisites of all enabled video understanding models for your index. Note that the most restrictive prerequisites among the enabled models will apply. The actual uploading and indexing of videos occur asynchronously after you invoke this method. To monitor the status of each upload after invoking this method, use the [Retrieve import status](/v1.3/api-reference/tasks/cloud-to-cloud-integrations/get-status) method. <Accordion title="Video requirements"> The videos you wish to upload must meet the following requirements: - **Video resolution**: Must be at least 360x360 and must not exceed 3840x2160. - **Aspect ratio**: Must be between 1:1 and 1:2.4, or between 2.4:1 and 1:1. For example, you can use 1:1, 4:3, 4:5, 5:4, 16:9, 9:16, or 17:9. - **Video and audio formats**: Your video files must be encoded in the video and audio formats listed on the [FFmpeg Formats Documentation](https://ffmpeg.org/ffmpeg-formats.html) page. For videos in other formats, contact us at support@twelvelabs.io. - **Duration**: For Marengo, it must be between 4 seconds and 2 hours (7,200s). For Pegasus, it must be between 4 seconds and 60 minutes (3600s). In a future release, the maximum duration for Pegasus will be 2 hours (7,200 seconds). - **File size**: Must not exceed 2 GB. If you require different options, contact us at support@twelvelabs.io. If both Marengo and Pegasus are enabled for your index, the most restrictive prerequisites will apply. </Accordion> <Note title="Notes"> - Before importing videos, you must set up an integration. For details, see the [Set up an integration](/v1.3/docs/advanced/cloud-to-cloud-integrations#set-up-an-integration) section. - By default, the platform checks for duplicate files using hashes within the target index and will not upload the same video to the same index twice. However, the same video can exist in multiple indexes. To bypass duplicate checking entirely and import duplicate videos into the same index, set the value of the `incremental_import` parameter to `false`. - Only one import job can run at a time. To start a new import, wait for the current job to complete. Use the [`GET`](/v1.3/api-reference/tasks/cloud-to-cloud-integrations/get-status) method of the `/tasks/transfers/import/{integration-id}/logs` endpoint to retrieve a list of your import jobs, including their creation time, completion time, and processing status for each video file. </Note>

Authentication

x-api-keystring

Your API key.

Note

You can find your API key on the API Key page.

Your API key. <Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-key" target="_blank">API Key</a> page. </Note>

Path parameters

integration-idstringRequired

The unique identifier of the integration for which you want to import videos. You can retrieve it from the Integrations page.

The unique identifier of the integration for which you want to import videos. You can retrieve it from the [Integrations](https://playground.twelvelabs.io/dashboard/integrations) page.

Request

Request to import videos from a cloud storage bucket to an index.

index_idstringRequired

The unique identifier of the index to which the videos are being uploaded.

incremental_importbooleanOptionalDefaults to true

Specifies whether or not incremental sync is enabled. If set to false, the platform will synchronize all the files in the bucket.

Default: true.

retry_failedbooleanOptionalDefaults to false

Determines whether the platform retries failed uploads. When set to true, the platform attempts to re-upload files that failed during the initial upload process.

Default: false.

user_metadatamap from strings to anyOptional

Metadata that helps you categorize your videos. You can specify a list of keys and values. Keys must be of type string, and values can be of the following types: string, integer, float or boolean.

Notes

The metadata you specify when calling this method applies to all videos imported in this request.
If you want to store other types of data such as objects or arrays, you must convert your data into string values.
You cannot override any of the predefined metadata (example: duration, width, length, etc) associated with a video.

Metadata that helps you categorize your videos. You can specify a list of keys and values. Keys must be of type `string`, and values can be of the following types: `string`, `integer`, `float` or `boolean`. <Note title="Notes"> - The metadata you specify when calling this method applies to all videos imported in this request. - If you want to store other types of data such as objects or arrays, you must convert your data into string values. - You cannot override any of the predefined metadata (example: duration, width, length, etc) associated with a video. </Note>

Response

An import has successfully been initiated.

failed_fileslist of objects or null

A list of the video files that failed to import. Typically, these files did not meet the upload requirements. To resolve this, review the video requirements listed above.

videoslist of objects or null

A list of the videos that will be uploaded and indexed.

Errors

An import represents the process of uploading and indexing all videos from the specified integration.

This method initiates an asynchronous import and returns two lists:

Videos that will be imported.
Videos that will not be imported, typically because they do not meet the prerequisites of all enabled video understanding models for your index. Note that the most restrictive prerequisites among the enabled models will apply.

The actual uploading and indexing of videos occur asynchronously after you invoke this method. To monitor the status of each upload after invoking this method, use the Retrieve import status method.

Video requirements

The videos you wish to upload must meet the following requirements:

Video resolution: Must be at least 360x360 and must not exceed 3840x2160.
Aspect ratio: Must be between 1:1 and 1:2.4, or between 2.4:1 and 1:1. For example, you can use 1:1, 4:3, 4:5, 5:4, 16:9, 9:16, or 17:9.
Video and audio formats: Your video files must be encoded in the video and audio formats listed on the FFmpeg Formats Documentation page. For videos in other formats, contact us at support@twelvelabs.io.
Duration: For Marengo, it must be between 4 seconds and 2 hours (7,200s). For Pegasus, it must be between 4 seconds and 60 minutes (3600s). In a future release, the maximum duration for Pegasus will be 2 hours (7,200 seconds).
File size: Must not exceed 2 GB. If you require different options, contact us at support@twelvelabs.io.

If both Marengo and Pegasus are enabled for your index, the most restrictive prerequisites will apply.

Notes

Before importing videos, you must set up an integration. For details, see the Set up an integration section.
By default, the platform checks for duplicate files using hashes within the target index and will not upload the same video to the same index twice. However, the same video can exist in multiple indexes. To bypass duplicate checking entirely and import duplicate videos into the same index, set the value of the incremental_import parameter to false.
Only one import job can run at a time. To start a new import, wait for the current job to complete. Use the GET method of the /tasks/transfers/import/{integration-id}/logs endpoint to retrieve a list of your import jobs, including their creation time, completion time, and processing status for each video file.

1	curl -X POST https://api.twelvelabs.io/v1.3/tasks/transfers/import/6298d673f1090f1100476d4c \
2	-H "x-api-key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"index_id": "6298d673f1090f1100476d4c",
6	"incremental_import": true,
7	"retry_failed": false,
8	"user_metadata": {
9	"category": "recentlyAdded",
10	"batchNumber": 5
11	}
12	}'

1	{
2	"failed_files": [
3	{
4	"filename": "1.mp4",
5	"error_message": "The video is too big. Please use a video with a size less than %s. The current size is %s."
6	}
7	],
8	"videos": [
9	{
10	"video_id": "66fcee250f9f7bcce21915a2",
11	"filename": "1.mp4"
12	}
13	]
14	}