API keys

What are aiXplain API Keys?

There are two types of API keys:

1. Admin API Keys
   Admin API keys are for configuring and monitor rate limits. These keys are solely for management and cannot be used for inference. Learn more in the How to configure model rate limiting guide.

2. Member API Keys
   Member API Keys (or API Keys for short) allow you to call aiXplain assets and services outside of Studio. E.g. via the aiXplain SDK or HTTP requests. See examples below.

Manage API Keys

Create and delete API keys for any given team in its Integrations page.

The Integrations page

Access the Integrations page using the dropdown next to your name.

Creating an API Key

1. Clicking the Create an access key button.
2. Specify an API key name (Label), type (Type) and expiration duration (Active days).

3. Copy and safely story your generated key.

Use (Member) API Keys

SDK

Set an API key as an environment variable when using the aiXplain SDK.
See more details in the Python and Swift quickstarts.

MacOS / Linux

export AIXPLAIN_API_KEY="your_api_key_here"

Windows

setx AIXPLAIN_API_KEY="your_api_key_here"

Python (os module)

import os
os.environ["AIXPLAIN_API_KEY"] = "your_api_key_here"

Xcode

AiXplainKit.shared.keyManager.AIXPLAIN_API_KEY = "<your_api_key_here>"

HTTP (Curl)

Include an API key in the request header when using the aiXplain API directly.
See more details in the API Requests quickstart.

Agent

curl -X POST 'https://platform-api.aixplain.com/sdk/agents/<agent_id>/run' \
-H 'x-api-key: <your_api_key_here>' \
-H 'Content-Type: application/json' \
-d '{ 
    "query": "<QUERY_DATA>", 
    "sessionId": "<SESSION_ID_DATA>"
}'

Model

curl -X POST 'https://models.aixplain.com/api/v1/execute/<model_id>' \
-H 'x-api-key: <your_api_key_here>' \
-H 'Content-Type: application/json' \
-d '{"data": "Your input data"}'

Pipeline

curl -X POST 'https://platform-api.aixplain.com/assets/pipeline/execution/run/<pipeline_id>' \
-H 'x-api-key: <your_api_key_here>' \
-H 'Content-Type: application/json' \
-d '{
    "Input 1": "<INPUT_1_DATA>",
    "Input 2": "<INPUT_1_DATA>"
}'