Get started
Authentication
Every API call carries a secret key in the Authorization header.
Authorization: Bearer vb_3Hq9xK2m...
Keys
- Keys start with
vb_followed by 40 characters. Create them in API keys. - We store a SHA-256 hash of each key and its first 11 characters, so the console can show which key is which. We can't show you a key again.
- By default a key can call every
/v1endpoint. When you create one you can limit it to some endpoints (scopes), give it an end date, and cap its video minutes a month. Keep it on a server. Don't put it in a web page, a mobile app or a public repository. - Revoking a key takes effect on the next request. Calls with a revoked key get
401 api_key_revoked. - The console itself uses a session cookie (HttpOnly, SameSite=Lax), not a key. The Playground runs on that session and its calls show up in Logs as "Playground".
Auth errors
| Status | Code | When |
|---|---|---|
| 401 | missing_api_key | No Authorization header. |
| 401 | invalid_api_key | Not a Bearer vb_ key, or no such key. |
| 401 | api_key_revoked | The key was revoked. |
| 401 | api_key_expired | The key passed its end date. |
| 403 | insufficient_scope | The key is limited to other endpoints. |
| 403 | forbidden_origin | A console session used from another website. |
Accounts
Passwords are hashed with PBKDF2-SHA256 and a random salt per account; we never store or log them. Sign-in attempts are limited to 10 per 15 minutes per network and per email. Email verification and password reset by email are coming soon; we don't send email yet.