Skip to main content

Quickstart

Five steps to a first call. The broader platform model — custody modes, sovereignty, the four pillars — is covered in Architecture.

Rather get your hands dirty first?

Skip the setup. The API Playground signs you in to a ready-made playground project and lets you fire live calls at real endpoints — right in the browser, no install, no keys to mint. Poke around the API first, then come back here when you're ready to build for real.

Open the API Playground →

1. Create an account​

Sign up at the Console. The first account in an organisation becomes the org owner; the rest of your team joins by invite.

2. Create a project​

Inside the Console, create a project. You'll choose:

  • Jurisdiction — your project's records pin to a specific region. Multi-cloud across OVH and GCP, US and EU. Pick whichever is closest to your users (or whichever your compliance regime requires).
  • Custody mode — Platform-Managed by default. For sovereign key ownership you can move to Kibo BYOK (Bring Your Own Key) or HYOK (Hold Your Own Key) without changing your code; the SDK shape is the same across all modes. SKR (Secure Key Release) is an attestation overlay on Platform-Managed, available where the deployment provides an attestation-capable enclave. It adds hardware-verified integrity to the default custody path rather than replacing it.

3. Generate an API key​

Each project carries its own API keys, scoped to that project. From the Console, mint a key for the SDK to authenticate with. Copy it once — the secret is shown only at creation time.

4. Install the SDK​

Platform SDKs (full API access — server-side):

LanguageInstall
TypeScript / JavaScriptnpm install @k9o/coreSetup →
Pythonpip install k9oSetup →
Gogo get k9o.dev/sdk-goSetup →
Rustcargo add k9oSetup →
Javaimplementation("dev.k9o:core:1.5.0") — Gradle / Maven dev.k9o:coreSetup →
.NETdotnet add package K9o.CoreSetup →
PHPcomposer require k9o/sdkSetup →
Rubygem install k9oSetup →

Mobile Gate SDKs (auth-only: signIn / refreshToken / signOut):

PlatformInstall
Swift (iOS 17+ / macOS 14+)SwiftPM .package(url: "https://github.com/k9o-dev/sdk-swift.git", from: "1.5.0"), product K9OGateSetup →
Kotlin / Androidimplementation("dev.k9o:gate:1.5.0")Setup →
Flutter / Dartdart pub add k9o_gateSetup →
React Nativenpm install @k9o/gate-react-nativeSetup →

The mobile SDKs take your organisation's regional API address as their base URL, not the region-free one.

5. Make your first call​

The server SDKs authenticate with your API key. This example lists the storage buckets in your project. The mobile SDKs have no API key: the app signs an end-user in through Gate, so their example is a sign-in.

TypeScript
import { createClient } from "@k9o/core";

const k9o = createClient({
apiKey: process.env.K9O_API_KEY,
orgSlug: "acme",
projectSlug: "member-portal",
});

const buckets = await k9o.storage.listBuckets();
console.log(buckets);
Output · bash
{
data: [
  { name: 'avatars', public: false, fileSizeLimit: null, allowedMimeTypes: [], ... }
],
meta: { ... }
}

Showing example in TypeScript

Every operation is recorded in the audit log; the Console's audit-log view shows each call alongside its requestId and actor identity.

Where to next​

  • Architecture — the mental model behind the platform.
  • Kibo — climb the custody ladder when your compliance regime asks.
  • API — the full endpoint reference.
  • Console — guided walkthroughs of the web UI.