ガイド · バーチャルtry-on

バーチャルtry-on APIとは？ 返却されるデータの内容

要約

バーチャルtry-on APIは、衣服の写真を受け取り、その衣服をモデルが着用した画像を返します。マネキンとポーズを指定して写真をPOSTし、ジョブをpollingして、結果をダウンロードします。

APIキーを取得ドキュメントを見る
  • 所要時間の目安: 1.5–4 min
  • Credits: 2Kで5 credits · 4Kで6 credits
  • 処理方式: 非同期、ポーリング

このページに記載されている数値はすべて以下に基づきます: Photta APIドキュメント · 確認済み

要約

バーチャル試着（try-on）APIは、衣服をモデルに着せてレンダリングするHTTPエンドポイントです。製品の写真（通常は既存の平置き写真やトルソー着せ写真）を送信すると、その衣服を着用した画像が返されます。スタジオ撮影も、モデルの手配も、カラーバリエーション追加時の再撮影も不要です。

レンダリングには通常のリクエストの待機時間を超える時間を要するため、呼び出しは非同期処理となっています。希望するモデルとポーズを指定して衣服データをPOSTすると、APIがジョブを受け付けてidを返します。あとはジョブが完了を報告するまでステータスエンドポイントをポーリングします。完成した画像はURLとして提供されるため、自身でダウンロードして保存します。

主な利用例としては、スタジオ撮影を行わない製品の着用画像を必要とするカタログ制作チーム、出品者から平置き写真を受け取るマーケットプレイス、ブランド専属のフィットモデル以外の体型で着用イメージを確認できるアプリなどが挙げられます。

処理を実行するエンドポイント

手作業で書かれたものではなく、PhottaのAPIドキュメントから生成されています。

概要

エンドポイント
POST /api/v1/tryon/apparel
認証
Bearer APIキー
処理方式
非同期 — ステータスエンドポイントをポーリング
所要時間の目安
1.5–4 min
Credits
2Kで5 credits · 4Kで6 credits
アスペクト比
3:4 · 1:1 · 4:3 · 9:16 · 16:9
入力制限
1画像あたり最大10 MB、JPEG, PNG, WebP
冪等性
なし

try-on API選定時の確認ポイント

  • 送信データ

    https URLまたはbase64データURI形式の衣服写真に加え、希望するモデルとポーズを指定します。Phottaは画像1枚あたり最大10 MBまでのJPEG、PNG、WebPに対応しています。

  • 処理時間

    単一のWebリクエスト内で完結できない程度の時間を要します。Phottaはエンドポイントごとに標準的な完了時間を公開しており、3秒ごとのポーリングを前提としています（Webhookは非対応です）。

  • コスト

    Phottaでは呼び出しごとにcreditsが消費されます。アパレル試着の場合、2Kで5、4Kで6がジョブ開始時に差し引かれ、失敗時には自動的に返金されます。

  • 適用される制限

    APIキーごとに毎分600リクエストの公開レート制限があり、さらにプランごとに同時レンダリング数の上限が設けられています。カタログ規模で一括処理を実行する前に、双方の制限を確認しておくことを推奨します。

最初のリクエスト

cURL、Node.js、Pythonでの同一の呼び出し例。

RESPONSE=$(curl -s -X POST https://api.photta.app/api/v1/tryon/apparel \
  -H "Authorization: Bearer $PHOTTA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "product_type": "top",
  "product_images": [
    "https://cdn.yourstore.com/products/shirt-front.jpg"
  ],
  "product_back_image": "https://cdn.yourstore.com/products/shirt-back.jpg",
  "product_category": "t_shirt",
  "mannequin_id": "mnk_f3a9b1",
  "pose_id": "pose_c2d4e5",
  "background": "https://cdn.yourstore.com/backgrounds/studio-loft.jpg",
  "lock_background": true,
  "resolution": "2K",
  "aspect_ratio": "3:4",
  "body_size": "M",
  "expression": "neutral",
  "user_instruction": "Keep the collar pattern crisp and centered."
}')
ID=$(echo "$RESPONSE" | jq -r '.data.id')

バーチャルtry-on APIに関する質問

試着APIは何を返しますか？

選択したモデルが衣服を着用した画像が、完了したジョブのURLとして返されます。配信URLは永続的なホスティングではないため、ダウンロードして各自で保存してください。

モデルの写真は必要ですか？

不要です。Phottaが用意しているマネキンカタログから選択できるほか、属性を指定して独自のモデルを生成したり、手持ちのモデル画像をアップロードすることも可能です。必須となる画像は衣服の写真のみです。

バーチャルフィッティングルームとはどう違うのですか？

フィッティングルームは購入者向けの機能です。試着APIはその裏側で動作するレンダリング処理（1回の呼び出しで1枚の画像を出力）を指します。このAPIを基盤としてフィッティングルームを構築することも、単にカタログ写真の生成用途として利用することも可能です。

試着の呼び出しにはいくらコストがかかりますか？

Phottaでは、2Kで5 credits、4Kで6 creditsです。失敗したジョブの分は返金されるため、リトライにかかるコストはリトライ分のみとなります。

画像1枚の生成にどのくらい時間がかかりますか？

エンドポイントごとに標準完了時間が公開されており、各ジョブ自身がステータスを返します。所要時間をあらかじめ仮定せず、3秒ごとにポーリングを行ってください。

次に読む

このページに記載されている数値はすべて以下に基づきます: Photta APIドキュメント · 確認済み

手元の製品写真で試す

1回のリクエスト、1回のポーリング、1枚の画像。

アカウントを作成してAPIキーを取得エンドポイントを見る
  • 1.5–4 min
  • 2Kで5 credits · 4Kで6 credits
  • 非同期、ポーリング