言語: JA
事前登録

商品写真スタジオを、API で。

Herofab API は商品写真とツール名を受け取り、ジョブをバックグラウンドで処理します。完成画像をダウンロードできる状態になったことは、状態確認または署名付き Webhook でわかります。

  • Bearer 方式の API キー
  • 署名付き Webhook
  • バッチあたり最大100ジョブ
  • OpenAPI 3.1 と llms.txt
curl https://app.herofab.app/api/v1/jobs -H "Authorization: Bearer $HEROFAB_API_KEY" -H "Idempotency-Key: $(uuidgen)" --json '{"tool": "ghost_mannequin", "inputs": {"garment": "ASSET_ID"}}'
仕組み

写真から完成画像まで。

01

送信

商品写真をアップロードし、ツールと設定を指定してジョブを作成します。ジョブの作成時にクレジットが確保されます。

POST /api/v1/assetsPOST /api/v1/jobs

02

確認

ジョブが完了するまで状態を確認するか、完了時に署名付き Webhook を受信します。

GET /api/v1/jobs/{id}

03

ダウンロード

ジョブ出力のアセット ID で完成画像を取得します。

GET /api/v1/assets/{id}/content

完全な例:写真をアップロード、ジョブを作成、完了を待つ、ダウンロード
API=https://app.herofab.app/api/v1
AUTH="Authorization: Bearer $HEROFAB_API_KEY"

# 1 · Upload the product photo
ASSET_ID=$(curl -s "$API/assets" \
  -H "$AUTH" \
  -F [email protected] | jq -r .id)

# 2 · Create the job
BODY=$(jq -n --arg garment "$ASSET_ID" '{tool: "ghost_mannequin",
  inputs: {garment: $garment}, params: {style: "3d", backdrop: "white"}}')
JOB_ID=$(curl -s "$API/jobs" \
  -H "$AUTH" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "$BODY" | jq -r .id)

# 3 · Poll until the job is finished
while :; do
  JOB=$(curl -s "$API/jobs/$JOB_ID" -H "$AUTH")
  STATE=$(jq -r .state <<<"$JOB")
  [ "$STATE" = queued ] || [ "$STATE" = running ] || break
  sleep 2
done
[ "$STATE" = succeeded ] || { jq -r .failure.code <<<"$JOB"; exit 1; }

# 4 · Download the image
OUTPUT_ID=$(jq -r '.outputs[0].asset_id' <<<"$JOB")
EXT=$(jq -r '.outputs[0].content_type | ltrimstr("image/")' <<<"$JOB")
curl -sL "$API/assets/$OUTPUT_ID/content" -H "$AUTH" -o "result.$EXT"
早期アクセス

次のコレクションを、今週のうちに撮影。

早期アクセス開始時に20クレジットを無料で付与します。カード登録は不要です。