リファレンス · リソース
Photta API リソースエンドポイント すべての生成に必要なID群
要約
リソースエンドポイントは、生成コールに必要な各種ID(マネキン、ポーズ、背景、フットウェア、衣服の属性、ブランドラベル)に加え、アカウント残高や使用状況を返します。一覧取得に費用はかかりません。
- リソースエンドポイント: 13 件のリソースエンドポイント
- 認証: Bearerキー
- 制限: 600 リクエスト/分
このページに記載されている数値はすべて以下に基づきます: Photta APIドキュメント · 確認済み
各リソースエンドポイントと取得用のAPIコール
各セクションには、取得したIDを使用する機能へのリンクが記載されています。
マネキン
アパレルtry-onで利用可能なモデルを一覧表示します。Photta提供のシステムマネキン、独自にアップロードしたマネキン、マネキン生成APIで作成したマネキンが含まれます。同じパスにPOSTするとカスタムマネキンをアップロードでき、アカウント内でのみ非公開で保持されます。取得したIDは、try-onコールの `mannequin_id` に指定します。
curl https://api.photta.app/api/v1/mannequins \
-H "Authorization: Bearer $PHOTTA_API_KEY"const res = await fetch("https://api.photta.app/api/v1/mannequins", {
headers: { Authorization: `Bearer ${process.env.PHOTTA_API_KEY}` },
});
const { data } = await res.json();import os, requests
res = requests.get(
"https://api.photta.app/api/v1/mannequins",
headers={"Authorization": f"Bearer {os.environ['PHOTTA_API_KEY']}"},
)
data = res.json()["data"]ジュエリーマネキン
ジュエリーtry-on用のクローズアップモデル写真をアップロードします。ジュエリーの生成は首元、耳、手首、手などにフォーカスされるため、全身アパレル用とは異なる専用のマネキンセットを使用します。
RESPONSE=$(curl -s -X POST https://api.photta.app/api/v1/mannequins/jewelry \
-H "Authorization: Bearer $PHOTTA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"image": "https://cdn.yourstore.com/models/emma-neck.jpg",
"jewelry_type": "necklace",
"gender": "female",
"name": "Emma"
}')
ID=$(echo "$RESPONSE" | jq -r '.data.id')const res = await fetch("https://api.photta.app/api/v1/mannequins/jewelry", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.PHOTTA_API_KEY}`, "Content-Type": "application/json" },
body: JSON.stringify({
"image": "https://cdn.yourstore.com/models/emma-neck.jpg",
"jewelry_type": "necklace",
"gender": "female",
"name": "Emma"
}),
});
const { data } = await res.json(); // data.id, data.statusimport os, requests
res = requests.post(
"https://api.photta.app/api/v1/mannequins/jewelry",
headers={"Authorization": f"Bearer {os.environ['PHOTTA_API_KEY']}"},
json={
"image": "https://cdn.yourstore.com/models/emma-neck.jpg",
"jewelry_type": "necklace",
"gender": "female",
"name": "Emma"
},
)
data = res.json()["data"] # data["id"], data["status"]ポーズ
try-onで指定可能なポーズを一覧表示します。カテゴリや適した製品タイプでフィルタリングが可能です。IDを `pose_id` として渡します。省略した場合は、衣服に最適なポーズがAPIによって自動選択されます。
curl https://api.photta.app/api/v1/poses \
-H "Authorization: Bearer $PHOTTA_API_KEY"const res = await fetch("https://api.photta.app/api/v1/poses", {
headers: { Authorization: `Bearer ${process.env.PHOTTA_API_KEY}` },
});
const { data } = await res.json();import os, requests
res = requests.get(
"https://api.photta.app/api/v1/poses",
headers={"Authorization": f"Bearer {os.environ['PHOTTA_API_KEY']}"},
)
data = res.json()["data"]衣服の着丈とフィット感
アパレルtry-onで受け付け可能な着丈とフィット感のキーを返します。フリーテキストの説明ではなくキーを送信することで、カタログ全体で同一のシャツを一貫した形状でレンダリングできます。
curl https://api.photta.app/api/v1/garment-attributes \
-H "Authorization: Bearer $PHOTTA_API_KEY"const res = await fetch("https://api.photta.app/api/v1/garment-attributes", {
headers: { Authorization: `Bearer ${process.env.PHOTTA_API_KEY}` },
});
const { data } = await res.json();import os, requests
res = requests.get(
"https://api.photta.app/api/v1/garment-attributes",
headers={"Authorization": f"Bearer {os.environ['PHOTTA_API_KEY']}"},
)
data = res.json()["data"]背景
アパレルtry-on用のシステム背景および独自にアップロードした背景を、カーソルベースのページネーション付きで一覧表示します。同じパスにPOSTするとカスタム背景をアップロードでき、アカウント内でのみ非公開で保持されます。
curl https://api.photta.app/api/v1/backgrounds \
-H "Authorization: Bearer $PHOTTA_API_KEY"const res = await fetch("https://api.photta.app/api/v1/backgrounds", {
headers: { Authorization: `Bearer ${process.env.PHOTTA_API_KEY}` },
});
const { data } = await res.json();import os, requests
res = requests.get(
"https://api.photta.app/api/v1/backgrounds",
headers={"Authorization": f"Bearer {os.environ['PHOTTA_API_KEY']}"},
)
data = res.json()["data"]ブランドラベル
ゴーストマネキン処理で使用する再利用可能なラベル画像をアップロードし、単一ジョブやバッチ処理で `brand_label_id` として渡すIDを取得します。GETで保存済みラベルを一覧表示し、アカウントの上限に達した場合はDELETEで削除できます。
RESPONSE=$(curl -s -X POST https://api.photta.app/api/v1/brand-labels \
-H "Authorization: Bearer $PHOTTA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"file": "@/path/to/pribrand-label.png",
"name": "Pribrand Collar Label"
}')
ID=$(echo "$RESPONSE" | jq -r '.data.id')const res = await fetch("https://api.photta.app/api/v1/brand-labels", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.PHOTTA_API_KEY}`, "Content-Type": "application/json" },
body: JSON.stringify({
"file": "@/path/to/pribrand-label.png",
"name": "Pribrand Collar Label"
}),
});
const { data } = await res.json(); // data.id, data.statusimport os, requests
res = requests.post(
"https://api.photta.app/api/v1/brand-labels",
headers={"Authorization": f"Bearer {os.environ['PHOTTA_API_KEY']}"},
json={
"file": "@/path/to/pribrand-label.png",
"name": "Pribrand Collar Label"
},
)
data = res.json()["data"] # data["id"], data["status"]フットウェア
アパレルtry-on用のフットウェアオプションを、タイプや性別でフィルタリング可能なカーソルページネーション付きで一覧表示します。衣服を着用しているモデルに靴を履かせる場合に使用します。
curl https://api.photta.app/api/v1/footwear \
-H "Authorization: Bearer $PHOTTA_API_KEY"const res = await fetch("https://api.photta.app/api/v1/footwear", {
headers: { Authorization: `Bearer ${process.env.PHOTTA_API_KEY}` },
});
const { data } = await res.json();import os, requests
res = requests.get(
"https://api.photta.app/api/v1/footwear",
headers={"Authorization": f"Bearer {os.environ['PHOTTA_API_KEY']}"},
)
data = res.json()["data"]アカウント
ソース別のクレジット残高の内訳、現在のプラン、次回のクレジット更新日時を返します。大規模なバッチ処理を実行する前に確認し、402エラーによる中断を防止してください。
curl https://api.photta.app/api/v1/account \
-H "Authorization: Bearer $PHOTTA_API_KEY"const res = await fetch("https://api.photta.app/api/v1/account", {
headers: { Authorization: `Bearer ${process.env.PHOTTA_API_KEY}` },
});
const { data } = await res.json();import os, requests
res = requests.get(
"https://api.photta.app/api/v1/account",
headers={"Authorization": f"Bearer {os.environ['PHOTTA_API_KEY']}"},
)
data = res.json()["data"]使用状況
当月(カレンダー月)の請求期間における生成回数と消費クレジットを、成功および失敗したジョブ別に分類して返します。独自のリクエスト集計ではなく、このエンドポイントの数値をグラフ化してください。
curl https://api.photta.app/api/v1/account/usage \
-H "Authorization: Bearer $PHOTTA_API_KEY"const res = await fetch("https://api.photta.app/api/v1/account/usage", {
headers: { Authorization: `Bearer ${process.env.PHOTTA_API_KEY}` },
});
const { data } = await res.json();import os, requests
res = requests.get(
"https://api.photta.app/api/v1/account/usage",
headers={"Authorization": f"Bearer {os.environ['PHOTTA_API_KEY']}"},
)
data = res.json()["data"]リソースエンドポイントに関するFAQ
リソースエンドポイントは何のためにありますか?
生成コールに必要なID(マネキン、ポーズ、背景、ブランドラベルなど)やアカウントの状態を返します。このグループのエンドポイント自体が画像を生成することはありません。
リソースの呼び出しにクレジットはかかりますか?
いいえ。一覧取得は無料であり、このグループでのアップロード(カスタムマネキン、背景、ブランドラベル)も無料です。費用が発生するのは生成処理のみです。
長いリストをページネーションで取得するにはどうすればよいですか?
一覧取得エンドポイントはlimitとcursorを受け取ります。直前に取得した最後のIDを `starting_after` に渡して次のページを読み込んでください。リクエストのたびに再取得するのではなく、取得した結果をキャッシュすることを推奨します。
独自のマネキンや背景をアップロードできますか?
はい。POST `/api/v1/mannequins`、POST `/api/v1/mannequins/jewelry`、POST `/api/v1/backgrounds`、POST `/api/v1/brand-labels` のすべてで独自画像のアップロードを受け付けており、アップロードされたアセットはお客様のアカウント内でのみ非公開で保持されます。
これらのIDの使用先
機能一覧
バーチャルtry-on API アパレル向け
AIマネキンにアパレルを着せるREST API。非同期処理、生成時間は1.5〜4分、2Kで5クレジット、4Kで6クレジット。cURL、Node.js、Pythonのサンプルコードあり。
読む機能一覧
ジュエリー try-on API ネックレス、リング、ブレスレット、イヤリングに対応
REST 経由でネックレス、指輪、ブレスレット、イヤリングを AI モデルに配置。2K で 5 credits、クローズアップマネキンを内蔵、Photta のドキュメントに基づく反射を考慮したレンダリング。
読む機能一覧
ゴーストマネキン API ゴーストマネキン商品写真向け
AIゴーストマネキンエンドポイント。衣服写真からマネキンを除去し、内部のディテールを保持します。3Dまたは平置き、バッチ処理、2K で 4 credits。
読むリファレンス
5 分以内に最初の Photta 画像を生成。
サインアップ、API キーの生成、最初の cURL 呼び出しの実行、完了までのポーリング、結果の保存。エンドツーエンドで文書化された 5 つのステップ。
読むリファレンス
Photta API の認証
Photta API に対する認証方法:Authorization ヘッダー、キーのプレフィックス、キーの作成場所、および安全なローテーション方法について説明します。
読むリファレンス
Photta API の料金体系
Photta APIの各endpointにおける2Kおよび4Kでのcredits消費量、請求と返金の仕組み、無料のendpoint一覧。画像単位の金銭的価格設定はありません。
読むリファレンス
Photta APIのレートリミット
Photta APIのレートリミット、ウィンドウ幅、Retry-Afterヘッダー、ポーリング間隔、プラン別の同時実行上限など、APIドキュメントに記載された仕様です。
読むリファレンス
Photta APIのエラー
ステータスコード別のPhotta APIエラータイプ一覧、エラーボディの構造、およびリトライすべき障害。
読む
このページに記載されている数値はすべて以下に基づきます: Photta APIドキュメント · 確認済み
5分でAPIを試す
Photta APIキーを生成し、上記のcURLスニペットを貼り付ければ、コーヒーが淹れ終わる前に最初のモデル着用画像が手に入ります。
- 13 件のリソースエンドポイント
- Bearerキー
- 600 リクエスト/分