Docs

Quickstarts, the API reference, the SDK wire protocol, and integration guides — the same docs that ship in the repo, published here.

Platform FAQ Identity & data model, channels, billing, security — the questions integrators ask first. Integrator Quickstart Token → connect → chat → voice → tools → memory, hands-on.集成快速上手(中文) Token → 连接 → 聊天 → 语音 → 工具 → 记忆,上手即用。Quickstart: Romance Companion End-to-end flagship walkthrough — project → secret key → backend mint → client SDK.Quickstart: Commerce Shopping Guide Catalog grounding via tool calls + world-state, end to end.Quickstart: Agent Data Plane Views / Actions / Events against YOUR backend — declare → verify → test → go live, with backend-kit.快速上手:Agent 数据面(中文) View / Action / Event 接入你的后端——声明 → 验签 → 自测 → 上线,配 backend-kit。Reference: Data-plane receivers Complete runnable receiver source — Node (backend-kit) + C#/.NET port with vector self-test.Drop-in Widget Zero-code `<iframe>` chat UI — params, postMessage protocol, security model.API Reference The complete raw HTTP contract (REST + SSE), scopes, platform API.Group Mode (Channels) One shared agent for a whole group chat — config, mention gating, per-transport matrix.Enterprise SSO + SCIM Runbook Operator activation walkthrough: SAML/OIDC via Firebase, SCIM provisioning, enforcement.SDK Wire Protocol Envelope, event types, resume cursors — the protocol spec.Capabilities Map The six capability planes and which surface reaches which.Voice-Game Integration Q&A SDK loading, import maps, tokens, world-state — answers from a real voice play-along integration.Native Integration (Kotlin / Swift) REST+SSE reference clients for native apps + bridges.Instant UI Renderer Contract The platform-neutral genui schema your renderer draws.Host-Control Verbs Generic app-action verbs one `onToolCall` handler can serve on any surface.Voice Play-Along Real-time voice calls + streaming world-state into a live call.API Versioning Protocol version, deprecation policy.Channel setup — per-provider guide Which credentials go where for each of the 82 channel transports, what to configure in the provider console, and each provider's caveats.Bluesky / AT Protocol Bridge DMs 代聊, 代读/代发, social-graph pairing.Poker Play-Along Integration A complete game integration case study.Reference: the device bridge Complete source of the process that runs beside your instrument — two files, no dependencies, no build step.Connecting an instrument Drive physical hardware over MCP — a public endpoint, or an outbound-only bridge for a device behind a firewall.Poker Tools Guide The declared-tools pattern in a real game.Pouchy World — documentation index Many characters, one committed state. Start here: what it is, which doc to read, and the four things integrators get wrong first.Quickstart: an interactive drama From a screenplay to an audience that can change it — the whole path, no official app required.Quickstart: NPCs that share one world Same SDK, same coordinator, same ledger as the drama — a cast that agrees on what happened.Quickstart: a world inside your Next.js app One route handler and one page, with no project credential in the browser.World SDK — errors and refusals Which refusals are retryable, why every signed door answers one uniform 403, and how to read rejectedEffects.World API — versions and compatibility What the world plane promises to code other people wrote, and what may change under you.World — production workflow integration A played worldline to a published script: evidence draft, editorial draft, human-approved export.