認証

すべてのリクエストには APIキーが必要です。Bearer トークンとして送信してください。

Authorization: Bearer vu_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

API を利用できるアカウント

API は有料アカウント、つまりクレジットパックを購入したことがある、またはサブスクリプションを契約しているアカウント向けです。無料アカウントは APIキーを作成できず、一度も支払いをしていないアカウントからのリクエストにはすべて 403 が返されます。

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

料金ページでいずれかのクレジットパックを購入すると利用可能になります。クレジットを使い切った後もアクセスは維持されるので、その後はチャージするだけで利用を続けられます。

キーの取得

キーは 設定 → APIキー で作成します。有効なキーは最大 20 個まで持てるので、たとえばサーバーや環境ごとに 1 つずつ用意できます。このページには、各キーの名前、先頭と末尾の数文字、最終使用日時が表示されます。

キーの全体が表示されるのは、作成時の 1 回だけ です。保存しているのはキーのハッシュのみなので、再表示することはできません。キーを紛失した場合は、削除して新しいキーを作成してください。

キーを安全に保管する

• キーはアカウントのクレジットを消費します。パスワードと同じように扱ってください。
• API はサーバーから呼び出してください。ブラウザ、モバイルアプリ、公開リポジトリには絶対にキーを含めないでください。
• キーは VIDEOUPSCALER_API_KEY などの環境変数から読み込んでください。
• キーが漏洩した場合は、設定から削除してください。削除したキーは即座に無効になります。

エラー

キーが指定されていない、形式が正しくない、または削除済みの場合は 401 が返されます。

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