The API uses keys for authentication, and your key is similar to a password. Avoid distributing your API key to other users, or hard-coding it. Generate a new key whenever you think your account may have been compromised.

For security reasons, your API key automatically expires every 90 days. When your key has expired, you must generate a new one to continue using the API.

Before you begin, sign up for a free account, or if you already have one, sign in.

The process of managing your API key can be divided into the following tasks:

• Retrieve your API key: Go to the API Key page, and select the Copy icon to the right of the key to copy it to your clipboard.
• Generate a new API key: Go to the API Key page, and then select the Regenerate Key button under the API Key section.
• Revoke an API key: Go to the API Key page, and then select the Revoke Key button under the API Key section.

You can interact with the platform using an available SDK or an HTTP client like requests or axios. Follow the steps in one of the sections below, depending on your use case.

Use an SDK

If you are using an SDK client, provide your API key when instantiating the client.

$
pip install twelvelabs

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

1
# Step 2: Import the SDK
2
from twelvelabs import TwelveLabs
3
4
# Step 3: Instantiate the SDK client
5
client = TwelveLabs(api_key="<YOUR_API_KEY>")
6
7
# Step 4: Use the SDK to create an index
8
index = client.index.create(
9
    name="<YOUR_INDEX_NAME>",
10
    models=[
11
        {
12
            "name": "marengo2.7",
13
            "options": ["visual", "audio"]
14
        }
15
    ]
16
)
17
print(f"Created index: id={index.id}")

Use an HTTP client

If you are making HTTP requests using clients such as requests or axios, include the API key in the header of each request.

$
python -m pip install requests

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": "marengo2.7",
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())