SDKs

Every SDK follows the same OpenAPI definition, authentication rules, idempotency requirements, error envelope and request identifiers.

JavaScript, Python, Go, .NET and Rust public betas are available from their standard package registries. The source repositories remain available for review and reproducible builds.

Choose a client

Client	Runtime	Primary use
`rafiki-js`	Node.js 22+	TypeScript services and web backends
`rafiki-py`	Python 3.10+	Backend services, research and data workflows
`rafiki-go`	Go 1.25+	Infrastructure and integration services
`rafiki-net`	.NET Standard 2.0, .NET 8 and .NET 10	Insurer, health-system and government integrations
`rafiki-rs`	Rust 1.85+	Correctness-sensitive and high-throughput services
`hey`	Node.js 22+	Local diagnostics, CI and governed API reads
API definition	OpenAPI 3.1	Code generation and API compatibility checks

Each client is available from its public repository for Sandbox integration. The repository owns its source-install path, compatibility policy, release checks and provenance.

Build from source

JavaScript
Python
Go
.NET
Rust

git clone https://github.com/heyrafiki/rafiki-js.git
cd rafiki-js
npm ci
npm run check

git clone https://github.com/heyrafiki/rafiki-py.git
cd rafiki-py
python -m pip install -e ".[dev]"
pytest

git clone https://github.com/heyrafiki/rafiki-go.git
cd rafiki-go
go test -race ./...

git clone https://github.com/heyrafiki/rafiki-net.git
cd rafiki-net
dotnet restore
dotnet test -c Release

git clone https://github.com/heyrafiki/rafiki-rs.git
cd rafiki-rs
cargo test --all-features

Install public beta

JavaScript
Python
Go
.NET
Rust

npm install @heyrafiki/rafiki-js@0.1.0-beta.1

python -m pip install --pre heyrafiki==0.1.0b2

go get github.com/heyrafiki/rafiki-go@v0.1.0-beta.2

dotnet add package heyrafiki --version 0.1.0-beta.3

cargo add heyrafiki@0.1.0-beta.2

The published packages are available on npm, PyPI, pkg.go.dev, NuGet and crates.io.

Make the first request

import { Heyrafiki } from "@heyrafiki/rafiki-js";

const heyrafiki = new Heyrafiki({
  apiKey: process.env.HEYRAFIKI_API_KEY!,
});

const practitioners = await heyrafiki.practitioners.list({ limit: 5 });

import os

from heyrafiki import create_client, unwrap
from heyrafiki.api.default import list_practitioners

with create_client(os.environ["HEYRAFIKI_API_KEY"]) as client:
    response = list_practitioners.sync_detailed(client=client, limit=5)
    practitioners = unwrap(response)

client, err := heyrafiki.NewClient(os.Getenv("HEYRAFIKI_API_KEY"))
if err != nil {
    log.Fatal(err)
}

practitioners, err := client.Practitioners.List(
    context.Background(),
    &heyrafiki.ListOptions{Limit: 5},
)

using var heyrafiki = new HeyrafikiClient(new HeyrafikiClientOptions
{
    ApiKey = Environment.GetEnvironmentVariable("HEYRAFIKI_API_KEY")
        ?? throw new InvalidOperationException("HEYRAFIKI_API_KEY is required."),
});

var practitioners = await heyrafiki.Practitioners.ListAsync(limit: 5);

let client = Client::new(std::env::var("HEYRAFIKI_API_KEY")?)?;
let practitioners = client
    .practitioners()
    .list(ListParams::new(5)?)
    .await?;

Sandbox keys return fictitious records. Keep secret keys in server-side secret stores and retain the request identifier when tracing a failed call.

Write safely

All clients preserve the REST API’s write controls:

caller-owned idempotency keys for replay-safe writes;
bounded retries only where the operation and key make retry safe;
typed errors with HTTP status, stable error code and request identifier;
integer minor units for money;
no automatic exposure of raw response bodies in errors.

The REST reference remains authoritative for resource behavior, scopes and error codes.

Command line

hey checks local configuration and makes authenticated read requests against Sandbox projects.

git clone https://github.com/heyrafiki/hey.git
cd hey
npm ci
npm run check
node dist/index.js doctor

Get started

Integration tools

Choose a client

Build from source

Install public beta

Make the first request

Write safely

Command line

Verify API compatibility

API definition

Proving Ground

​Choose a client

​Build from source

​Install public beta

​Make the first request

​Write safely

​Command line

​Verify API compatibility

API definition

Proving Ground

Choose a client

Build from source

Install public beta

Make the first request

Write safely

Command line

Verify API compatibility