Skip to main content
meshy/meshy-5 の API リファレンスです。Comfy Router が Meshy から提供しています。

クイックスタート

Comfyワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdknpm install @comfyorg/sdk)を使用しています。cURL のスニペットは同じ呼び出しを raw HTTP 経由で行うものです。 モデル ID: meshy/meshy-5 エンドポイント: POST https://api.comfy.org/v2/models/meshy/meshy-5

スキーマ

入力

preview バリアント

string
実行する Meshy モデル。Comfy Router ルートではパス(/v2/models/meshy/{model})から指定され、省略するか null として送信できます。Router は検証後にパスのモデルをここへ書き込みます。v1 /proxy ルートでは MeshyTextTo3DPreviewRequest を参照してください。これはこの値を MeshyAiModel に制約します。
string
デフォルト:"\"realistic\""
オブジェクトの希望するアートスタイルを記述します。指定可能な値: realisticsculpture
boolean
デフォルト:"false"
非推奨。代わりに pose_mode を使用してください。モデルを A/T ポーズで生成するかどうか。
string
必須
プレビュータスクを作成する場合は、このフィールドを “preview” に設定してください。指定可能な値: preview
boolean
デフォルト:"false"
true の場合、入力コンテンツは有害な可能性のあるコンテンツについてスクリーニングされます。
string
生成されるモデルのポーズモードを指定します。指定可能な値: a-poset-pose、“
string
必須
3Dモデルがどのようなオブジェクトであるかを記述します。最大600文字。
boolean
デフォルト:"true"
リメッシュフェーズを有効にするかどうかを制御します。false の場合、最高精度の三角メッシュを返します。
string
デフォルト:"\"auto\""
モデル生成中の対称性の挙動を制御します。指定可能な値: offautoon
integer
デフォルト:"30000"
生成されるモデルのポリゴン数の目標値を指定します。有効範囲は 100 から 300,000 です。範囲: 100300000
string
デフォルト:"\"triangle\""
生成されるモデルのトポロジーを指定します。指定可能な値: quadtriangle
boolean
デフォルト:"false"
より精細なサーフェスディテールを備えた高忠実度ジオメトリのための Ultra 生成を有効にします。ai_model が meshy-7 または latest の場合のみサポートされます。

refine バリアント

string
実行する Meshy モデル。Comfy Router ルートではパス(/v2/models/meshy/{model})から指定され、省略するか null として送信できます。Router は検証後にパスのモデルをここへ書き込みます。v1 /proxy ルートでは MeshyTextTo3DRefineRequest を参照してください。これはこの値を MeshyAiModel に制約します。
boolean
デフォルト:"false"
ベースカラーに加えて PBR マップ(metallic、roughness、normal)を生成します。Sculpture スタイルを使用する場合は enable_pbr を false に設定する必要があることに注意してください。
string
必須
リファインタスクを作成する場合は、このフィールドを “refine” に設定してください。指定可能な値: refine
boolean
デフォルト:"false"
true の場合、入力コンテンツは有害な可能性のあるコンテンツについてスクリーニングされます。
string
必須
対応するプレビュータスクの ID。指定したプレビュータスクのステータスが SUCCEEDED である必要があります。
string
テクスチャリング処理をガイドするための 2D 画像を提供します。.jpg、.jpeg、.png 形式、または base64 エンコードされたデータ URI をサポートします。
string
テクスチャリング処理をガイドするための追加のテキストプロンプトを提供します。最大600文字。
string
デフォルト:"\"2k\""
生成されるテクスチャの解像度。2k、4k、8k のいずれかです。4k と 8k には ai_model が meshy-6、meshy-7、または latest であることが必要です。指定可能な値: 2k4k8k
Router が GET /v2/models/meshy/meshy-5/openapi.json で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する際に使用する同一のドキュメントです。

出力

string
プレビュータスクの作成に使用された、変更されていない art_style。
integer
タスクが作成された日時のタイムスタンプ(ミリ秒単位)。形式: int64
integer
タスクが完了した日時のタイムスタンプ(ミリ秒単位)。完了していない場合は 0。形式: int64
string
必須
タスクの一意の識別子。
object
Meshy によって生成されたテクスチャ付き 3Dモデルファイルのダウンロード URL。
string
FBX ファイルのダウンロード URL。
string
GLB ファイルのダウンロード URL。
string
MTL ファイルのダウンロード URL。
string
OBJ ファイルのダウンロード URL。
string
USDZ ファイルのダウンロード URL。
string
後方互換性のために維持されている非推奨のフィールド。
integer
先行するタスクの数。status が PENDING の場合にのみ意味を持ちます。
integer
タスクの進捗。開始されていない場合は 0、成功した場合は 100。範囲: 0 から 100
string
タスクの作成に使用された、変更されていない prompt。
integer
タスクが開始された日時のタイムスタンプ(ミリ秒単位)。開始されていない場合は 0。形式: int64
string
必須
取り得る値: SUCCEEDED
object
タスクが失敗した場合にエラーメッセージを含むエラーオブジェクト。
string
詳細なエラーメッセージ。
string
テクスチャリング処理のガイドに使用されたテクスチャ画像のダウンロード URL。
string
refine ステージ中にテクスチャリング処理をガイドするために提供される追加のテキストプロンプト。
string
後方互換性のために維持されている非推奨のフィールド。
object[]
タスクから生成されるテクスチャ URL オブジェクトの配列。
string
ベースカラーマップ画像のダウンロード URL。
string
メタリックマップ画像のダウンロード URL。
string
ノーマルマップ画像のダウンロード URL。
string
ラフネスマップ画像のダウンロード URL。
string
モデルファイルのサムネイル画像のダウンロード URL。
string
Text to 3D タスクの種類。取り得る値: text-to-3d-previewtext-to-3d-refine
string
プレビュービデオのダウンロード URL を返す非推奨のフィールド。

入力

出力

出荷前の確認

SDK は Idempotency-Key を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。 リクエストが失敗すると、Router は理由を示す X-Comfy-Error-Type レスポンスヘッダーを送信します。422 は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味します。生成されたアセットは 結果 URL の有効期限 があるため、早めにダウンロードしてください。

ヘッダー

認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。

Router API の利用

モデルの検出、バリデーションエラー、リトライ、課金。

制限事項

Router が現在対応していないことと、代替手段。