{"templateId":"api_docs","sharedDataIds":{"apiDocsStore":"api-docs-@l10n/ja/reference/ai_look_vto.yaml","sidebar":"sidebar-@l10n/ja/reference/sidebars.yaml"},"props":{"definitionId":"@l10n/ja/reference/ai_look_vto.yaml","settings":{"baseUrlPath":"/ja/reference/ai_look_vto"},"disableAutoScroll":true,"seo":{"title":"フルメイク","description":"YouCam API documentation by Perfect Corp. Learn how to use Skin analysis API, Virtual try-on API, Image editing API, and Video generative AI APIs.","siteUrl":"https://docs.perfectcorp.com","keywords":"AI Skin Analysis, AI Clothes, AI Hairstyle, AI Outfits","image":"/assets/favicon.cd6fa4d833b2a573b3c6dae68386b293da205b203402cb0c97b80bd2acc07ea2.8351e24f.png"},"dynamicMarkdocComponents":[],"metadata":{"type":"openapi","title":"フルメイク","version":"","description":"# 概要\nフルメイク API では、事前定義されたメイクアップルックをユーザー写真に適用します。\n\n## 統合ガイド\nこのガイドでは、以下の手順を解説します。\n\n*   **エンドポイント:** `/s2s/v2.0/task/look-vto`\n*   **認証:** すべてのリクエストには `Authorization: Bearer <TOKEN>` が必要です\n*   **ワークフロー:**\n    1.  **セルフィーの準備:** 画像をアップロードするか、有効な画像 URL を指定します\n    1.  **ルックテンプレートのリスト取得:** 利用可能な AI ルックテンプレートを一覧表示します\n    1.  **タスクの開始 (`POST`):** 画像 ID/URL とルック ``template_id`` を送信します。\n    1.  **タスク ID の取得:** レスポンスから `task_id` を取得します。\n    1.  **ステータスのポーリング (`GET`):** `task_id` を使用してタスクのステータスを確認します。`task_status` が `\"success\"` または `\"error\"` になるまでポーリングを継続します。\n\n---\n\n* API プレイグラウンド\n\nAPI プレイグラウンドで API を対話的にテストします。\n\n**API プレイグラウンド:**\n[http://yce.makeupar.com/api-console/en/api-playground/ai-look-virtual-try-on/](http://yce.makeupar.com/api-console/en/api-playground/ai-look-virtual-try-on/)\n\n---\n\n* 認証\n- リクエストヘッダーに **Bearer トークン** を使用して API キーを含めます:\n    ```\n    Authorization: Bearer <API Key>\n    ```\nAPI キーの確認場所: https://yce.makeupar.com/api-console/en/api-keys/.\n\n\n* 1. 画像のアップロード\n\nサーバーにファイルを直接アップロードするか、VTO タスクペイロードに有効な画像 URL を指定します。\n\n   * アップロードエンドポイント\n\n```\nPOST /s2s/v2.0/file\n```\n\nすでに公開されている画像 URL がある場合は、この手順をスキップできます。\n\n---\n\n* 2. 利用可能なルックスタイルのリスト取得\n\nバーチャル試着に利用可能なすべての AI メイクアップルックテンプレートを取得します。\n\n   * エンドポイント\n\n```\nGET /s2s/v2.0/task/template/look-vto\n```\n\n   * クエリパラメータ\n\n| パラメータ        | 説明                     |\n| ---------------- | ------------------------------- |\n| `page_size`      | ページあたりの項目数        |\n| `starting_token` | ページネーション用トークン（省略可） |\n\n   * JavaScript リクエスト例\n\n```javascript\nconst data = null;\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener('readystatechange', function () {\n    if (this.readyState === this.DONE) {\n        console.log(this.responseText);\n    }\n});\n\nxhr.open('GET', 'https://yce-api-01.makeupar.com/s2s/v2.0/task/template/look-vto?page_size=20&starting_token=73a3c9e69b89');\nxhr.setRequestHeader('Authorization', 'Bearer <access_token for v1, API Key for v2>');\n\nxhr.send(data);\n```\n\n   * 成功時のレスポンス例\n\n```json\n{\n  \"status\": 200,\n  \"data\": {\n    \"templates\": [\n      {\n        \"id\": \"good_template_001\",\n        \"thumb\": \"thumbnail preview image URL\",\n        \"title\": \"Berry Smooth\",\n        \"category_name\": \"Daily\"\n      }\n    ],\n    \"next_token\": 73a3c9e69b89\n  }\n}\n```\n\n> **備考:** Look VTO タスクを作成する際は、`id` 値（`template_id`）を使用してください。\n\n---\n\n* 3. Look VTO タスクの作成と結果のポーリング\n\n画像とテンプレート ID が用意できたら、タスクを作成します。API はリクエストを非同期で処理します。ステータスが `success` または `error` になるまで、タスクステータスをポーリングする必要があります。\n\n   * タスク作成エンドポイント\n\n```\nPOST /s2s/v2.0/task/look-vto\n```\n\n   * ポーリングエンドポイント\n\n```\nGET /s2s/v2.0/task/look-vto/{task_id}\n```\n\n---\n\n   * JavaScript 実装例\n\n```javascript\nconst BASE_URL = 'https://yce-api-01.makeupar.com/s2s/v2.0/task/look-vto';\nconst START_METHOD = 'POST';\nconst HEADERS = {\n  \"Content-Type\": \"application/json\",\n  \"Authorization\": \"Bearer FT6Xa7xuU1SBU2ZW6pdAAUh9D093kuX3\"\n};\n\nconst sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));\n\nasync function startTask() {\n  const init = {\n    method: START_METHOD,\n    headers: HEADERS,\n    body: JSON.stringify({\n      \"src_file_url\": \"https://plugins-media.makeupar.com/strapi/assets/sample_Image_7_fa28b2618a.jpg\",\n      \"template_id\": \"all_rosy_chic\"\n    })\n  };\n\n  const res = await fetch(BASE_URL, init);\n  if (!res.ok) throw new Error(`Start request failed: ${res.status} ${res.statusText}`);\n\n  const payload = await res.json().catch(() => ({}));\n  const taskId = payload?.data?.task_id;\n  if (!taskId) throw new Error('task_id missing: ' + JSON.stringify(payload));\n\n  console.log('[startTask] Task started, id =', taskId);\n  return taskId;\n}\n\nasync function pollTask(taskId, { intervalMs = 2000, maxAttempts = 300 } = {}) {\n  for (let attempt = 1; attempt <= maxAttempts; attempt++) {\n    const pollUrl = `${BASE_URL}/${taskId}`;\n    const res = await fetch(pollUrl, { method: 'GET', headers: HEADERS });\n\n    if (!res.ok) throw new Error(`Polling failed: ${res.status} ${res.statusText}`);\n\n    const payload = await res.json().catch(() => ({}));\n    const status = payload?.data?.task_status;\n    console.log(`[pollTask] Attempt ${attempt} status = ${status}`);\n\n    if (status === 'success') {\n      console.log('[pollTask] Success results:', payload?.data?.results);\n      return payload;\n    }\n\n    if (status === 'error') {\n      throw new Error('Task failed: ' + JSON.stringify(payload));\n    }\n\n    await sleep(intervalMs);\n  }\n\n  throw new Error('Polling timeout: Max attempts exceeded');\n}\n\n(async () => {\n  try {\n    const taskId = await startTask();\n    const final = await pollTask(taskId);\n    console.log('[main] Final response:', final);\n  } catch (e) {\n    console.error('[main] Flow error:', e);\n  }\n})();\n```\n\n---\n\n   * 成功時のレスポンス例\n\n```json\n{\n  \"status\": 200,\n  \"data\": {\n    \"results\": {\n      \"url\": \"https://yce-us.s3-accelerate.amazonaws.com/demo/.../result.jpg?...\"\n    },\n    \"task_status\": \"success\"\n  }\n}\n```\n\n`results.url` フィールドには、最終的にレンダリングされたバーチャルメイク画像が含まれます。\n\n---\n\n* まとめ\n\n| ステップ                       | 説明                              |\n| -------------------------- | ---------------------------------------- |\n| **1. 画像のアップロード**        | 直接アップロードするか、画像 URL を指定します。 |\n| **2. ルックテンプレートのリスト取得** | ID 付きで利用可能なルックスタイルを取得します。 |\n| **3. VTO タスクの作成**     | 画像 URL + テンプレート ID を送信します。          |\n| **4. 完了のポーリング** | 最終的な結果画像 URL を取得します。     |\n\n---\n\n## ファイル仕様とエラー\n* 対応フォーマットと寸法\n\n|AI 機能|対応寸法|対応ファイルサイズ|対応フォーマット|\n|  ----  | ----  | ----  | ----  |\n|フルメイク|長辺 < 1920、顔幅 >= 100|< 10MB|jpg/jpeg/png|\n\n* エラーコード\n\n|エラーコード|説明|\n|  ----  | ----  |\n|error_below_min_image_size|ソース画像のサイズが最小値より小さいです（期待値: 幅 >= 100px、高さ >= 100px）\n|error_exceed_max_image_size|ソース画像のサイズが最大値より大きいです（期待値: 幅 < 1920px、高さ < 1080px）\n|error_face_position_invalid |画像内で顔全体が完全に確認できることを確認してください|\n|error_face_position_too_small|検出された顔が小さすぎます。カメラに近づいてください|\n|error_face_position_out_of_boundary|顔が大きすぎるか、画像フレームの一部が外れています。位置を調整してください|\n|error_face_angle_invalid|顔の角度が正しくありません。正面を向いた写真の場合は、頭を 10° 以内に保ってください。横を向いた写真の場合は、15° 以上にしてください。|\n\n* 環境と依存関係\n\n| サンプルコード言語 / ツール | 推奨ランタイムバージョン |\n|---|---|\n| cURL | - bash >= 3.2</br>   - curl >= 7.58 (モダンな TLS/HTTP サポート)</br>   - jq >= 1.6 (堅牢な JSON 解析) |\n| Node.js (JavaScript) | Node >= 18 (グローバル fetch 用) |\n| JavaScript | - Chrome / Edge >= 80</br>   - Firefox >= 74</br>   - 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-string 用), requests >= 2.20.0 |\n| Java | Java 11+ (HttpClient 用), Jackson Databind >= 2.12.0 |\n\n---\n\n## ユニット消費量\n\n| AI 機能 | 消費ユニット |\n|---|---|\n| フルメイク V1.0 | 2 |\n\n---\n"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"docs.perfectcorp.com","port":4000,"ipAddress":"216.73.216.218"},"lang":"ja","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"master"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/ja/reference/ai_look_vto","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}