API reference

HTTP and JavaScript APIs for configuring identities, defining objects, publishing state, routing delivery, and managing credentials. Each endpoint page documents parameters, responses, and runnable examples.

How to use this reference#

Most operations have two tabs:

• REST — path, headers, body, status codes, and Scalar request examples
• JavaScript — the matching bigstate.client.javascript method and response shape

Authenticate with an API key or session token. Keep privileged keys in trusted environments; use scoped credentials in browsers and other untrusted clients.

If you are still setting up access, start with Account and credentials and the JavaScript quickstart.

Core resources#

Objects, state, and delivery are the main publish/subscribe path:

Object definition → set state → delivery routes matching updates

Identity and access#

Principals, policies, and credentials control who can call the API and what they may do:

Related guides#