Skip to navigation
SDKs and CLI

SDKs

Install the Python or TypeScript Sikaru client from its package registry and make requests that are safe to retry.
View as Markdown

The Sikaru SDK repository contains the Python and TypeScript clients. Each client calls the Sikaru API. Installing a client does not start an agent or attach your computer as an executor.

LanguagePackageSource
Pythonsikaru_apiPython
TypeScript@sikaru/sdkTypeScript

Install

Requires Python 3.10 or later. Add the client to your project with uv:

uv add sikaru_api

Import SikaruApi from sikaru_api.

Your lockfile (uv.lock or package-lock.json) pins the client version, so builds use a known client contract. Read the changelog when you upgrade. Newly documented endpoints also need a service version that supports them.

Keep SIKARU_API_KEY in your server or terminal environment. Never embed it in a browser bundle. Configure the API base URL for the Sikaru environment your account uses.

Make reliable requests

  • Automatic retries are limited to GET and HEAD requests.
  • Mutations are not automatically retried.
  • Keep idempotency keys and receipts when the API operation provides them.
  • Reconcile an uncertain acknowledgement before you repeat an operation with external effects.

The Quickstart shows both clients. Each language directory in the SDK repository includes its full method reference.

Next steps

SDK configuration

Timeouts, errors, async clients, and pagination.

Quickstart

Run your first agent with the Python client.