Loading...
Developer Platform · v1.0.0
Build on Circuvent
A REST API and signed webhooks for the same control plane our own console and apps run on. Read device state, send commands, and stream events straight into your dashboard.
- Endpoints
- 24
- Scopes
- 12
- Webhook events
- 5
- Rate limit
- 600/min
Every request goes to https://api.circuvent.com/v1 and carries an API key. Start with the quickstart, or jump to whichever part you need.
bash
# List your devices
curl https://api.circuvent.com/v1/devices \
-H "Authorization: Bearer $CIRCUVENT_API_KEY"
# Turn on channel 1 of a home hub
curl -X POST https://api.circuvent.com/v1/devices/hub-a1b2/commands \
-H "Authorization: Bearer $CIRCUVENT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"ch": 0, "on": true}'- QuickstartCreate a key and read a real device in three steps.
- AuthenticationHow keys are sent, what they can reach, and what they deliberately cannot.
- ScopesEvery permission a key can carry. Scopes never imply one another.
- EndpointsThe full REST surface, generated from the OpenAPI description.
- Sending commandsWhat a device accepts, and why 202 does not mean the relay closed.
- Calling from a browserOrigin restrictions, and what they do and do not protect.
- WebhooksSigned deliveries pushed as devices report, and how to verify them.
- ErrorsStable codes to branch on, and what each one means.
- Rate limits & versioning600 requests a minute per key, and the compatibility promise for /v1.
Prefer to generate a client?
The full surface is published as an OpenAPI 3.1 document, and
GET /v1 returns the same index machine-readably with no authentication. The tables in these pages are generated from that description, so they cannot fall behind it.