Telekinesis Docs

Appearance

Developer Quickstart ​

INFO

Get up and running with the Telekinesis SDK and run your first example in just a few minutes.

Step 1: Create an API Key ​

Create a Telekinesis account and generate an API key:

Create a Telekinesis account!

alt text

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:

bash
export TELEKINESIS_API_KEY="your_api_key"
powershell
setx TELEKINESIS_API_KEY "your_api_key"

WARNING

After running setx, restart the terminal for the changes to take effect.

Optionally verify that the key is set:

bash
echo $TELEKINESIS_API_KEY
powershell
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 ​

Requirements

  • Python 3.11 or later

Install the core SDK using pip:

bash
pip install telekinesis-ai

Step 4: Run Your First Example ​

  1. Git clone our telekinesis-examples repository from Github with:
bash
git clone --recurse-submodules https://github.com/telekinesis-ai/telekinesis-examples.git

INFO

This also downloads the telekinesis-data repository, which contains sample data used by the examples. You can replace this with your own data when using Telekinesis in your own projects. Download time may vary depending on your internet connection.

  1. Change directory into telekinesis-examples:
bash
cd telekinesis-examples
  1. Install example-only dependencies:
bash
pip install numpy scipy opencv-python rerun-sdk==0.27.3 loguru
  1. Run the filter_point_cloud_using_voxel_downsampling example:
bash
python examples/vitreous_examples.py --example filter_point_cloud_using_voxel_downsampling

If the example runs successfully, a Rerun visualization window will open showing the result.

INFO

Rerun is a visualization tool used to display 3D data and processing results.

Output:

Step 5: Explore More Examples ​

We provide a large set of examples to help you learn all the available skills in the SDK.

Find the complete list with:

bash
python examples/vitreous_examples.py --list

This will display all available examples, such as:

bash
2025-12-22 21:14:58.115 | SUCCESS  | __main__:main:4406 - Available examples:
2025-12-22 21:14:58.116 | SUCCESS  | __main__:main:4408 -   - add_point_clouds
2025-12-22 21:14:58.116 | SUCCESS  | __main__:main:4408 -   - apply_transform_to_point_cloud
2025-12-22 21:14:58.116 | SUCCESS  | __main__:main:4408 -   - calculate_axis_aligned_bounding_box
2025-12-22 21:14:58.117 | SUCCESS  | __main__:main:4408 -   - calculate_oriented_bounding_box
2025-12-22 21:14:58.117 | SUCCESS  | __main__:main:4408 -   - calculate_plane_normal
2025-12-22 21:14:58.117 | SUCCESS  | __main__:main:4408 -   - calculate_point_cloud_centroid
2025-12-22 21:14:58.117 | SUCCESS  | __main__:main:4408 -   - calculate_points_in_point_cloud
2025-12-22 21:14:58.117 | SUCCESS  | __main__:main:4408 -   - cluster_point_cloud_based_on_density_jump
2025-12-22 21:14:58.118 | SUCCESS  | __main__:main:4408 -   - cluster_point_cloud_using_dbscan
2025-12-22 21:14:58.118 | SUCCESS  | __main__:main:4408 -   - convert_mesh_to_point_cloud
2025-12-22 21:14:58.118 | SUCCESS  | __main__:main:4408 -   - create_cylinder_mesh
2025-12-22 21:14:58.118 | SUCCESS  | __main__:main:4408 -   - create_plane_mesh
2025-12-22 21:14:58.118 | SUCCESS  | __main__:main:4408 -   - create_sphere_mesh
2025-12-22 21:14:58.118 | SUCCESS  | __main__:main:4408 -   - create_torus_mesh
2025-12-22 21:14:58.118 | SUCCESS  | __main__:main:4408 -   - estimate_principal_axes
2025-12-22 21:14:58.118 | SUCCESS  | __main__:main:4408 -   - estimate_principal_axis_within_radius
2025-12-22 21:14:58.118 | SUCCESS  | __main__:main:4408 -   - filter_point_cloud_using_bounding_box
2025-12-22 21:14:58.118 | SUCCESS  | __main__:main:4408 -   - filter_point_cloud_using_cylinder_base_removal
2025-12-22 21:14:58.118 | SUCCESS  | __main__:main:4408 -   - filter_point_cloud_using_mask
2025-12-22 21:14:58.118 | SUCCESS  | __main__:main:4408 -   - filter_point_cloud_using_oriented_bounding_box
2025-12-22 21:14:58.118 | SUCCESS  | __main__:main:4408 -   - filter_point_cloud_using_pass_through_filter
2025-12-22 21:14:58.119 | SUCCESS  | __main__:main:4408 -   - filter_point_cloud_using_plane_defined_by_point_normal_proximity
2025-12-22 21:14:58.119 | SUCCESS  | __main__:main:4408 -   - filter_point_cloud_using_plane_proximity
2025-12-22 21:14:58.119 | SUCCESS  | __main__:main:4408 -   - filter_point_cloud_using_plane_splitting
2025-12-22 21:14:58.120 | SUCCESS  | __main__:main:4408 -   - filter_point_cloud_using_radius_outlier_removal
2025-12-22 21:14:58.120 | SUCCESS  | __main__:main:4408 -   - filter_point_cloud_using_statistical_outlier_removal
2025-12-22 21:14:58.120 | SUCCESS  | __main__:main:4408 -   - filter_point_cloud_using_uniform_downsampling
2025-12-22 21:14:58.120 | SUCCESS  | __main__:main:4408 -   - filter_point_cloud_using_viewpoint_visibility
2025-12-22 21:14:58.120 | SUCCESS  | __main__:main:4408 -   - filter_point_cloud_using_voxel_downsampling
2025-12-22 21:14:58.120 | SUCCESS  | __main__:main:4408 -   - project_point_cloud_to_plane
2025-12-22 21:14:58.120 | SUCCESS  | __main__:main:4408 -   - project_point_cloud_to_plane_defined_by_point_normal
2025-12-22 21:14:58.120 | SUCCESS  | __main__:main:4408 -   - reconstruct_mesh_using_convex_hull
2025-12-22 21:14:58.120 | SUCCESS  | __main__:main:4408 -   - reconstruct_mesh_using_poisson
2025-12-22 21:14:58.120 | SUCCESS  | __main__:main:4408 -   - register_point_clouds_using_cuboid_translation_sampler_icp
2025-12-22 21:14:58.120 | SUCCESS  | __main__:main:4408 -   - register_point_clouds_using_fast_global_registration
2025-12-22 21:14:58.120 | SUCCESS  | __main__:main:4408 -   - register_point_clouds_using_point_to_plane_icp
2025-12-22 21:14:58.120 | SUCCESS  | __main__:main:4408 -   - register_point_clouds_using_point_to_point_icp
2025-12-22 21:14:58.120 | SUCCESS  | __main__:main:4408 -   - register_point_clouds_using_rotation_sampler_icp
2025-12-22 21:14:58.120 | SUCCESS  | __main__:main:4408 -   - scale_point_cloud
2025-12-22 21:14:58.120 | SUCCESS  | __main__:main:4408 -   - segment_point_cloud_using_color
2025-12-22 21:14:58.120 | SUCCESS  | __main__:main:4408 -   - segment_point_cloud_using_plane
2025-12-22 21:14:58.120 | SUCCESS  | __main__:main:4408 -   - subtract_point_clouds

INFO

You can explore our GitHub repositories using the links below:

Where To Go Next? ​

Now that you’ve successfully run your first example, you’re ready to build with Telekinesis.

Use Telekinesis in Your Project ​

Learn how to integrate the SDK into your own code through the use of Telekinesis Skills.

Curious how data flows through Telekinesis? ​

Explore the datatypes_examples to understand how data is represented, passed, and transformed between Skills.