Quickstart

Create a key and read a real device in three steps.

Every request goes to https://api.circuvent.com/v1 and carries an API key. Three steps and you are reading real devices.

Open Console → Settings → Developer and create a key. Grant only the scopes you need.
Copy the key when it is shown — we store a hash, so it cannot be displayed again.
Send it as Authorization: Bearer <key> on every request.

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}'

Quickstart

Create a key and read a real device in three steps.

Every request goes to https://api.circuvent.com/v1 and carries an API key. Three steps and you are reading real devices.

Open Console → Settings → Developer and create a key. Grant only the scopes you need.
Copy the key when it is shown — we store a hash, so it cannot be displayed again.
Send it as Authorization: Bearer <key> on every request.

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}'