Skip to main content

How to Install

Requirements

The Python SDK supports Python 3.9+ and works with most modern Python environments.

Module Systems

The Python SDK works with standard Python import syntax:

IDE Support

For PyCharm users, install the PyCharm Pydantic Plugin for better integration with Pydantic models.

Alternative Installation Methods

Shell and Script Usage with uv

You can use this SDK in a Python shell with uv and the uvx command:
Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

Quick Start

After installation, you can quickly test your setup:

Version Management

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version:
Or with poetry: