リメッシュAPI

リメッシュAPIを使用すると、他のMeshy API（画像から3Dやテキストから3Dなど）によって生成された既存の3Dモデルをリメッシュし、さまざまな形式にエクスポートすることができます。このセクションでは、リメッシュAPIの使用方法について詳しく説明します。

POST/openapi/v1/remesh

リメッシュタスクの作成

このエンドポイントは新しいリメッシュタスクを作成します。

フォーマット変換とリサイズには、専用の変換APIとリサイズAPIを使用してください。以下の非推奨パラメータは引き続き動作しますが、新しい統合には新しいエンドポイントを推奨します。

パラメータ

input_task_id または model_url のいずれか一方が必須です。両方が提供された場合、input_task_id が優先されます。

Name
input_task_id
Type
string
必須
Description
リメッシュしたい完了済みの画像から3Dまたはテキストから3DタスクのIDです。このタスクは次のいずれかのタスクである必要があります：テキストから3Dプレビュー、テキストから3Dリファイン、画像から3Dまたはリテクスチャ。また、SUCCEEDEDのステータスである必要があります。

Name
model_url
Type
string
必須
Description
Meshyがリメッシュするための3Dモデルを、公開アクセス可能なURLまたはData URIで提供してください。サポートされているフォーマット：.glb, .gltf, .obj, .fbx, .stl。
Data URIの場合、MIMEタイプを使用してください：application/octet-stream。

Name
target_formats
Type
string[]
デフォルト ["glb"]
Description
リメッシュされたモデルのターゲットフォーマットのリストです。省略された場合、GLBのみが生成されます。
利用可能な値：glb, fbx, obj, usdz, blend, stl, 3mf。
Name
topology
Type
string
デフォルト triangle
Description
生成されるモデルのトポロジーを指定します。
利用可能な値：
- quad: 四角形優勢のメッシュを生成します。
- triangle: デシメーションされた三角形メッシュを生成します。
Name
target_polycount
Type
integer
デフォルト 30,000
Description
生成されるモデルのターゲットポリゴン数を指定します。ジオメトリの複雑さに応じて、実際のポリゴン数はターゲットから逸脱する可能性があります。
有効な値の範囲はユーザー階層によって異なります：
- 100から300,000（含む）
Name
decimation_mode
Type
integer
Description
ポリゴン数レベルを設定することで適応デシメーションを有効にします。設定されると、target_polycountは無視されます。
利用可能な値：
- 1: 適応 — 超高ポリゴン数。
- 2: 適応 — 高ポリゴン数。
- 3: 適応 — 中ポリゴン数。
- 4: 適応 — 低ポリゴン数。
Name
resize_height
Type
number
⚠ 非推奨
デフォルト 0
Description
モデルをメートル単位で特定の高さにリサイズします。専用のリサイズAPIの使用を推奨します。
auto_size、resize_height、および resize_longest_side は相互排他的です。
Name
resize_longest_side
Type
number
⚠ 非推奨
デフォルト 0
Description
モデルをリサイズして、最長のバウンディングボックスの寸法が指定された値（メートル単位）になるようにします。専用のリサイズAPIの使用を推奨します。
auto_size、resize_height、および resize_longest_side は相互排他的です。
Name
auto_size
Type
boolean
⚠ 非推奨
デフォルト false
Description
trueに設定すると、サービスはAIビジョンを使用してオブジェクトの実際の高さを自動的に推定し、それに応じてモデルをリサイズします。専用のリサイズAPIの使用を推奨します。
auto_size、resize_height、および resize_longest_side は相互排他的です。

次の場合のみ適用 auto_size = true

Name
origin_at
Type
string
⚠ 非推奨
デフォルト bottom
Description
原点の位置です。専用のリサイズAPIの使用を推奨します。
利用可能な値：bottom, center。

Name
convert_format_only
Type
boolean
⚠ 非推奨
Description
trueの場合、サービスは入力モデルファイルのフォーマットのみを変更し、topology、resize_height、および target_polycount などの他の入力を無視します。専用の変換APIの使用を推奨します。
convert_format_onlyがtrueに設定されている場合、target_formatsを提供する必要があります。

Name
alpha_thumbnail
Type
boolean
デフォルト false
Description
trueに設定すると、タスクはプレビューの透明背景（RGBA）バージョンを追加でレンダリングし、GETレスポンスでalpha_thumbnail_urlとして返します。既存のthumbnail_urlフィールドは変更されません。

戻り値

レスポンスのresultプロパティには、新しく作成されたリメッシュタスクのidが含まれています。

失敗モード

Name
400 - Bad Request
Description
リクエストは受け入れられませんでした。一般的な原因：
- パラメータの欠如：model_urlまたはinput_task_idのいずれかを提供する必要があります。
- 無効な入力タスク：input_task_idはサポートされているモデルからの成功したタスクを参照する必要があります。
- 無効なモデルフォーマット：model_urlがサポートされていない拡張子のファイルを指しています。
- 到達不能なURL：model_urlをダウンロードできませんでした。
- 無効なトポロジー：topologyパラメータが無効です。
- 相互排他的なパラメータ：auto_sizeとresize_heightの両方を設定することはできません。
Name
401 - Unauthorized
Description
認証に失敗しました。APIキーを確認してください。
Name
402 - Payment Required
Description
このタスクを実行するためのクレジットが不足しています。
Name
429 - Too Many Requests
Description
レート制限を超えました。

リクエスト

POST

/openapi/v1/remesh

# Basic remesh with custom formats and resize
curl https://api.meshy.ai/openapi/v1/remesh \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "target_formats": ["glb", "fbx"],
    "topology": "quad",
    "target_polycount": 50000,
    "resize_height": 1.0,
    "origin_at": "bottom"
  }'

# Quad remesh with auto-size
curl https://api.meshy.ai/openapi/v1/remesh \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "target_formats": ["glb", "fbx"],
    "topology": "quad",
    "target_polycount": 50000,
    "auto_size": true
  }'

レスポンス

{
  "result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}

GET/openapi/v1/remesh/:id

リメッシュタスクを取得する

このエンドポイントは、IDによってリメッシュタスクを取得します。

パラメータ

Name
id
Type
path
Description
取得するリメッシュタスクのID。

戻り値

リメッシュタスクオブジェクト。

リクエスト

GET

/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f

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

レスポンス

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "remesh",
  "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
      "blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
      "stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
},
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
}

DELETE/openapi/v1/remesh/:id

リメッシュタスクを削除する

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

パスパラメータ

Name
id
Type
path
Description
削除するリメッシュタスクのID。

戻り値

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

Request

DELETE

/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f

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

Response

// Returns 200 Ok on success.

GET/openapi/v1/remesh

リメッシュタスクの一覧

このエンドポイントは、リメッシュタスクの一覧を取得することができます。

パラメーター

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: 作成時間で降順にソート。

戻り値

リメッシュタスクオブジェクトのページネーションされたリストを返します。

リクエスト

GET

/openapi/v1/remesh

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

レスポンス

[
  {
    "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
    "type": "remesh",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
      "blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
      "stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
    },
    "progress": 100,
    "status": "SUCCEEDED",
    "created_at": 1699999999000,
    "started_at": 1700000000000,
    "finished_at": 1700000001000,
    "task_error": null
  }
]

GET/openapi/v1/remesh/:id/stream

リメッシュタスクをストリームする

このエンドポイントは、Server-Sent Events (SSE) を使用してリメッシュタスクのリアルタイム更新をストリームします。

パラメータ

Name
id
Type
path
Description
ストリームするリメッシュタスクの一意の識別子。

戻り値

Server-Sent Eventsとしてリメッシュタスクオブジェクトのストリームを返します。

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

Request

GET

/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream

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

Response Stream

// Error event example
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
event: message
data: {
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "remesh",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
    "blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
}

リメッシュタスクオブジェクト

リメッシュタスクオブジェクトは、Meshyが既存の3Dモデルをリメッシュし、さまざまな形式にエクスポートするために使用する作業単位を表します。このオブジェクトには以下のプロパティがあります。

プロパティ

Name
id
Type
string
Description
タスクの一意の識別子です。タスクIDにはkソート可能なUUIDを使用していますが、IDの形式については何も仮定しないでください。
Name
type
Type
string
Description
リメッシュタスクのタイプです。値はremeshです。
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
  blend
  Type
  string
  Description
  Blenderファイルのダウンロード可能なURLです。
- Name
  stl
  Type
  string
  Description
  STLファイルのダウンロード可能なURLです。
- Name
  3mf
  Type
  string
  Description
  3MFファイルのダウンロード可能なURLです。3mfがtarget_formatsを通じて要求された場合にのみ存在します。
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
status
Type
string
Description
タスクのステータスです。可能な値はPENDING、IN_PROGRESS、SUCCEEDED、FAILEDのいずれかです。
Name
preceding_tasks
Type
integer
Description
先行タスクの数です。
このフィールドの値は、タスクのステータスがPENDINGの場合にのみ意味があります。
Name
created_at
Type
timestamp
Description
タスクが作成された時点のタイムスタンプ（ミリ秒単位）です。
Name
started_at
Type
timestamp
Description
タスクが開始された時点のタイムスタンプ（ミリ秒単位）です。タスクがまだ開始されていない場合、このプロパティは0になります。
Name
finished_at
Type
timestamp
Description
タスクが終了した時点のタイムスタンプ（ミリ秒単位）です。タスクがまだ終了していない場合、このプロパティは0になります。
Name
task_error
Type
object
Description
失敗したタスクのエラー詳細です。完全なtask_errorオブジェクトの参照については、エラーを参照してください。
Name
consumed_credits
Type
integer
Description
このタスクによって消費されたクレジットの数です。タスクのステータスがPENDING、IN_PROGRESS、またはSUCCEEDEDの場合に存在します。FAILEDタスクの場合は0を返します（失敗時にはクレジットが返金されます）。

Example Remesh Task Object

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "remesh",
  "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
      "blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
      "stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 5
}