リテクスチャ API

リテクスチャ API は、Meshy の AI リテクスチャ機能をあなたのアプリケーションに統合することができる機能です。このセクションでは、この API を導入するために必要なすべての情報が記載されています。


POST/openapi/v1/retexture

リテクスチャタスクを作成する

このエンドポイントでは、新しいリテクスチャタスクを作成できます。タスクオブジェクトを参照して、リテクスチャタスクオブジェクトに含まれるプロパティを確認してください。

パラメータ

  • Name
    input_task_id
    Type
    string
    必須
    Description

    リテクスチャしたい完了済みの画像から3Dまたはテキストから3DタスクのID。このタスクは次のいずれかのタスク:テキストから3Dプレビュー、テキストから3Dリファイン、画像から3Dまたはリメッシュを完了しており、SUCCEEDEDのステータスを持つ必要があります。

  • Name
    model_url
    Type
    string
    必須
    Description

    Meshy がテクスチャ処理を行うための3Dモデルを提供します。サポートされている形式:.glb, .gltf, .obj, .fbx, .stl

    モデルを提供する方法は2通りあります:

    • 公にアクセス可能なURL: インターネット上でアクセス可能なURL。
    • Data URI: モデルのbase64エンコードされたData URI。MIMEタイプをapplication/octet-streamとします。例:data:application/octet-stream;base64,<your base64-encoded model data>
  • Name
    text_style_prompt
    Type
    string
    必須
    Description

    オブジェクトの希望するテクスチャスタイルをテキストで説明してください。最大600文字。

  • Name
    image_style_url
    Type
    string
    必須
    Description

    テクスチャリングプロセスをガイドするための2D画像を提供します。現在、.jpg.jpeg、および.png形式をサポートしています。

    画像を提供する方法は2通りあります:

    • 公にアクセス可能なURL: インターネット上でアクセス可能なURL
    • Data URI: 画像のbase64エンコードされたData URI。Data URIの例: data:image/jpeg;base64,<your base64-encoded image data>
  • Name
    multiview_image_urls
    Type
    string[]
    必須
    Description

    異なるビューから同一のオブジェクトを示す1~4枚の画像を提供し、テクスチャリングをガイドします。最初の画像は主に(前)ビューです。残りのビュー(左、後、右)の順序は問いません。

    各要素はimage_style_url(公にアクセス可能なURLまたはbase64データURI, .jpg/.jpeg/.png)と同じフォーマットを受け入れます。

  • Name
    ai_model
    Type
    string
    デフォルト latest
    Description

    リテクスチャに使用するAIモデルのID。利用可能な値:meshy-5, meshy-6, meshy-7, latest (Meshy 7)。

  • Name
    enable_original_uv
    Type
    boolean
    デフォルト false
    Description

    モデルの既存のUVレイアウトを保持し、新しいものを生成しない。

    • Meshyが生成したモデル(input_task_id経由、またはMeshyの出力を指すmodel_url)をリテクスチャする場合は、最適化されたUVレイアウトを再利用するためにtrueに設定します。
    • あなたがアップロードしたサードパーティのモデルをリテクスチャする場合は、すでに良好なUVを持っているときにはtrueを設定し、適切なUVマッピングが欠けたモデルにはMeshyが新しいUVを展開するようにfalseのままにします(最適です)。
  • Name
    enable_pbr
    Type
    boolean
    デフォルト false
    Description

    ベースカラーに加えて、メタリック、ラフネス、ノーマルのPBRマップを生成します。ai_modelmeshy-6のときのみ8k以外でエミッションマップも含まれます。meshy-7latestはエミッションマップを生成しません。

  • Name
    texture_resolution
    Type
    string
    デフォルト 2k
    Description

    ベースカラーテクスチャの解像度。2k (2048×2048)、4k (4096×4096)、または 8k (8192×8192)のいずれか 。高解像度はより多くの表面の詳細をキャプチャします。

  • Name
    hd_texture
    Type
    boolean
    非推奨
    デフォルト false
    Description

    代わりにtexture_resolutionを使用します — texture_resolution: "4k"と等価です。両方が設定されている場合は、texture_resolutionが優先されます。

  • Name
    remove_lighting
    Type
    boolean
    デフォルト true
    Description

    ベースカラーテクスチャからハイライトとシャドウを除去し、カスタムライティング設定の下でより良い動作をするクリーンな結果を生成します。

  • Name
    target_formats
    Type
    string[]
    Description

    出力に含める3Dファイル形式を指定します。要求された形式のみが生成されて返されるため、タスク完了時間を短縮することができます。省略された場合は、すべてのサポートされている形式が含まれます。

    利用可能な値:glb, obj, fbx, stl, usdz, 3mf

  • Name
    alpha_thumbnail
    Type
    boolean
    デフォルト false
    Description

    trueに設定すると、タスクは透明背景(RGBA)のプレビューを追加でレンダリングし、GETレスポンスでalpha_thumbnail_urlとして返します。既存のthumbnail_urlフィールドは変更されません。

戻り値

レスポンスのresultプロパティには、新しく作成されたリテクスチャタスクのidが含まれます。

エラーモード

  • Name
    400 - Bad Request
    Description

    リクエストは不受理でした。よくある原因:

    • 必須パラメータが欠如: model_urlinput_task_idのどちらかを提供する必要があります。
    • スタイルが欠落: text_style_promptimage_style_urlまたはmultiview_image_urlsのどれかの提供が必要です。
    • スタイル入力の競合: multiview_image_urlstext_style_promptimage_style_urlと組み合わせてはなりません。
    • 非対応モデル形式: model_urlは非サポート形式のファイルを指しています。
    • URLへのアクセス不可: model_url, image_style_urlまたはmultiview_image_urlsの要素はダウンロードできませんでした。
  • Name
    401 - Unauthorized
    Description

    認証に失敗しました。APIキーを確認してください。

  • Name
    402 - Payment Required
    Description

    このタスクを実行するのに十分なクレジットがありません。

  • Name
    429 - TooMany Requests
    Description

    レート制限を超えました。

Request

POST
/openapi/v1/retexture
# テキストプロンプトでリテクスチャ
curl https://api.meshy.ai/openapi/v1/retexture \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "model_url": "https://cdn.meshy.ai/model/example_model_2.glb",
    "text_style_prompt": "red fangs, Samurai outfit that fused with japanese batik style",
    "enable_original_uv": true,
    "enable_pbr": true
  }'

# 画像スタイルとPBRでリテクスチャ
curl https://api.meshy.ai/openapi/v1/retexture \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "model_url": "https://cdn.meshy.ai/model/example_model_2.glb",
    "image_style_url": "https://cdn.meshy.ai/image/example_image.jpg",
    "ai_model": "latest",
    "enable_pbr": true,
    "enable_original_uv": true
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

GET/openapi/v1/retexture/:id

リテクスチャタスクを取得する

このエンドポイントでは、有効なタスクidを与えることでリテクスチャタスクを取得できます。タスクオブジェクトを参照して、リテクスチャタスクオブジェクトに含まれるプロパティを確認してください。

パラメータ

  • Name
    id
    Type
    path
    Description

    取得するリテクスチャタスクの一意の識別子。

戻り値

レスポンスはリテクスチャタスクオブジェクトを含みます。詳細はタスクオブジェクトセクションを確認してください。

Request

GET
/openapi/v1/retexture/018a210d-8ba4-705c-b111-1f1776f7f578
curl https://api.meshy.ai/openapi/v1/retexture/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "retexture",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "text_style_prompt": "red fangs, Samurai outfit that fused with japanese batik style",
  "texture_image_url": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "task_error": {

    "message": ""

  },

  "consumed_credits": 10
}

DELETE/openapi/v1/retexture/:id

リテクスチャタスクを削除する

このエンドポイントは、関連するすべてのモデルとデータを含めてリテクスチャタスクを永久に削除します。 この操作は元に戻せません。

パスパラメータ

  • Name
    id
    Type
    path
    Description

    削除するリテクスチャタスクのID。

戻り値

成功時は200 OKを返します。

Request

DELETE
/openapi/v1/retexture/a43b5c6d-7e8f-901a-234b-567c890d1e2f
curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/retexture/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// 成功時は200 Okを返します。

GET/openapi/v1/retexture

リテクスチャタスクを一覧表示する

このエンドポイントにより、リテクスチャタスクの一覧を取得できます。

パラメータ

  • Name
    page_num
    Type
    integer
    デフォルト 1
    Description

    ページネーションのためのページ番号。

  • Name
    page_size
    Type
    integer
    デフォルト 10
    Description

    ページサイズ制限。最大許容は50アイテムです。

  • Name
    sort_by
    Type
    string
    Description

    ソートするフィールド。

    利用可能な値:

    • +created_at: 作成時間において昇順でソート。
    • -created_at: 作成時間において降順でソート。

戻り値

ページネートされたタスクオブジェクトのリストを返します。

Request

GET
/openapi/v1/retexture
curl https://api.meshy.ai/openapi/v1/retexture?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "retexture",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "text_style_prompt": "red fangs, Samurai outfit that fused with japanese batik style",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "expires_at": 1692771679037,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
        "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
        "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
        "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
        "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {

      "message": ""

    },

    "consumed_credits": 10
  }
]

GET/openapi/v1/retexture/:id/stream

リテクスチャタスクをストリームする

このエンドポイントはサーバー送信イベント(SSE)を使用してリテクスチャタスクのリアルタイムアップデートをストリームします。

パラメータ

  • Name
    id
    Type
    path
    Description

    ストリームするリテクスチャタスクの一意な識別子。

戻り値

サーバー送信イベントとしてのタスクオブジェクトのストリームを返します。

PENDINGまたはIN_PROGRESSタスクの場合、レスポンスストリームには必要なprogressstatusフィールドのみが含まれます。

Request

GET
/openapi/v1/retexture/018a210d-8ba4-705c-b111-1f1776f7f578/stream
curl -N https://api.meshy.ai/openapi/v1/retexture/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// エラーイベントの例
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// メッセージイベントの例はタスク進行を示します。
// `PENDING`または`IN_PROGRESS`タスクの場合、レスポンスストリームにはすべてのフィールドが含まれません。
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 50,
  "status": "IN_PROGRESS"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "retexture",
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1692771650657,
  "started_at": 1692771667037,
  "finished_at": 1692771669037,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  },
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 10
}

リテクスチャタスクオブジェクト

リテクスチャタスクオブジェクトは、Meshyがテキストもしくは画像入力から3Dテクスチャを生成するための作業単位です。モデルは以下のプロパティを持っています:

プロパティ

  • Name
    id
    Type
    string
    Description

    タスクの一意の識別子。タスクIDに対してk-ソート可能なUUIDを使用していますが、そのIDの形式について何らかの仮定をすべきではありません。

  • Name
    type
    Type
    string
    Description

    リテクスチャタスクのタイプ。値はretextureです。

  • Name
    model_urls
    Type
    object
    Description

    Meshyによって生成されたテクスチャ付き3Dモデルファイルのダウンロード可能なURL。

    • Name
      glb
      Type
      string
      Description

      GLBファイルのダウンロード可能なURL。

    • Name
      fbx
      Type
      string
      Description

      FBXファイルのダウンロード可能なURL。

    • Name
      obj
      Type
      string
      Description

      OBJファイルのダウンロード可能なURL。

    • Name
      usdz
      Type
      string
      Description

      USDZファイルのダウンロード可能なURL。

    • Name
      mtl
      Type
      string
      Description

      テクスチャが存在する場合、OBJエクスポートと一緒に返されるMTLファイルのダウンロード可能なURL。

    • Name
      stl
      Type
      string
      Description

      STLファイルのダウンロード可能なURL。

    • Name
      3mf
      Type
      string
      Description

      3MFファイルのダウンロード可能なURL。target_formatsを通じて3mfが要求された場合のみ存在します。

  • Name
    text_style_prompt
    Type
    string
    Description

    テクスチャリングタスクを作成するために使用されたテキストプロンプトです。

  • Name
    image_style_url
    Type
    string
    Description

    テクスチャリングタスクを作成するために使用された画像入力です。

  • Name
    multiview_image_urls
    Type
    string[]
    Description

    テクスチャリングタスクを作成するために使用された複数ビュー参照画像へのダウンロード可能なURL。タスクがmultiview_image_urlsで作成されたときのみ存在します。

  • Name
    thumbnail_url
    Type
    string
    Description

    モデルファイルのサムネイル画像へのダウンロード可能なURL。

  • Name
    alpha_thumbnail_url
    Type
    string
    Description

    thumbnail_urlの透過背景(RGBA)バージョンへのダウンロード可能なURL。タスクがalpha_thumbnail: trueで作成され、透明プレビューが正常にレンダリングされた場合にのみ存在します。それ以外の場合、このフィールドは省略されます。

  • Name
    progress
    Type
    integer
    Description

    タスクの進行状況。タスクがまだ開始されていない場合、このプロパティは0になります。タスクが完了すると、これが100になります。

  • Name
    started_at
    Type
    timestamp
    Description

    タスクが開始された時点のタイムスタンプ(ミリ秒単位)。タスクがまだ開始されていない場合、このプロパティは0になります。

  • Name
    created_at
    Type
    timestamp
    Description

    タスクが作成された時点のタイムスタンプ(ミリ秒単位)。

  • Name
    expires_at
    Type
    timestamp
    Description

    タスク結果が有効期限に達する時点のタイムスタンプ(ミリ秒単位)。

  • Name
    finished_at
    Type
    timestamp
    Description

    タスクが終了した時点のタイムスタンプ(ミリ秒単位)。タスクが終了していない場合、このプロパティは0になります。

  • Name
    status
    Type
    string
    Description

    タスクのステータス。可能な値は PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELEDのいずれかです。

  • Name
    texture_urls
    Type
    array
    Description

    タスクから生成されたテクスチャURLオブジェクトの配列。通常これには一つのテクスチャURLオブジェクトのみが含まれます。各テクスチャURLは次のプロパティを持っています:

    • Name
      base_color
      Type
      string
      Description

      ベースカラーマップ画像へのダウンロード可能なURL。

    • Name
      metallic
      Type
      string
      Description

      メタリックマップ画像へのダウンロード可能なURL。

    • Name
      normal
      Type
      string
      Description

      ノーマルマップ画像へのダウンロード可能なURL。

    • Name
      roughness
      Type
      string
      Description

      ラフネスマップ画像へのダウンロード可能なURL。

    • Name
      emission
      Type
      string
      Description

      エミッションマップ画像へのダウンロード可能なURL。

  • Name
    preceding_tasks
    Type
    integer
    Description

    先行タスクのカウント。

  • Name
    task_error
    Type
    object
    Description

    失敗したタスクのエラ詳細。完全なtask_errorオブジェクトの参照についてはエラーを参照してください。

  • Name
    consumed_credits
    Type
    integer
    Description

    このタスクによって消費されたクレジットの数。タスクのステータスがPENDINGIN_PROGRESS、またはSUCCEEDEDの場合に存在します。 FAILEDタスクの場合には0を返します(失敗した場合にはクレジットは払い戻されます)。

Example Retexture Task Model

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "retexture",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***"
  },
  "text_style_prompt": "red fangs, Samurai outfit that fused with japanese batik style",
  "image_style_url": "https://assets.meshy.ai/***/image/example_image.jpg?Expires=***",
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 10
}