Resize API

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

POST/openapi/v1/resize

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

このエンドポイントは、関連するすべてのモデルとデータを含め、リサイズタスクを完全に削除します。この操作は取り消せません。

パスパラメータ

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

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

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

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

パラメータ

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 Resize Task Objects のページネーションされた一覧を返します。

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

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

このエンドポイントは、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
}

リサイズタスクオブジェクト

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

Properties

id · string

タスクの一意な識別子。

type · string

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

model_urls · object

リサイズされたモデルファイルのダウンロード可能なURL。input_task_id を使用する場合、出力は常にGLBになります。model_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

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

consumed_credits · integer

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

Resize API

リサイズタスクを作成する

パラメータ

戻り値

失敗モード

Request

Response

リサイズタスクを取得する

パラメーター

戻り値

Request

Response

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

パスパラメータ

タスクステータス

戻り値

Request

Response

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

パラメータ

戻り値

Request

Response

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

パラメータ

戻り値

Request

Response Stream

リサイズタスクオブジェクト

Properties