State API¶
State routes expose developer-defined JSON at extension, channel, viewer, and extension-viewer scopes. GET /all_state returns the available scopes together.
All paths below are relative to https://api.muxy.io/v1/e and require the standard Authorization header.
| Scope | Method and path | Generated operation reference |
|---|---|---|
| All | GET /all_state |
Get all state |
| Channel | GET /channel_state |
Get channel state |
| Channel | POST /channel_state |
Post channel state |
| Channel | PATCH /channel_state |
Patch channel state |
| Extension | GET /extension_state |
Get extension state |
| Extension | POST /extension_state |
Post extension state |
| Extension | PATCH /extension_state |
Patch extension state |
| Extension viewer | GET /extension_viewer_state |
Get extension-viewer state |
| Extension viewer | POST /extension_viewer_state |
Post extension-viewer state |
| Extension viewer | PATCH /extension_viewer_state |
Patch extension-viewer state |
| Viewer | GET /viewer_state |
Get viewer state |
| Viewer | POST /viewer_state |
Post viewer state |
| Viewer | PATCH /viewer_state |
Patch viewer state |
Write bodies¶
The v1 OpenAPI contract declares every state POST and PATCH body as a JSON array of RFC 6902 operations. See JSON request bodies for the shared format and use the generated operation page for method-specific details.
Canonical OpenAPI¶
See the raw rest-v1.yaml specification. Sandbox token creation is defined separately in raw sandbox-v1.yaml.