API Key generation is a Pro feature. Reach out to your CSM or contact Support@Epsilon3.io to learn more.
The Epsilon3 API supports starting runs, serving data from external sources, streaming telemetry for real-time display, sending commands, and listening for notifications. These features are supported using a combination of REST API endpoints and websockets.
Configuring external data fields, telemetry parameters, and commands is supported using REST endpoints, as is starting a run. External data searches, serving real-time telemetry, handling commands, and listening for notifications are handled using Socket.IO.
Check out our API Docs to learn more about what you can do with our API!
Workspace API Keys
Workspace API keys are managed at the organization level and are typically used for shared integrations, backend services, or system-level automations.
To generate a workspace API key, navigate to Settings → Integrations → API.
Only Admins are able to perform this action!
From this page, you can generate a new API key, view existing active keys, and manage previously created keys.
When creating a new key, Epsilon3 will display the API credentials once. Be sure to copy and securely store the key at that time, as it cannot be retrieved again later.
Once you have saved the key, click the Dismiss button.
Our API uses Basic Auth with the username being your generated API Key and the password left blank.
This page also allows you to track which keys are active and deactivate keys that are no longer in use. Regular rotation of API keys is recommended, especially for long-lived integrations.
Workspace API keys are not tied to a specific user and are best suited for shared systems where ownership is at the organization level rather than an individual.
User-Specific API Keys
Personal API keys are tied directly to an individual user account. This allows for more granular API usage and improves traceability by associating API activity with a specific user.
Because these keys inherit the permissions of the user who created them, any actions performed through the API will reflect that user’s access within Epsilon3. This makes personal API keys ideal for user-specific automations, testing, or scenarios where clear ownership and auditability are important.
How to generate a personal API key
To generate a personal API key, navigate to your Profile page by clicking your name in the left navigation and selecting Profile. From there, access the API key management section and generate a new key.
When the key is created, Epsilon3 will display the API credentials for you to copy and store securely. As with workspace keys, the secret value is only shown once at creation time and cannot be retrieved afterward.
Using separate keys for different scripts, environments, or integrations can help isolate issues and provide clearer visibility into API usage.
Using the API key
Epsilon3 API authentication uses Basic Auth, with the API key supplied as the username and the password left blank.
Before making requests, it’s recommended to store your API key as an environment variable rather than hardcoding it into your scripts. This improves security and makes it easier to manage across environments.
On macOS or Linux:
export EPSILON3_API_KEY=your_api_key_here
On Windows (PowerShell):
$env:EPSILON3_API_KEY="your_api_key_here"
Once set, your API key can be referenced securely in your requests.
Example requests
Using curl:
curl -u $EPSILON3_API_KEY: https://api.epsilon3.io/v1/...
Or in Python:
import os
import requests
response = requests.get(
"https://api.epsilon3.io/v1/...",
auth=(os.environ["EPSILON3_API_KEY"], "")
)
This approach keeps your API key out of your source code and allows you to rotate or update it without modifying your scripts.