Introduction

The Minikai API gives your systems programmatic access to a workspace and the information that describes a person’s history and the support around them. This guide takes you from an API key to your first request.

1. Create an API key

In the Minikai app, open Settings → Security and create a key under API Keys. Copy it once and store it securely. Each key is scoped to a single workspace, and you can rotate or revoke it from the same screen.

2. Base URL and authentication

Your workspace belongs to one data region, and that region sets the base URL for every request:

Data regions covers how to tell which one your workspace is in.

Authenticate by sending your key as a bearer token. For example, listing records:

$
curl https://api.minikai.com/minikai-public/api/v1/Records \
>
  -H "Authorization: Bearer sk_live_..."

See Authentication for key scoping and rotation.

3. Use a typed SDK

You can call the API over raw HTTP, or use a generated SDK that gives you typed requests and responses in your language. Install the one you need:

$
pip install minikai

Then create a client with your key. The client defaults to Australia, so name your region if your workspace is elsewhere:

1
from minikai import Minikai
2
client = Minikai(token="YOUR_API_KEY")

The SDKs section covers both clients in more detail.

Next steps