Video APIv1 Home OpenAPI spec

Docs › Account and API keys

Account and API keys

Sign up by sending your email to POST /auth/start, which emails a 6-digit code (5 attempts, 10 minute expiry). Verify it with POST /auth/verify, accepting the terms on your first sign-in, to get a sessionToken. Sessions last 30 days and are stored just like API keys but marked as temporary; use the token as a bearer token the same way.

When signed in (session token) or with your API key, you can:

  • GET /account for your email, plan name, limits, this month's usage (minutes, storage, delivery), your overage cap and allowed domains.
  • GET /account/keys to list your API keys (never the keys themselves; they're shown once at creation).
  • POST /account/keys {label} to create a new key. Must be signed in with a session token.
  • DELETE /account/keys/{keyId} to revoke a key. Must be signed in with a session token.
  • PUT /account/overage-cap {"monthlyCap": 50} (or null) to cap monthly overage. Session token only.
  • PUT /account/allowed-domains {"domains": [...]} to lock playback links to your sites (see Allowed domains). Session token only.
  • POST /auth/signout to end the session (session tokens only).

Plan limits your maximum quality output, processing minutes and storage per month. Free-plan limits reset on the 1st of the month (UTC). Once your free-plan limit is hit, POST /videos returns 403 PLAN_LIMIT_REACHED. Paid plans continue and the overage is billed at your plan's rate. Usage details are available at GET /account.