API

Everything you can do in the dashboard, you can do via API. Score updates, scene switches, channel creation — all of it.

Authentication

Generate a key in Settings → API keys. Pass it as a bearer token.

bash
curl https://api.quadraviz.com/v1/channels \
  -H "Authorization: Bearer qvz_live_xxxxx"

Update a channel input

The most common call: push a new value into a live channel.

ts
await fetch(`https://api.quadraviz.com/v1/channels/${id}/inputs`, {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ scoreA: 12, scoreB: 9 }),
});

The channel renders the new value on the next frame.

Webhooks (incoming)

Quadraviz can also receive webhooks from your game server or scorekeeper. Configure the endpoint in your channel settings and map incoming JSON fields to scene inputs.

json
{
  "scoreA": 12,
  "scoreB": 9,
  "period": 2
}

Rate limits

  • Updates: 30 per second per channel — plenty for live data
  • Reads: 600 per minute per workspace
  • Creates: 60 per minute per workspace

Hit a limit? You'll get a 429 with a Retry-After header. Back off and retry.

SDK

Official SDKs for TypeScript, Python, and Go. Install whichever fits.

bash
npm install @quadraviz/sdk

← Previous

Channels