Authentication

To make HTTP requests, you must include the API key in the header of each request.

Prerequisites

To use the platform, you need an API key:

If you don’t have an account, sign up for a free account.

Go to the API Keys page.

If you need to create a new key, select the Create API Key button. Enter a name and set the expiration period. The default is 12 months.

Select the Copy icon next to your key to copy it to your clipboard.

Procedure

Verify that the required packages are installed on your system. If necessary, install the following packages:

Python

Node.js

Install the requests package by entering the following command:

$ python -m pip install requests

Define the URL of the API and the specific endpoint for your request.

Create the necessary headers for authentication.

Prepare the data payload for your API request.

Send the API request and process the response.

Below are complete code examples for Python and Node.js, integrating all the steps outlined above:

1 import requests
2 
3 # Step 2: Define the API URL and the specific endpoint
4 API_URL = "https://api.twelvelabs.io/v1.3"
5 INDEXES_URL = f"{API_URL}/indexes"
6 
7 # Step 3: Create the necessary headers for authentication
8 headers = {
9     "x-api-key": "<YOUR_API_KEY>"
10 }
11 
12 # Step 4: Prepare the data payload for your API request
13 INDEX_NAME = "<YOUR_INDEX_NAME>"
14 data = {
15     "models": [
16         {
17             "model_name": "marengo3.0",
18             "model_options": ["visual", "audio"]
19         }
20     ],
21     "index_name": INDEX_NAME
22 }
23 
24 # Step 5: Send the API request and process the response
25 response = requests.post(INDEXES_URL, headers=headers, json=data)
26 print(f"Status code: {response.status_code}")
27 if response.status_code == 201:
28     print(response.json())
29 else:
30     print("Error:", response.json())

1	import requests
2
3	# Step 2: Define the API URL and the specific endpoint
4	API_URL = "https://api.twelvelabs.io/v1.3"
5	INDEXES_URL = f"{API_URL}/indexes"
6
7	# Step 3: Create the necessary headers for authentication
8	headers = {
9	"x-api-key": "<YOUR_API_KEY>"
10	}
11
12	# Step 4: Prepare the data payload for your API request
13	INDEX_NAME = "<YOUR_INDEX_NAME>"
14	data = {
15	"models": [
16	{
17	"model_name": "marengo3.0",
18	"model_options": ["visual", "audio"]
19	}
20	],
21	"index_name": INDEX_NAME
22	}
23
24	# Step 5: Send the API request and process the response
25	response = requests.post(INDEXES_URL, headers=headers, json=data)
26	print(f"Status code: {response.status_code}")
27	if response.status_code == 201:
28	print(response.json())
29	else:
30	print("Error:", response.json())