REST API Overview
The Volta REST API is a thin HTTP layer over Volta’s real-time WebSocket infrastructure. It translates JSON requests into OSC messages and broadcasts them to connected outputs.
Base URL
Section titled “Base URL”Your REST API endpoint is provided by your Volta deployment. It looks like:
https://xxxxxxxxxx.execute-api.eu-west-2.amazonaws.comAll endpoints are relative to this base URL.
Authentication
Section titled “Authentication”Two authentication methods are used:
| Method | Header | Used for |
|---|---|---|
| API Key | x-api-key: YOUR_KEY | Layout discovery, token creation |
| Bearer Token | Authorization: Bearer TOKEN | Sending actions |
See Authentication for details.
Endpoints
Section titled “Endpoints”| Method | Path | Description |
|---|---|---|
GET | /layout/{layoutId} | Discover controls on the active page |
POST | /token | Get an audience token |
POST | /action | Send a control action |
See Endpoints for full request/response schemas.
Rate limits
Section titled “Rate limits”The REST API runs on AWS API Gateway and Lambda. There are no hard rate limits beyond AWS defaults, but you should debounce high-frequency controls (like sliders) to ~10-20 updates per second per user for best performance.