Reference
Reference
Lookup pages for the three SDK surfaces and the REST and wire protocols underneath them.
Reference pages state facts. They're for looking something up mid-task, not for reading start to finish — if you're trying to understand how a session works, start with Sessions; if you're trying to get one running, start with a quickstart.
What's here
The following table lists the reference surfaces.
| Surface | Covers |
|---|---|
| RealtimeClient (TypeScript) | The TypeScript client, agent, and session classes |
| TypeScript types | Every type exported from cosmo-ai |
| React bindings | Provider, hooks, and components |
| Transport (TypeScript) | The transport interface and the LiveKit implementation |
| RealtimeClient (Python) | The Python client, agent, and session |
| Audio (Python) | Microphone, speaker, and level streams |
| Python types | Credentials, model blocks, tools, and enums |
| RealtimeClient (Swift) | The Swift client, agent, and session |
| Wire types (Swift) | The types the SDK declares for the wire protocol |
| API explorer | Every REST endpoint and schema, rendered from the OpenAPI document |
| Session start | POST /session/start — the REST call that opens a session |
| Credential verification | GET /realtime/verify — the credential preflight check |
| Session history | The recorded-session REST endpoints |
| Wire protocol | Every control message on the data channel |
The three SDKs speak the same wire protocol, so a behavior documented in the protocol reference holds in all of them. Where a language differs, its own page says so.