{
"openapi": "3.0.0",
"info": {
"title": "帽子バーチャル試着",
"description": "# 概要\n帽子バーチャル試着を作成します。\n帽子を着用した状態のプレビューを確認できます。\n\n## 統合ガイド\nこのガイドでは、以下を説明します。\n\n* **エンドポイント:** `/s2s/v2.0/task/hat`\n* **認証:** すべてのリクエストで `Authorization: Bearer YOUR_API_KEY` が必要です\n* **ワークフロー:**\n 1. **セルフィー画像の準備:** バーチャル試着のターゲットとして、ご自身の画像をアップロードするか、有効な画像 URL を指定します。\n 1. **帽子画像の準備:** 帽子の商品画像または帽子を着用した人物の写真をアップロードします。\n 1. **スタイルと性別の選択:** 希望するスタイルと、ビジュアライズしたい性別を選択します。\n 1. **AI タスクの実行とタスク ID の取得:** レスポンスから `task_id` を取得します。\n 1. **ステータスのポーリング (`GET`):** `task_id` を使用してタスクのステータスを確認します。`task_status` が `\"success\"` または `\"error\"` になるまでポーリングを続けます。\n\n---\n\n* 認証\n- **Bearer トークン** を使用して、リクエストヘッダーに API キーを含めます。\n```\nAuthorization: Bearer YOUR_API_KEY\n```\nAPI キーの確認場所: https://yce.makeupar.com/api-console/en/api-keys/.\n\n---\n\n* AI 帽子 API 使用ガイド\n\nこのガイドでは、画像のアップロード、参照用帽子の準備、および AI 帽子 API を使用したバーチャル試着タスクの作成方法について説明します。\n\n***\n\n * ステップ 1. セルフィー画像の準備\n\n以下のいずれかの方法が可能です。\n* File API (`/s2s/v2.0/file`) を使用してセルフィー画像をアップロードする、または\n* 有効な画像 URL を指定する。\n\n * ステップ 1.1 File API を使用したファイルのアップロード\n\n**File API** (`/s2s/v2.0/file`) を使用して、ターゲットユーザーの画像をアップロードします。\n\n**画像要件:**\n\n* セルフィー写真をアップロードします。\n* 写真に上半身がはっきりと写っていることを確認してください。\n* 複数の人物や気が散るオブジェクトがある背景は避けてください。\n\n**リクエスト例:**\n\n```bash\ncurl --request POST \\\n --url https://yce-api-01.makeupar.com/s2s/v2.0/file \\\n --header 'Authorization: Bearer YOUR_API_KEY' \\\n --header 'content-type: application/json' \\\n --data '{\n \"files\": [\n {\n \"content_type\": \"image/jpg\",\n \"file_name\": \"selfie_photo_01_3dbd1b6683.jpg\",\n \"file_size\": 547541\n }\n ]\n }'\n```\n\n***\n\n * ステップ 1.2. File API レスポンスの取得\n\nレスポンスには以下が含まれます。\n\n* AI タスク作成用の `file_id`。\n* 実際の画像ファイルをアップロードするための `requests.url`。\n\n**レスポンス例:**\n\n```json\n{\n \"status\": 200,\n \"data\": {\n \"files\": [\n {\n \"content_type\": \"image/jpg\",\n \"file_name\": \"selfie_photo_01_3dbd1b6683.jpg\",\n \"file_id\": \"SaGaqpDgKwFrVBgMpQMA3HY0LeqdT9/13W5TOD8/u/FfjK3xgCQ+hRt9MJXBFaud\",\n \"requests\": [\n {\n \"method\": \"PUT\",\n \"url\": \"https://yce-us.s3-accelerate.amazonaws.com/demo/ttl30/...signature...\",\n \"headers\": {\n \"Content-Length\": \"547541\",\n \"Content-Type\": \"image/jpg\"\n }\n }\n ]\n }\n ]\n }\n}\n```\n\n***\n\n * ステップ 1.3. 指定された URL への画像アップロード\n\nFile API レスポンスの `requests.url` を使用して画像をアップロードします。\n\n```bash\ncurl --location --request PUT 'https://yce-us.s3-accelerate.amazonaws.com/demo/ttl30/...signature...' \\\n --header 'Content-Type: image/jpg' \\\n --header 'Content-Length: 547541' \\\n --data-binary @'./selfie_photo_01_3dbd1b6683.jpg'\n```\n\n***\n\n * ステップ 2. 参照用帽子画像の準備\n\n以下のいずれかの方法が可能です。\n\n* File API (`/s2s/v2.0/file`) を使用して帽子画像をアップロードする、または\n* 有効な画像 URL を指定する。\n\n**サポートされる帽子画像:**\n\n* 帽子の商品画像。\n* 帽子を着用した人物の写真。\n\n詳細な仕様については、**[ファイル仕様とエラー](#section/overview/File-Specs-and-Errors)** を参照してください。\n\n***\n\n * ステップ 3. AI タスクの作成\n\n希望するスタイルと、ビジュアライズしたい性別を選択します。\n**AI タスク API** (`/s2s/v2.0/task/hat`) を使用して、バーチャル試着タスクを作成します。\n\n**パラメータ:**\n\n* ユーザー画像用: `src_file_id` または `src_file_url`。\n* 帽子画像用: `ref_file_id` または `ref_file_url`。\n\n**リクエスト例:**\n\n```bash\ncurl --request POST \\\n --url https://yce-api-01.makeupar.com/s2s/v2.0/task/hat \\\n --header 'Authorization: Bearer YOUR_API_KEY' \\\n --header 'content-type: application/json' \\\n --data '{\n \"src_file_url\": \"https://example.com/selfie.jpg\",\n \"ref_file_url\": \"https://example.com/accessory.jpg\",\n \"gender\": \"female\",\n \"style\": \"random\"\n}'\n```\n\n**レスポンス例:**\n\n```json\n{\n \"status\": 200,\n \"data\": {\n \"task_id\": \"SaGaqpDgKwFrVBgMpQMA3HY0LeqdT9_13W5TOD8_u_GPi6NqQ3dhlmN-6ntFwhzT\"\n }\n}\n```\n\n***\n\n * ステップ 4. タスク結果のポーリング\n\nタスク ID を使用してステータスを確認します。\n\n```bash\ncurl --request GET \\\n --url https://yce-api-01.makeupar.com/s2s/v2.0/task/hat/SaGaqpDgKwFrVBgMpQMA3HY0LeqdT9_13W5TOD8_u_GPi6NqQ3dhlmN-6ntFwhzT \\\n --header 'Authorization: Bearer YOUR_API_KEY' \\\n --header 'content-type: application/json'\n```\n\n***\n\n * ステップ 5. 結果の取得\n\n成功したレスポンスには、結果画像のダウンロード URL が含まれます。\n\n```json\n{\n \"status\": 200,\n \"data\": {\n \"error\": null,\n \"results\": {\n \"url\": \"https://yce-us.s3-accelerate.amazonaws.com/demo/ttl30/...signature...\"\n },\n \"task_status\": \"success\"\n }\n}\n```\n\n無効な API キーエラーレスポンス:\n\n```json\n{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"error_code\": \"InvalidAccessToken\"\n}\n```\n\n---\n\n## ファイル仕様とエラー\n\n* 帽子バーチャル試着仕様\n\n * 画像要件\n\n| 種類 | 最小解像度 | 備考 |\n| ------ | ------------------ | ----- |\n| セルフィー | 512 × 512 | 顔が見えること、頭から胸までが推奨 |\n| 帽子 | 512 × 512 (商品)
800 × 800 (着用時) | 帽子がはっきりと、遮られずに写っていること |\n\n**サポートされる帽子画像**\n\n* 商品画像要件\n * 最小解像度: 512 × 512 ピクセル\n * 画像あたり 1 つの商品のみ\n * 商品は画像の高さの 25% 以上を占める必要があります\n\n\n\n* 着用画像要件\n * 最小解像度: 800 × 800 ピクセル\n * 単一アイテム要件: モデルは正確に 1 つのアイテムのみを着用している必要があります。複数のアイテムやアクセサリーは許可されません。\n * カバレッジ比率: 着用したアイテムは画像全体の height の 20% 以上を占める必要があります。これにより、アイテムがフレーム内で明確かつ目立つことが保証されます。\n\n\n\n**サポートされるセルフィービュー**\n\n* 推奨画像解像度: 少なくとも 512 × 512 ピクセル。\n* 推奨顔のカバレッジ: 画像 height の 15% 以上。\n* 単一被写体要件: 画像には正確に 1 人の人間の被写体のみが含まれている必要があります。追加の人物や部分的な人物像は許可されません。\n* 顔の可視性: 被写体の顔が遮られることなく完全に可視である必要があります。髪、アクセサリー、またはオブジェクトが主要な顔の特徴を覆ってはいけません。\n* フレーミング: 画像には少なくとも頭部ショットが含まれており、頭頂部から胸までの領域をカバーする必要があります。最適な分析のためには、半身ショット（頭から腰まで）が推奨されます。\n\n\n\n**試着スタイル**\n\n* バーチャル試着出力を生成するための 5 つの事前定義されたスタイルがあります: \"style_sporty_casual\" \"style_urban_fashion\" \"style_vacation_casual\" \"style_warm_cozy\" および \"style_bohemian\"。AI タスク作成時にこの style パラメータを指定するか、デフォルトでシステムがランダムにスタイルを選択するようにできます。\n\n\n\n---\n\n* サポートされる形式と寸法\n\n| AI 機能 | サポートされる寸法 | サポートされるファイルサイズ | サポートされる形式 |\n| ---- | ---- | ---- | ---- |\n| 帽子バーチャル試着 | 入力: 長辺 <= 4096
出力: 896 x 1152 | < 10MB | jpg/jpeg/png/heic |\n\n* エラーコード\n\n| エラーコード | 説明 |\n| ------------------------------ | -------------------------------------------- |\n| error\\_download\\_image | ソースまたは参照画像のダウンロードに失敗しました |\n| error\\_inference | 推論パイプラインエラー |\n| error\\_no\\_face | ソース画像で顔が検出されませんでした |\n| error\\_nsfw\\_content\\_detected | 結果に NSFW コンテンツが検出されました |\n| exceed\\_max\\_filesize | ファイルサイズが 10 MB を超えています |\n| invalid\\_parameter | 無効な gender または style 値 |\n| unknown\\_internal\\_error | その他の内部エラー |\n\n\n* 環境と依存関係\n\n| サンプルコード言語 / ツール | 推奨ランタイムバージョン |\n|---|---|\n| cURL | - bash >= 3.2 - curl >= 7.58 (モダンな TLS/HTTP サポート) - jq >= 1.6 (堅牢な JSON 解析) |\n| Node.js (JavaScript) | Node >= 18 (グローバル fetch のため) |\n| JavaScript | - Chrome / Edge >= 80 - Firefox >= 74 - Safari >= 13.1 |\n| PHP | PHP >= 7.4 (モダンな TLS/互換性のため), ext-curl (推奨) または allow_url_fopen=On + ext-openssl, ext-json |\n| Python | Python >= 3.10 (f-strings のため), requests >= 2.20.0 |\n| Java | Java 11+ (HttpClient のため), Jackson Databind >= 2.12.0 |\n\n---\n\n## ユニット消費\n\n| AI 機能 | 消費ユニット |\n|---|---|\n| 帽子バーチャル試着 V2.0 | 2 |\n\n---\n",
"version": "",
"termsOfService": "https://www.makeupar.com/perfectbeauty/youcam/terms-of-service-api",
"contact": {
"email": "YouCamOnlineEditor_API@perfectcorp.com"
},
"license": {
"name": "Privacy policy",
"url": "https://www.makeupar.com/perfectbeauty/youcam/privacy-policy-api"
}
},
"servers": [
{
"url": "https://yce-api-01.makeupar.com"
}
],
"tags": [
{
"name": "V2.0",
"description": "アップロードされた画像から帽子のバーチャル試着を生成します。性別別のスタイルパラメータをサポートします。"
}
],
"paths": {
"/s2s/v2.0/task/hat": {
"post": {
"summary": "帽子バーチャル試着タスクを実行します。",
"description": "このエンドポイントは、帽子のバーチャル試着プロセスを開始します。ソースファイル、参照ファイル（URL または ID）、性別、スタイルパラメータを指定する必要があります。タスクは非同期で処理され、このレスポンスで返される task_id を使用してステータスを確認できます。\n",
"tags": [
"V2.0"
],
"security": [
{
"BearerAuthenticationV2": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GenderRunTaskV2"
},
{
"type": "object",
"properties": {
"style": {
"type": "string",
"enum": [
"random",
"style_sporty_casual",
"style_urban_fashion",
"style_vacation_casual",
"style_warm_cozy",
"style_bohemian"
],
"default": "random",
"description": "服装と背景のスタイルを制御します。",
"example": "random"
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "タスクの実行に成功しました",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BasicRunTaskResponseV2"
}
}
}
},
"400": {
"description": "タスクの実行に失敗しました",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/RunError"
}
]
}
}
}
},
"401": {
"$ref": "#/components/responses/InvalidApiKey"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
}
}
},
"/s2s/v2.0/task/hat/{task_id}": {
"get": {
"summary": "帽子バーチャル試着タスクのステータスを確認します。",
"tags": [
"V2.0"
],
"security": [
{
"BearerAuthenticationV2": []
}
],
"parameters": [
{
"name": "task_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "grH0CvsgXuAIHLUzD0V1Ol34hoet3R1tvdbtiVHrDb6_UqCLKIejAIajwxrhOAfe"
},
"description": "確認するタスクの ID"
}
],
"responses": {
"200": {
"description": "タスクステータスの確認に成功しました",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskStatusResponseV2"
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidTaskId"
},
"401": {
"$ref": "#/components/responses/InvalidApiKey"
},
"500": {
"$ref": "#/components/responses/TaskTimeout"
}
}
}
}
},
"components": {
"securitySchemes": {
"BearerAuthenticationV2": {
"type": "http",
"scheme": "bearer",
"description": "標準の 'Bearer authentication' を使用します。ヘッダーに 'API Key' を設定します: `Authorization:Bearer YOUR_API_KEY`。'Bearer' と 'YOUR_API_KEY' の間にスペース ' ' があることに注意してください。"
}
},
"schemas": {
"BasicRunTaskV2SrcFileUrl": {
"type": "object",
"required": [
"src_file_url"
],
"properties": {
"src_file_url": {
"type": "string",
"description": "タスクを実行するファイルの URL。この URL は公開されている必要があります。",
"example": "https://example.com/selfie.jpg"
}
}
},
"BasicRunTaskV2RefFileUrl": {
"type": "object",
"properties": {
"ref_file_url": {
"type": "string",
"description": "タスクを実行するための参照ファイルの URL。この URL は公開されている必要があります。",
"example": "https://example.com/accessory.jpg"
}
}
},
"BasicRunTaskV2RefFileId": {
"type": "object",
"properties": {
"ref_file_id": {
"type": "string",
"description": "タスクを実行するための参照ファイルの ID。ファイルアップロード API から取得したファイル ID です。",
"example": "pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
}
}
},
"BasicRunTaskV2SrcFileId": {
"type": "object",
"required": [
"src_file_id"
],
"properties": {
"src_file_id": {
"type": "string",
"description": "タスクを実行するファイルの ID。ファイルアップロード API から取得したファイル ID です。",
"example": "pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
}
}
},
"BasicRunTaskV2WithRequiredRef": {
"title": "BasicRunTaskV2WithRef",
"anyOf": [
{
"allOf": [
{
"title": "src ファイル URL と参照ファイル URL でタスクを実行",
"required": [
"ref_file_url"
]
},
{
"$ref": "#/components/schemas/BasicRunTaskV2SrcFileUrl"
},
{
"$ref": "#/components/schemas/BasicRunTaskV2RefFileUrl"
}
]
},
{
"allOf": [
{
"title": "src ファイル URL と参照ファイル ID でタスクを実行",
"required": [
"ref_file_id"
]
},
{
"$ref": "#/components/schemas/BasicRunTaskV2SrcFileUrl"
},
{
"$ref": "#/components/schemas/BasicRunTaskV2RefFileId"
}
]
},
{
"allOf": [
{
"title": "src ファイル ID と参照ファイル URL でタスクを実行",
"required": [
"ref_file_url"
]
},
{
"$ref": "#/components/schemas/BasicRunTaskV2SrcFileId"
},
{
"$ref": "#/components/schemas/BasicRunTaskV2RefFileUrl"
}
]
},
{
"allOf": [
{
"title": "src ファイル ID と参照ファイル ID でタスクを実行",
"required": [
"ref_file_id"
]
},
{
"$ref": "#/components/schemas/BasicRunTaskV2SrcFileId"
},
{
"$ref": "#/components/schemas/BasicRunTaskV2RefFileId"
}
]
}
]
},
"GenderRunTaskV2": {
"allOf": [
{
"$ref": "#/components/schemas/BasicRunTaskV2WithRequiredRef"
},
{
"type": "object",
"required": [
"gender"
],
"properties": {
"gender": {
"type": "string",
"enum": [
"female",
"male"
],
"description": "画像内の人物の性別です。",
"example": "female"
}
}
}
]
},
"BasicRunTaskResponseV2": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "レスポンスステータス",
"example": 200
},
"data": {
"type": "object",
"properties": {
"task_id": {
"type": "string",
"description": "このタスクの ID。タスクの結果は、この ID を使用して 24 時間以内にクエリできます。",
"example": "grH0CvsgXuAIHLUzD0V1Ol34hoet3R1tvdbtiVHrDb6_UqCLKIejAIajwxrhOAfe"
}
}
}
}
},
"RunError": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "レスポンスステータス",
"example": 400
},
"error": {
"type": "string",
"description": "エラーメッセージ",
"example": "The operation could not be completed"
},
"error_code": {
"type": "string",
"enum": [
"InvalidParameters",
"CreditInsufficiency",
"InvalidStyleGroup",
"InvalidStyle",
"BadRequest"
],
"description": "エラーコード:\n * InvalidParameters - 無効なリクエストパラメータ\n * CreditInsufficiency - 実行に必要なユニットが不足しています\n * BadRequest - 予期しないリクエストパラメータ\n * InvalidStyleGroup - 無効なスタイルグループ ID\n * InvalidStyle - 無効なスタイル ID"
}
}
},
"EngineErrorCode": {
"type": "string",
"nullable": true,
"enum": [
"error_exceed_max_image_size",
"exceed_max_filesize",
"invalid_parameter",
"error_download_image",
"error_download_mask",
"error_decode_image",
"error_decode_mask",
"error_nsfw_content_detected",
"error_no_face",
"error_pose",
"error_face_parsing",
"error_inference",
"exceed_nsfw_retry_limits",
"error_upload",
"unknown_internal_error"
],
"description": "エラー：\n- `error_exceed_max_image_size` - 入力画像サイズが最大制限を超えています\n- `exceed_max_filesize` - 入力ファイルサイズが最大制限を超えています\n- `invalid_parameter` - 無効なパラメータ値\n- `error_download_image` - ソース画像のダウンロードエラー\n- `error_download_mask` - マスク画像のダウンロードエラー\n- `error_decode_image` - ソース画像のデコードエラー\n- `error_decode_mask` - マスク画像のデコードエラー\n- `error_nsfw_content_detected` - ソース画像で NSFW コンテンツが検出されました\n- `error_no_face` - ソース画像で顔が検出されませんでした\n- `error_pose` - ソース画像でポーズの検出に失敗しました\n- `error_face_parsing` - ソース画像での顔セグメンテーションに失敗しました\n- `error_inference` - 推論パイプラインエラー\n- `exceed_nsfw_retry_limits` - NSFW 画像の生成を避けるための再試行制限を超えました\n- `error_upload` - 結果画像のアップロードエラー\n- `unknown_internal_error` - その他\n"
},
"TaskStatusResponseBodySingleUrlResultsV2": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "この結果をダウンロードする URL。有効期間は 2 時間です",
"example": "https://example.com/sample-result-url"
}
}
},
"TaskStatusResponseV2": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "レスポンスステータス",
"example": 200
},
"data": {
"type": "object",
"properties": {
"task_status": {
"type": "string",
"enum": [
"running",
"success",
"error"
],
"description": "このタスクのステータス"
},
"error": {
"$ref": "#/components/schemas/EngineErrorCode"
},
"error_message": {
"type": "string",
"description": "エラーの詳細な説明"
},
"results": null
}
}
},
"$ref": "#/components/schemas/TaskStatusResponseBodySingleUrlResultsV2"
}
},
"responses": {
"InvalidApiKey": {
"description": "無効または欠落している API キー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"example": 401,
"description": "レスポンスステータス"
},
"error": {
"type": "string",
"example": "Invalid API key"
}
}
}
}
}
},
"TooManyRequests": {
"description": "リクエストが多すぎます",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"example": 429,
"description": "レスポンスステータス"
},
"error": {
"type": "string",
"example": "Too many requests"
}
}
}
}
}
},
"InvalidTaskId": {
"description": "無効なタスク ID",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"example": 400,
"description": "レスポンスステータス"
},
"error": {
"type": "string",
"example": "Invalid task ID"
}
}
}
}
}
},
"TaskTimeout": {
"description": "タスク実行タイムアウト",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"example": 500,
"description": "レスポンスステータス"
},
"error": {
"type": "string",
"example": "Task execution timed out"
}
}
}
}
}
}
}
}
}