This section shows how to transfer the files from your AWS S3 bucket to Twelve Labs and index them.

📘

Note

The platform checks for duplicate files using hashes and will not upload the same video to the same index twice.

You can interact with the platform using one of the available SDKs or an HTTP client like requests or axios. This guide demonstrates how to use the SDKs, the recommended approach for most scenarios. If you need to make direct HTTP requests, refer to the API Reference > Make a cloud-to-cloud transfer page for details.

Prerequisites

• Before you can download the list of files in your AWS S3 bucket, you must set up an integration.

Procedure

1. Import the required packages into your application:
   PythonNode.js

   from twelvelabs import TwelveLabs
   from twelvelabs.models.task import Task
   

   import { TwelveLabs, Task } from 'twelvelabs-js';
   import * as fs from 'fs';
   

2. Instantiate the SDK client with your API key:
   PythonNode.js

   client = TwelveLabs(api_key="<YOUR_API_KEY>")
   

   const client = new TwelveLabs({ apiKey: '<YOUR_API_KEY>' });
   

3. To perform a cloud-to-cloud transfer, invoke the transfer method of the task object, passing it a string representing the path to your JSON file as a parameter:
   PythonNode.js

   client.task.transfer(file="<YOUR_JSON_FILE>")
   

   client.task.transfer(fs.createReadStream('<YOUR_JSON_FILE>'));
   

Note that, once you've uploaded a video and the platform has finished indexing it, you can provide custom metadata. You can use custom metadata to filter search results or videos.