リサイズ API

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


POST/openapi/v1/resize

リサイズタスクの作成

このエンドポイントは新しいリサイズタスクを作成します。

パラメータ

  • Name
    input_task_id
    Type
    string
    必須
    Description

    リサイズしたいMeshyタスクの完了済みIDです。 タスクのステータスは SUCCEEDED である必要があります。 出力形式はGLBになります。

  • Name
    model_url
    Type
    string
    必須
    Description

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

  • 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キーを確認してください。

  • 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

リサイズタスクの取得

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

パラメータ

  • Name
    id
    Type
    path
    Description

    取得するリサイズタスクのID。

戻り値

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

リクエスト

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

レスポンス

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

リサイズタスクの削除

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

パスパラメータ

  • 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

リサイズタスクの一覧

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

パラメータ

  • 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/resize
curl https://api.meshy.ai/openapi/v1/resize?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

レスポンス

[
  {
    "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 のタスクの場合、レスポンスストリームには必要な progressstatus フィールドのみが含まれます。

リクエスト

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

レスポンスストリーム

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

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

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

プロパティ

  • 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クレジット)。FAILED タスクの場合は 0 を返します。