Installation
Follow the steps below to install the Telekinesis SDK, set up your API key, and run your first example.
Supported Platforms
| Platform | Status |
|---|---|
| Windows | Supported |
| macOS | Supported |
| Linux | Supported |
Step 1 — Set Up Your API Key
A Telekinesis API key is required to use Synapse. If you haven't set one up yet, create your key on the Telekinesis Platform and follow the API Key Setup Guide.
Step 2 — Create a Conda Environment
Create and activate a dedicated conda environment for Synapse:
bash
conda create -n telekinesis python=3.11
conda activate telekinesisTIP
Activate this environment (conda activate telekinesis) each time you work with Telekinesis.
Step 3 — Install Dependency
Install telekinesis-urdfs, which provides the robot model data required by Synapse:
bash
git clone --depth 1 https://github.com/telekinesis-ai/telekinesis-urdfs.git
cd telekinesis-urdfs
pip install .WARNING
telekinesis-urdfs is a large repository containing robot model data. The initial clone and wheel build are expected to take several minutes — do not interrupt the process.
Step 4 — Install Synapse
bash
pip install telekinesis-ai[synapse]