Reference
API reference documentation for Starfish SDKs and servers.
Available
- Project Provisioning API — the control-plane HTTP API for declaring Projects:
/admin/projectsCRUD, management-key auth, and the Project config + matchmaking policy schemas - Pool Matchmaking API — the full pool API for the TypeScript and Python SDKs, all five modes, types, protocol frames, and error codes
- Realtime Media API — the
client.mediaplane (TypeScript): share/subscribe, scopes, thePublicationhandle,RemoteStream, and themedia.map/welcome.mediaprotocol surface
Coming soon
The reference will also cover:
- Protocol specification
- TypeScript SDK API
- Python SDK API
- Go SDK API
- Server configuration
- Message types and formats