Authentication

Every request needs an API key, sent as a bearer token:

Authorization: Bearer vu_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Who can use the API

The API is for paid accounts: accounts that have bought a credit pack or subscribed. Free accounts can't create API keys, and every request from an account that has never paid returns 403:

{
  "error": {
    "code": "paid_plan_required",
    "message": "The API is available to accounts that have bought credits or subscribed. See https://videoupscaler.co/pricing"
  }
}

Buy any credit pack on the pricing page to get access. It stays on after you spend the credits; you then only need to top up.

Getting a key

Create keys in Settings → API Keys. You can have up to 20 active keys, for example one per server or environment. The page shows each key's name, its first and last characters and when it was last used.

The full key is shown only once, when you create it. We store only a hash of it, so we cannot show it again. If you lose a key, delete it and create a new one.

Keeping keys safe

• A key spends your account's credits. Treat it like a password.
• Call the API from your server. Never put a key in a browser, mobile app or public repository.
• Read it from an environment variable, such as VIDEOUPSCALER_API_KEY.
• If a key leaks, delete it in Settings. It stops working immediately.

Errors

A missing, malformed or deleted key returns 401:

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key. Send it as \"Authorization: Bearer vu_live_...\"."
  }
}