顔交換 API

シンプルな REST API で、写真・動画の顔交換をあなたのプロダクトに追加できます。ジョブを送信し、結果をポーリングして、ホストされた出力 URL を取得します。

API アクセスはすべてのサブスクリプションプランに含まれています。リクエストはウェブアプリと同じクレジットを消費するため、API の追加料金はありません。

使い方

  1. 1

    APIキーを作成

    任意のプランに登録し、ダッシュボードの「APIキー」からキーを作成します。キーは一度しか表示されないため、安全に保管してください。

  2. 2

    メディアをアップロード

    署名付きアップロード URL をリクエストし、ソースの顔とターゲットの画像または動画を PUT でアップロードします。

  3. 3

    顔交換とポーリング

    顔交換ジョブを送信し、ステータスが succeeded になるまでタスクをポーリングして、出力 URL からダウンロードします。

認証

すべてのリクエストで、x-api-key ヘッダーに APIキーを含めて送信してください。キーはあなたのアカウントに紐づき、アカウントのクレジットを消費します。キーは秘密に保ち、漏えいした場合はダッシュボードからローテーションしてください。

x-api-key: adf_YOUR_API_KEY

エンドポイント

POST /api/v1/uploads

ソースまたはターゲットファイル用の署名付きアップロード URL を作成します。同じ Content-Type で uploadUrl にファイルを PUT し、顔交換リクエストで url を使用します。対応形式: JPEG、PNG、WebP、MP4、QuickTime、WebM。

curl -X POST https://aideepfake.io/api/v1/uploads \
  -H "x-api-key: adf_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fileName": "target.jpg", "contentType": "image/jpeg"}'

# → { "success": true, "data": { "uploadUrl": "...", "url": "https://...", "expiresIn": 600 } }

curl -X PUT "UPLOAD_URL_FROM_RESPONSE" \
  -H "Content-Type: image/jpeg" \
  --data-binary @target.jpg

POST /api/v1/face-swap

顔交換ジョブを開始します。画像の顔交換は 15 クレジット、動画の顔交換は 20 クレジットで、ウェブアプリと同じ価格です。targetType を image または video に設定します。オプションのフィールド: faceEnhance、frameEnhance、watermark、および動画用の targetDurationSeconds。

curl -X POST https://aideepfake.io/api/v1/face-swap \
  -H "x-api-key: adf_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sourceUrl": "https://.../source.jpg",
    "targetUrl": "https://.../target.jpg",
    "targetType": "image"
  }'

# → { "success": true, "data": { "taskId": "...", "creditsCost": 15 } }

動画の制限: 通常の顔交換は最大 300 秒、faceEnhance または frameEnhance が有効な場合は最大 90 秒です。

GET /api/v1/face-swap/{taskId}

タスクのステータスをポーリングします。status フィールドは processing から succeeded または failed に遷移します。成功時は outputUrl にホストされた結果が入ります。失敗したジョブは自動的に返金されます。

curl https://aideepfake.io/api/v1/face-swap/TASK_ID \
  -H "x-api-key: adf_YOUR_API_KEY"

# → { "success": true, "data": { "taskId": "...", "status": "succeeded",
#      "outputUrl": "https://...", "targetType": "image" } }

GET /api/v1/credits

ジョブを送信する前に、現在のクレジット残高とプランを確認できます。

curl https://aideepfake.io/api/v1/credits \
  -H "x-api-key: adf_YOUR_API_KEY"

# → { "success": true, "data": { "credits": 1000, "subscriptionCredits": 985,
#      "oneTimeCredits": 15, "planId": "...", "currentPeriodEnd": "..." } }

料金とクォータ

API に個別の料金表はありません。すべてのリクエストはサブスクリプションプランのクレジットを消費します。画像の顔交換は 15 クレジット、動画の顔交換は 20 クレジットで、ウェブアプリとまったく同じです。月間のクレジット枠はプランによって決まります。

プランを比較

エラーコード

HTTPコード意味
401INVALID_API_KEYAPIキーが未指定、無効、無効化済み、または期限切れです。
403API_REQUIRES_SUBSCRIPTIONアカウントに有効なサブスクリプションがありません。API を使用するにはプランに登録してください。
402INSUFFICIENT_CREDITSこのジョブに必要なクレジットが不足しています。プランをアップグレードするか、クレジットパックを購入してください。
400VIDEO_TOO_LONG選択したオプションで許可される動画の長さの上限を超えています。
429RATE_LIMITEDリクエストが多すぎます。しばらく待ってから再試行してください。

よくある質問

顔交換 API は誰が使えますか?

有効なサブスクリプションプランを持つすべてのアカウントで使えます。無料アカウントはウェブアプリを利用できますが、API は利用できません。

API リクエストの料金はいくらですか?

ウェブアプリと同じです。画像の顔交換は 15 クレジット、動画の顔交換は 20 クレジットです。リクエストはウェブでの利用と同じクレジット残高から消費されます。

API は動画の顔交換に対応していますか?

はい。targetType を video に設定してください。通常の動画顔交換は最大 300 秒まで、顔またはフレームの強化を有効にした場合は最大 90 秒まで対応します。

結果はどのように取得しますか?

status が succeeded になるまで GET /api/v1/face-swap/{taskId} をポーリングしてください。レスポンスの outputUrl にホストされた結果ファイルが入ります。

ジョブが失敗した場合はどうなりますか?

失敗したジョブは自動的に返金されます。ステータスレスポンスの error フィールドに失敗の理由が入ります。

サブスクリプションが終了するとどうなりますか?

APIキーは直ちに使用できなくなります。再度サブスクリプションに登録すると再び使えるようになるため、新しいキーを作成する必要はありません。

開発を始めましょう

APIキーを作成して、数分で最初の顔交換を実行しましょう。

APIキーを作成