SDKs

The three SDKsCopy Anchor Link

What the server SDK wrapsCopy Anchor Link

The server SDK is a thin, typed layer over the 9 operations. It adds nothing the contract does not have; it removes the boilerplate the contract requires on every call.

Handled for youCopy Anchor Link

Draft surfaceCopy Anchor Link

// Draft. Names and shapes follow the prepared contract and can change.
const onioko = createServerClient({ key: process.env.ONIOKO_PARTNER_KEY });

const subject = await onioko.subjects.create();
// -> { subjectId }

const consent = await onioko.consent.record(subject.subjectId, {
  purpose: 'live-perception',
  consentVersion: '2026-11',
  granted: true,
});
// -> { consentId, purpose, consentVersion }

const session = await onioko.sessions.start({
  subjectId: subject.subjectId,
  consentId: consent.consentId,
  persona: 'clara',
  language: 'de',
});
// -> { sessionId, joinUrl }   joinUrl goes to the browser, nothing else does

const perception = await onioko.perception.read(session.sessionId);
// -> { sessionId, speakerName, perception, timestamp } or throws ConsentRequired

await onioko.sessions.close(session.sessionId);
await onioko.consent.revoke(subject.subjectId, consent.consentId);
// revoke closes every session of that consent and confirms the stop

for await (const s of onioko.subjects.list()) { /* cursor pagination handled */ }

What the browser SDK wrapsCopy Anchor Link

The browser never sees the partner key and never calls the contract. The server starts a session and hands the browser the joinUrl from startSession. The browser SDK:

• joins that session and reports connection state,
• shows whether perception is active, so the partner can render the indicator the contract requires,
• exposes a stop() that ends the session from the person's side,
• answers unavailable as a normal state, not as an error, when consent or session are no longer valid.

What the events SDK wrapsCopy Anchor Link

Events is a planned resource. When it opens, the SDK verifies the webhook signature, deduplicates by event ID, delivers events in order per session and retries your handler with back-off. Until then there is nothing to wrap, and this section stays a plan.

The seven requirementsCopy Anchor Link

An SDK is a versioned client, not a marketing label. ONIOKO lists an SDK publicly only when all of these exist:

1. Installation: package source, minimum runtime versions, one command, verifiable.
2. Authentication: where the key comes from, how it is held, what must never live in a browser, rotation.
3. Typed interfaces: every resource as a type, every error as a type, nothing as any.
4. Runnable examples: create subject, record consent, start session, read perception, close session, revoke consent, and later export and delete. Every example runs against the sandbox.
5. Semantic versioning: what counts as a breaking change, how long old major versions live.
6. Migration notes: from every major version to the next, with before and after code.
7. Changelog: every version, every date, every change. Machine-readable and human-readable.

When an SDK is released, its page appears in this section with exactly these seven parts, in this order, and the draft label above disappears.