リサイズAPI

Resize APIを使用すると、既存の3Dモデルを現実世界の寸法にリサイズできます。正確な高さ、最長辺の制約を指定することも、AIに適切なサイズを自動推定させることもできます。

POST/openapi/v1/resize

リサイズタスクを作成

この endpoint は新しいリサイズタスクを作成します。

パラメータ

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

Name
input_task_id
Type
string
必須
Description
リサイズしたいモデルを含む、完了済みの Meshy タスクの ID。タスクのステータスは SUCCEEDED である必要があります。出力形式は GLB になります。

Name
model_url
Type
string
必須
Description
3D モデルファイルを指す、公開アクセス可能な URL またはデータ URI。対応形式: .glb, .gltf, .obj, .fbx, .stl。データ URI の場合は、MIME タイプ application/octet-stream を使用してください。出力形式は入力モデルの元の形式を保持します。

リサイズモードは resize_height、resize_longest_side、または auto_size のいずれか一つが必須です。これら 3 つのパラメータは相互に排他的です。

Name
resize_height
Type
number
Description
モデルをメートル単位で測定した特定の高さにリサイズします。

Name
resize_longest_side
Type
number
Description
モデルの最長辺がこの値と一致するように、メートル単位でリサイズします。アスペクト比は保持されます。

Name
auto_size
Type
boolean
Description
true に設定すると、サービスは AI ビジョンを使用してオブジェクトの現実世界での高さを自動的に推定し、それに応じてモデルをリサイズします。origin_at が明示的に設定されていない限り、原点はデフォルトで bottom になります。

Name
origin_at
Type
string
デフォルト bottom
Description
リサイズ後の原点の位置。
利用可能な値: bottom, center。

戻り値

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

失敗モード

400 - Bad Request

リクエストは受け入れられませんでした。一般的な原因:

パラメータ不足: model_url または input_task_id のいずれかを指定する必要があります。
リサイズモード不足: resize_height、resize_longest_side、または auto_size の少なくとも一つを指定する必要があります。
相互に排他的なパラメータ: resize_height、resize_longest_side、および auto_size は組み合わせることができません。
無効な入力タスク: input_task_id は成功したタスクを参照している必要があります。
無効なモデル形式: model_url が未対応の拡張子を持つファイルを指しています。
到達不能な URL: model_url をダウンロードできませんでした。

401 - Unauthorized

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

402 - Payment Required

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

429 - Too Many Requests

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

Request

POST

/openapi/v1/resize

# Simple: resize to a specific height
curl https://api.meshy.ai/openapi/v1/resize \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "resize_height": 1.8
  }'

# Advanced: resize longest side with custom origin
curl https://api.meshy.ai/openapi/v1/resize \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "model_url": "https://example.com/model.glb",
    "resize_longest_side": 2.0,
    "origin_at": "center"
  }'

Response

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

GET/openapi/v1/resize/:id

リサイズタスクを取得

この endpoint は、ID によってリサイズタスクを取得します。

パラメータ

Name
id
Type
path
Description
取得するリサイズタスクの ID。

戻り値

Resize Task オブジェクト。

Request

GET

/openapi/v1/resize/:id

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

Response

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

DELETE/openapi/v1/resize/:id

リサイズタスクを削除する

この endpoint は、関連するすべてのモデルとデータを含め、リサイズタスクを完全に削除します。この操作は元に戻せません。

パスパラメータ

Name
id
Type
path
Description
削除するリサイズタスクの ID。

戻り値

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

Request

DELETE

/openapi/v1/resize/:id

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

Response

// Returns 200 Ok on success.

GET/openapi/v1/resize

リサイズタスクの一覧取得

このendpointでは、リサイズタスクの一覧を取得できます。

パラメーター

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/resize

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

Response

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

GET/openapi/v1/resize/:id/stream

リサイズタスクをストリーミングする

このendpointは、Server-Sent Events (SSE) を使用してリサイズタスクのリアルタイム更新をストリーミングします。

パラメータ

Name
id
Type
path
Description
ストリーミングするリサイズタスクの一意の識別子。

戻り値

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

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

Request

GET

/openapi/v1/resize/:id/stream

curl -N https://api.meshy.ai/openapi/v1/resize/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": "resize",
  "model_urls": {
    "glb": "https://assets.meshy.ai/.../model.glb?Expires=..."
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
  "consumed_credits": 1
}

Resize タスクオブジェクト

Resize タスクオブジェクトは、リサイズジョブを表します。

プロパティ

id · string

タスクの一意の識別子。

type · string

タスクの種類。値は resize です。

model_urls · object

リサイズ済みモデルファイルのダウンロード可能なURL。input_task_id を使用する場合、出力は常に GLB です。model_url を使用する場合、出力は元の形式を保持します。

progress · integer

タスクの進行状況（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

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

consumed_credits · integer

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