本番APIリファレンス
DeepSwapAI AI顔交換API
写真、写真バッチ、グループ写真のマッピング、動画、GIFを同じ本番インターフェースに接続できます。主要な契約、料金単位、タスク状態、境界を確認し、完全なフィールドとレスポンスは英語版リファレンスで確認してください。
1つの契約、5つのワークフロー
HTTPS、multipartアップロード、JSONタスク状態
公開されている生成ルートはすべてBearer APIキーを使い、taskIdを返し、同じルートのGETでタスク状態を確認します。
直接回答
1つのAPIアカウントで5種類の入力に対応
写真、バッチ写真、グループ写真の複数人マッピング、動画、GIFは同じ本番ドメインとタスクライフサイクルを使います。リクエスト前に形式、サイズ、長さ、対象数、クレジットを確認し、送信後はtaskIdを保存して対応するGETルートをポーリングします。
現在公開されている契約
ルート、料金単位、主な制限
| ワークフロー | POSTルート | 料金単位 | 主な制限 |
|---|---|---|---|
| 写真 | POST /api/ai-tasks | 6クレジット / 出力 | 1枚のソース顔画像と1枚の対象画像 |
| 写真バッチ | POST /api/ai-tasks/batch-face-swap | 6クレジット / 出力 | ソース画像と対象画像を合計最大20枚、合計95 MB |
| グループ写真マッピング | POST /api/ai-tasks/multi-face-swap | 6クレジット / 選択した顔 | 最大10顔のマッピング、合計95 MB |
| 動画 | POST /api/ai-tasks/video | 切り上げ秒数ごとに3クレジット、最低12クレジット | MP4、MOV、WebM;600秒;最高1080p固定 |
| GIF | POST /api/ai-tasks/gif | 切り上げ秒数ごとに3クレジット、最低12クレジット | GIF、MP4、WebM;30秒 |
最小統合フロー
リクエストを検証してから生成する
- 1. APIキーはサーバー側に保管し、ブラウザ、モバイルアプリ、ログ、公開リポジトリに置かない。
- 2. ワークフローごとにmultipartフィールド、ファイル形式、サイズ、数、長さ、クレジットを検証する。
- 3. POSTを送信し、返されたtaskIdと想定料金を保存する。
- 4. 同じルートのGETエンドポイントをCOMPLETED、FAILED、CANCELLEDまでポーリングする。
- 5. タスクの所有アカウントだけに結果を渡し、公開された保持ルールに従ってメディアを削除する。
公開契約書にidempotency-keyフィールドは文書化されていません。呼び出しサービスは重複送信を無効にし、最初のtaskIdを保持し、別のPOSTを発行する前に不確かなネットワーク応答を調整する必要があります。
タスクライフサイクル
taskIdを保持し、終了状態で停止します
| または FAILED / CANCELLED | イベント | タスクレコード | クライアントアクション |
|---|---|---|---|
| タスクが受け入れられました | taskIdと予想コストを保持してください | 決済をサーバー所有として扱ってください | 測定されたポーリングを開始してください |
| タスクが完了しました | 最終結果 | 完了した作業は決済されたままです | 結果の取得を許可してください |
| 処理に失敗しました | 最終的な障害 | 現在の契約は、失敗した処理を自動的に返金します | 再送信を決定する前に障害を確認してください |
| 応答結果が不確かです | 別のPOSTの前に調整してください | タイムアウトから推測しないでください | 保存されたtaskIdまたはアカウント履歴を使用してください |
応答結果が不確かです 公開契約書にidempotency-keyフィールドは文書化されていません。呼び出しサービスは重複送信を無効にし、最初のtaskIdを保持し、別のPOSTを発行する前に不確かなネットワーク応答を調整する必要があります。
料金、プライバシー、出力
検証できる境界を統合に組み込む
APIを利用するには、メール認証とPAIDまたはCOMPLETEDのクレジット注文が1件以上必要です。報酬・試用クレジットはログイン済みWebワークフロー専用で、APIから自動化できません。1アカウント最大3キー、生成は1キー毎分6リクエストまでです。失敗タスクは現行ルールで返金され、メディアは24時間以内に削除されます。
開発者向け質問
公開前に確認すること
APIはwebhookに対応していますか?
現在は対応していません。POSTで返されたtaskIdを保存し、同じワークフロールートのGETを終端状態までポーリングします。
公式SDKはありますか?
現在、公式言語SDKは公開されていません。標準HTTPS、Bearer認証、multipart、JSONレスポンスを任意のサーバーHTTPクライアントから呼び出せます。
写真1枚のタスクはいくつのクレジットですか?
写真1枚、バッチの出力1件、グループ写真で選択した顔1件は現在12クレジットです。動画とGIFは切り上げ秒数と最低料金で計算します。
APIキーをフロントエンドに置けますか?
いいえ。APIキーはサーバー側に保管し、ブラウザのバンドル、モバイルバイナリ、ログ、分析イベント、サポートチケットに書き込まないでください。
代表タスク1件で統合を検証する
許可を得た最小のメディアサンプルでフィールド、状態、料金、結果配信を確認してから、バッチや長い動画に拡張してください。
