Client Libraries

The two official SDKs — Python and TypeScript — and how they version against cheetah-service.

▸ BETA

▸ APPLIES TO

cheetah service >=0.0.132

Two official SDKs wrap the open REST API, maintained in the cheetah-service repository and released with it:

Python — cheetah-client. Sync and async, Pydantic-typed responses. Python ≥ 3.11.
TypeScript — @cheetahengineering/cheetah-client. Promise-based, fully typed. Node ≥ 18, ESM.

Choose by the language of the system you're integrating; the two expose the same surface with the same names in each language's casing (list_all_runs / listAllRuns).

Versioning#

SDK versions track cheetah-service releases — install the SDK version matching your cell's service version, and check it against each page's applies_to banner. The TypeScript package is published to GitHub Packages stamped with the service version; the Python package installs from the service repository pinned to the release tag.

Scope#

The SDKs are the same libraries Cheetah's own applications use, so they cover more of cheetah-service than the documented integration surface. The methods documented on these pages map to the API reference; anything else you find in the SDK is outside the documented surface and the versioning policy's beta guarantees — build on it at your own risk.