Skip to main content

​
Create an Account

Create your account by signing up at the Engine Platform.

​
Get Your API Key

Your API key authenticates requests to the Engine. To get your key:
  1. Log in to the Engine Platform
  2. Click your profile icon in the top right corner
  3. Select Settings
  4. Navigate to the API Keys tab
  5. Click Regenerate to create a new API key
  6. Copy and save the key securely
Store your API key securely. You cannot view it again after leaving the page. If you lose it, generate a new one from the Settings page.

​
Set Your API Key

Add your API key to your environment variables: 
echo 'export ONYX_API_KEY="your_api_key_here"' >> ~/.bashrc
source ~/.bashrc
For zsh users:
echo 'export ONYX_API_KEY="your_api_key_here"' >> ~/.zshrc
source ~/.zshrc

​
Install the Package

Install the onyx-engine package using pip: 
pip install onyxengine

​
Verify Installation

Test your installation by retrieving metadata for the example dataset: 
import json
from onyxengine import Onyx

# Initialize the client (defaults to ONYX_API_KEY env var)
onyx = Onyx()

metadata = onyx.get_object_metadata('example_data')
print(json.dumps(metadata, indent=2))
You should see output similar to: 
{
  "name": "example_data",
  "type": "dataset",
  "created_at": "2026-01-22T19:15:29.000521+00:00",
  "config": {
    "type": "dataset",
    "features": [
      "acceleration",
      "velocity",
      "position",
      "control_input"
    ],
    "dt": 0.0025
  },
  "status": "active",
  "team_id": "90e364ed-8970-42a7-90e7-28c494500db5",
  "id": "888b0cc4-c313-4c60-8829-07c1963dba76",
  "user_id": "7c229706-ccc5-481d-9299-9c3a27e89f31",
  "type_metadata": {
    "id": "888b0cc4-c313-4c60-8829-07c1963dba76",
    "num_points": 960801,
    "memory_bytes": 28633596
  }
}
If you see the metadata output, your installation is working correctly.

​
Next Step: Quickstart

Quickstart

Train your first model in 5 minutes