Skip to content

Reference

API reference documentation for Starfish SDKs and servers.

Available

  • Project Provisioning API — the control-plane HTTP API for declaring Projects: /admin/projects CRUD, 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.media plane (TypeScript): share/subscribe, scopes, the Publication handle, RemoteStream, and the media.map / welcome.media protocol 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