Installation

Follow the steps below to install the Telekinesis SDK, set up your API key, and run your first example.

Step 1: Create an API Key

Create a Telekinesis account and generate an API key:

Create a Telekinesis account!

Store the key in a safe location, such as your shell configuration file (e.g. .zshrc, .bashrc) or another secure location on your computer.

Step 2: Configure the API Key

Export the API key as an environment variable.

Open a terminal window and run below command as per your OS system.

Replace <your_api_key> with the one generated in Step 1.

macOS/Linux

export TELEKINESIS_API_KEY="<your_api_key>"

Windows

setx TELEKINESIS_API_KEY "<your_api_key>"

WARNING

For Windows, after running setx, restart the terminal for the changes to take effect.

Optionally verify that the key is set:

macOS/Linux

echo $TELEKINESIS_API_KEY

Windows

echo $Env:TELEKINESIS_API_KEY

The Telekinesis SDK uses this API key to authenticate requests and automatically reads it from your system environment.

Step 3: Install the Telekinesis SDK

1. Create an isolated environment so that there is no dependency conflicts. We recommend installing Miniconda environment by following instructions from here.

2. Create a new conda environment called telekinesis:

conda create -n telekinesis python=3.11

3. Activate the environment:

conda activate telekinesis

4. Install the core SDK using pip:

We currently support Python versions - 3.11, 3.12. Ensure your environment is in the specified Python version.

pip install telekinesis-ai