SDK reference

Everything your app can call, read or listen to, on every platform: what it is for, the exact signature, each parameter with its type, default and limits, what comes back (every field, with a real example), when it resolves, every error it can raise and why, what else it does, and which thread it runs on.

Your platform, every symbol

One complete page per SDK, for release 0.8.0. Each is grouped by use case — the same rows as Use cases by SDK, from installing to going live — then events, errors and the lower-level building blocks, and ends with every public symbol from A to Z. Every function, property, event, error and type opens with one sentence on when you use it.

The pages below compare the platforms topic by topic, with every platform's spelling side by side.

How to read it

• On the topic pages, one tab per platform, always in this order: React Native · iOS · Android · Flutter · Kotlin Multiplatform · Website. Choose yours once — every tab on these pages follows your choice.
• Under the tabs, in this order where they apply: Parameters (type, required, default, limits), Returns (each field and a JSON example), When it resolves, Errors (each code and why), What happens (side effects), and an example.
• JSON shows a real value as it arrives. Every platform's type has the same fields, in its own spelling — Types says how dates and enums look in each language.
• A dash in a tab or a table cell means that platform does not have it.

The platforms

Calling anything before start-up is a programming error, said loudly: iOS stops with a message, Android throws IllegalStateException, Flutter throws StateError, Kotlin Multiplatform throws IllegalStateException, and a React Native hook outside <GraineProvider> throws unless you called setDefaultClient(client) once at start-up. The website loader buffers what you call before load() and applies it when the widget exists. To ask first: Graine.isConfigured (Kotlin Multiplatform) or GraineInApp.maybeInstance (Flutter, null before init).

Several agents. A website runs one agent at a time and switches between them: GraineAgent.load() with another agent takes the one on the page off and resolves true once the new one is on it, the visitor still signed in. GraineAgent.switchesAgents is true on a loader that does this (1.2.0 and later). See Different agents on different pages.

Installing each SDK, and the options it takes when it starts, are on its own page: React Native, iOS, Android, Flutter, Kotlin Multiplatform, Website and Any other platform.

A result and a failure, per platform

The same call — reading what the agent remembers — in each platform's idiom:

try {
  const memories = await client.memories();          // Promise<GraineMemory[]>
} catch (e) {
  if (e instanceof GraineError) console.warn(e.code, e.message);
}

Every error carries a code — the same words on every platform — and a sentence for whoever has to fix it. The codes, their HTTP statuses and their fixes are on Errors.

Several agents (the multi-agent API)

An app can run several agents, each with its own publishable key, and choose one per screen — the guide is Use more than one agent in your app. These are the functions that name them.

<GraineProvider baseUrl="https://www.graine.ai" publishableKey="pk_live_sales…" storage={AsyncStorage}>   {/* one provider per agent */}
  <PlansScreens />                                                                                    {/* hooks use the nearest provider */}
</GraineProvider>
 
client.dispose(): void                         // a client you made yourself: end its conversation, stop sharing the device
client.conversation: "chat" | "call" | null    // the conversation this agent holds, if any
 
// The calls package names its agents:
GraineCalls.configure({ displayName, agents: Record<string, { publishableKey: string; baseUrl?: string }> }): Promise<void>
GraineCalls.configure(name: string, options: { publishableKey: string; baseUrl?: string }): Promise<void>
GraineCalls.agents: string[]
GraineCalls.startCall({ reason?, variables?, agent? }): Promise<string | null>

The pages by topic

Every function, and where it is

Names differ slightly between platforms; the page shows each platform's own.