変換 API

3DモデルをMeshyタスクまたはモデルファイルから他のファイル形式に変換します。

POST/openapi/v1/convert

Convertタスクを作成する

Convertタスクを作成します。タスクはバックグラウンドで実行されます。タスクに通常どれくらいの時間がかかるかについては、処理時間を参照してください。

Request

POST

/openapi/v1/convert

curl https://api.meshy.ai/openapi/v1/convert \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "target_formats": ["fbx", "stl"]
  }'

Response

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

パラメータ

Name
input_task_id
Type
string
必須
Description
model_url を送信しない場合は必須です。変換したいモデルを持つMeshyタスクのIDです。タスクのステータスは SUCCEEDED である必要があります。

Name
model_url
Type
string
必須
Description
input_task_id を送信しない場合は必須です。変換するモデルを、公開URLまたはData URIとして指定します。両方を送信した場合、Meshyは input_task_id を使用します。
モデルは、http または https のURLから取得する場合は最大400MB、Data URIの場合は最大100MBの、GLB、glTF、OBJ、FBX、またはSTLファイルである必要があります。Data URIの場合は、MIMEタイプに application/octet-stream を使用してください。
100MBを超えるファイルは、さらに以下のルールに従う必要があります。
- GLB、glTF、FBX、OBJファイルは、最大10,000,000面まで扱えます。Meshyは面を三角形として数えるため、四角形は2面として、複数回描画されるメッシュはコピーごとに1面としてカウントされます。
- FBXファイルは、バイナリFBX 7.1以降である必要があります。
- GLBまたはglTFファイルは、Draco圧縮を使用してはいけません。

Name
target_formats
Type
string[]
必須
Description
生成するファイル形式です。少なくとも1つ指定してください。指定が欠けている場合や空のリストの場合は 400 が返されます。
利用可能な値：
- glb
- fbx
- obj
- usdz
- blend
- stl
- 3mf

戻り値

レスポンスの result フィールドには、新しく作成されたConvertタスクのIDが格納されます。

失敗モード

Name
400 - Bad Request
Description
リクエストを実行できません。エラーメッセージには、検出された問題が示されます。例：
- パラメータ不足：model_url と input_task_id のどちらも送信されていません。
- target_formats 不足：target_formats が欠けているか、形式が1つもリストされていません。
- 無効な入力タスク：input_task_id が成功したタスクではありません。
- 無効なモデル形式：model_url のファイルがサポートされていない拡張子です。
- URLに到達不可：Meshyが model_url のファイルをダウンロードできません。
- モデルファイルが大きすぎる：model_url のファイルが、http または https のURLからの場合は400MBを超えているか、Data URIの場合は100MBを超えています。
- 面数が多すぎる：model_url のファイルが100MBを超えており、面数が10,000,000を超えています。面数を減らしてから、ファイルを再送信してください。
- ASCII FBXが100MBを超えている：model_url のファイルが100MBを超えるASCII FBXです。バイナリFBXまたはGLBとして送信してください。
- モデルファイルを読み取れない：model_url のファイルが100MBを超えており、Meshyがそのヘッダーを読み取れません。例えば、Draco圧縮されたGLBもしくはglTF、または7.1より古いバイナリFBXである場合です。
- モデルヘッダーが複雑すぎる：model_url のファイルが100MBを超えており、そのヘッダーに確認すべきメッシュ、ノード、またはレコードが多すぎます。ファイル内のオブジェクト数を減らしてから、再度送信してください。
リクエストを修正してから、再度送信してください。エラーを参照してください。
Name
401 - Unauthorized
Description
APIキーが欠けているか無効です。Authorization ヘッダーを確認してください。
Name
402 - Payment Required
Description
例：
- クレジット不足：アカウントにこのタスクを実行するための十分なクレジットがないか、アカウントがクレジット上限に達しています。クレジット残高を確認してから、再試行してください。
- 無料プラン：タスクの作成には有料プランが必要です。サブスクリプション設定でプランをアップグレードしてから、再試行してください。
Name
403 - Forbidden
Description
input_task_id がバスレリーフモデルであり、このエンドポイントでは変換できません。メッセージは This model type does not support this operation です。別のモデルを送信してください。
Name
404 - Not Found
Description
input_task_id がどのタスクとも一致しません。タスクIDを確認してから、リクエストを再送信してください。
Name
429 - Too Many Requests
Description
レート制限を超えました。しばらく待ってから再試行してください。レート制限を参照してください。

GET/openapi/v1/convert/:id

Convert タスクを取得

IDを指定してConvertタスクを返します。

Request

GET

/openapi/v1/convert/:id

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

Response

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "convert",
  "model_urls": {
      "fbx": "https://assets.meshy.ai/.../model.fbx?Expires=...",
      "stl": "https://assets.meshy.ai/.../model.stl?Expires=..."
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
  "consumed_credits": 1
}

パラメータ

Name
id
Type
path
Description
作成レスポンスから取得したタスクIDです。

返り値

Convertタスクオブジェクト。

DELETE/openapi/v1/convert/:id

Convertタスクを削除する

Convertタスクを、そのモデルやデータも含めて完全に削除します。削除を元に戻すことはできません。

Request

DELETE

/openapi/v1/convert/:id

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

Response

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS. The task keeps running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}

パスパラメータ

Name
id
Type
path
Description
削除するタスクのID。

タスクステータス

PENDING のタスクを削除すると、作成時に使用したクレジットが返還されます。

IN_PROGRESS のタスクは削除できません。リクエストは 409 Conflict を返し、タスクはそのまま実行され続けます。Meshyはすでに開始されたタスクについてはクレジットを返還しないため、これを削除するとクレジットと結果の両方を失うことになります。タスクが SUCCEEDED、FAILED、または CANCELED のいずれかになるのを待ってから削除してください。

最終ステータス（SUCCEEDED、FAILED、または CANCELED）のタスクを削除しても、クレジットは返還されません。

戻り値

タスクが削除された場合は 200 OK、タスクが IN_PROGRESS の場合は 409 Conflict が返されます。

GET/openapi/v1/convert

Convertタスクの一覧取得

Convertタスクの一覧を返します。

Request

GET

/openapi/v1/convert

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

Response

[
  {
    "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
    "type": "convert",
    "model_urls": {
      "fbx": "https://assets.meshy.ai/.../model.fbx?Expires=...",
      "stl": "https://assets.meshy.ai/.../model.stl?Expires=..."
    },
    "progress": 100,
    "status": "SUCCEEDED",
    "created_at": 1699999999000,
    "started_at": 1700000000000,
    "finished_at": 1700000001000,
    "task_error": null,
    "consumed_credits": 1
  }
]

パラメータ

Name
page_num
Type
integer
デフォルト 1
Description
返すページ番号。

Name
page_size
Type
integer
デフォルト 10
Description
1ページあたりのタスク数。最大100。

Name
sort_by
Type
string
Description
並び順。
利用可能な値:
- +created_at: 古い順
- -created_at: 新しい順

戻り値

Convertタスクオブジェクトのページネーションされたリスト。

GET/openapi/v1/convert/:id/stream

変換タスクをストリーミングする

変換タスクの更新情報を Server-Sent Events (SSE) としてストリーミングします。

Request

GET

/openapi/v1/convert/:id/stream

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

Response Stream

// Message event examples illustrate task progress.
event: message
data: {
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "progress": 0,
  "status": "PENDING"
}

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

パラメータ

Name
id
Type
path
Description
作成レスポンスで取得したタスク ID。

戻り値

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

各イベントには、Get エンドポイントが返すものと同じ形式で、タスクオブジェクト全体が含まれます。タスクが PENDING または IN_PROGRESS の間は、結果フィールドにはまだ値が入っていません。

Convert タスクオブジェクト

Convert タスクオブジェクトは、3D モデルの1つのフォーマット変換を表します。このオブジェクトには、ステータス、progress、そしてタスクが成功した場合のモデルファイルが保持されます。

プロパティ

Name
id
Type
string
Description
タスク ID です。不透明な文字列として扱い、そのフォーマットに依存しないでください。
Name
type
Type
string
Description
タスクタイプで、常に convert です。
Name
model_urls
Type
object
Description
変換されたモデルのダウンロード URL で、ファイルフォーマットごとに1つずつあります。target_formats に含まれるフォーマットのみ URL が存在します。リクエストしなかったフォーマットには、空文字列ではなくキー自体が存在しません。
Name
progress
Type
integer
Description
タスクがどれだけ完了したかをパーセンテージで示します。タスクが開始するまでは 0 で、成功すると 100 になります。
Name
status
Type
string
Description
タスクのステータスで、PENDING、IN_PROGRESS、SUCCEEDED、FAILED、CANCELED のいずれかです。
Name
preceding_tasks
Type
integer
Description
キュー内でこのタスクより前にあるタスクの数です。この値はタスクが PENDING の間のみ意味を持ちます。
Name
created_at
Type
timestamp
Description
タスクが作成された時刻で、Unix ミリ秒単位です。
Name
started_at
Type
timestamp
Description
タスクが開始した時刻で、Unix ミリ秒単位です。タスクが開始するまでは 0 です。
Name
finished_at
Type
timestamp
Description
タスクが終了した時刻で、Unix ミリ秒単位です。タスクが終了するまでは 0 です。
Name
task_error
Type
object
Description
タスクが失敗した場合のエラー詳細です。エラーを参照してください。
Name
consumed_credits
Type
integer
Description
タスクが使用したクレジットの数で、Convert タスクの場合は 1 です。FAILED のタスクの場合は 0 です。