変換API

変換APIを使用すると、既存の3Dモデルを別のファイル形式に変換できます。

POST/openapi/v1/convert

変換タスクの作成

このエンドポイントは、新しい形式変換タスクを作成します。

パラメータ

input_task_id と model_url のどちらか一方のみが必須です。両方が指定された場合は、input_task_id が優先されます。

Name
input_task_id
Type
string
必須
Description
変換したいモデルを持つ、完了済みのMeshyタスクのIDです。タスクのステータスは SUCCEEDED である必要があります。

Name
model_url
Type
string
必須
Description
3Dモデルファイルを指す、公開アクセス可能なURLまたはData URIです。サポートされている形式: .glb、.gltf、.obj、.fbx、.stl。 Data URIの場合は、MIMEタイプ application/octet-stream を使用してください。

Name
target_formats
Type
string[]
必須
Description
変換後のモデルの出力形式のリストです。利用可能な値: glb、fbx、obj、usdz、blend、stl、3mf。

戻り値

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

失敗モード

400 - Bad Request

リクエストが受理できませんでした。一般的な原因:

パラメータの欠落: model_url または input_task_id のいずれかを指定する必要があります。
target_formatsの欠落: 少なくとも1つの出力形式を指定する必要があります。
無効な入力タスク: input_task_id は成功したタスクを参照している必要があります。
無効なモデル形式: model_url がサポートされていない拡張子のファイルを指しています。
到達不能なURL: model_url をダウンロードできませんでした。

401 - Unauthorized

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

402 - Payment Required

このタスクを実行するためのクレジットが不足しています。

429 - Too Many Requests

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

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"
}

GET/openapi/v1/convert/:id

変換タスクの取得

このエンドポイントは、IDによって変換タスクを取得します。

パラメーター

Name
id
Type
path
Description
取得する変換タスクのID。

戻り値

変換タスクオブジェクト。

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": {
      "glb": "",
      "fbx": "https://assets.meshy.ai/.../model.fbx?Expires=...",
      "obj": "",
      "usdz": "",
      "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
}

DELETE/openapi/v1/convert/:id

変換タスクの削除

このエンドポイントは、関連するすべてのモデルとデータを含め、変換タスクを完全に削除します。この操作は元に戻せません。

パスパラメータ

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

タスクステータス

まだPENDING状態のタスクは削除され、作成時に消費されたクレジットは返金されます。

すでにIN_PROGRESS状態のタスクは削除できません。リクエストは409 Conflictで拒否され、タスクはそのまま実行され続けます。ワーカーがすでに開始しているタスクのクレジットは返金対象外であるため、実行中に削除すると、クレジットと結果の両方を失うことになります。SUCCEEDED、FAILED、CANCELEDのいずれかの状態になるまで待ってから削除してください。

終了状態（SUCCEEDED、FAILED、CANCELED）にあるタスクは、返金なしで削除されます。

レスポンス

成功時は200 OKを返し、タスクがIN_PROGRESSの場合は409 Conflictを返します。

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 is left 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."
}

GET/openapi/v1/convert

変換タスクの一覧取得

このエンドポイントを使用すると、変換タスクの一覧を取得できます。

パラメータ

Name
page_num
Type
integer
デフォルト 1
Description
ページネーション用のページ番号。

Name
page_size
Type
integer
デフォルト 10
Description
ページサイズの上限。最大は100件です。

Name
sort_by
Type
string
Description
並び替えに使用するフィールド。利用可能な値:
- +created_at: 作成日時の昇順で並び替え。
- -created_at: 作成日時の降順で並び替え。

返り値

The Convert Task Objectsのページネーションされたリストを返します。

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
  }
]

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

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

このエンドポイントは、Server-Sent Events（SSE）を使用して変換タスクのリアルタイム更新をストリーミングします。

パラメータ

Name
id
Type
path
Description
ストリーミング対象となる変換タスクの一意の識別子。

戻り値

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

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

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
}

The Convert Task Object

Convert Taskオブジェクトは、フォーマット変換ジョブを表します。

Properties

id · string

タスクの一意な識別子。

type · string

タスクのタイプ。値はconvertです。

model_urls · object

変換されたモデルファイルのダウンロード可能なURL。target_formatsで指定されたフォーマットのみURLが設定されます。それ以外のフォーマットのプロパティは空文字列になります。

progress · integer

タスクのprogress（0〜100）。

status · string

タスクのステータス。取りうる値：PENDING、IN_PROGRESS、SUCCEEDED、FAILED、CANCELED。

preceding_tasks · integer

先行するタスクの数。ステータスがPENDINGの場合にのみ意味を持ちます。

created_at · timestamp

タスクが作成された時刻のタイムスタンプ（ミリ秒単位）。

started_at · timestamp

タスクが開始された時刻のタイムスタンプ（ミリ秒単位）。開始されていない場合は0。

finished_at · timestamp

タスクが終了した時刻のタイムスタンプ（ミリ秒単位）。終了していない場合は0。

task_error · object

タスクが失敗した場合のエラーオブジェクト。詳細はErrorsを参照してください。

consumed_credits · integer

このタスクで消費されたクレジット数（変換タスク1件につき1クレジット）。FAILEDタスクの場合は0を返します。