Creative Lab Lamp API

ランプシェードの元になる写真。公開URLまたはData URI（data:image/jpeg;base64,<your base64-encoded image data>）として指定します。

画像はJPG、JPEG、PNG、またはWebPファイルで、最大20 MBである必要があります。

写真に写っている被写体の種類。これによりMeshyがそれをスタイライズする方法が決まります。

利用可能な値：

• character：フィギュア、動物、マスコットなど、単一のキャラクターまたはオブジェクト
• landscape：山、都市の風景、森などの屋外シーンやパノラマ

タスクの名前（最大100文字）。タスクのnameフィールドに返されます。これより長い名前を指定すると400が返されます。

プロトタイプ画像から背景を削除するかどうか。trueにすると透明なRGBA PNGが返されるため、被写体を任意の背景に配置できます。Meshyは背景を除いた画像から3Dモデルも構築します。Meshyが背景を削除できない場合は、背景付きの画像がそのまま使用され、タスクは成功のままとなります。

リクエストを実行できません。例：

• image_urlが指定されていない。
• 画像がJPG、JPEG、PNG、またはWebPファイルではない。
• 画像が小さすぎる、20 MBを超えている、または最大ピクセル数を超えている。
• MeshyがURLから画像をダウンロードできない。たとえばURLが404を返す、またはタイムアウトする場合。
• Data URIが有効なbase64ではない。
• 画像がNSFWとしてフラグされた。
• image_subjectがcharacterまたはlandscapeのいずれでもない。

エラーメッセージにどの問題が検出されたかが示されます。リクエストを修正してから再送信してください。

APIキーが指定されていないか無効です。Authorizationヘッダーを確認してください。

以下のいずれかに該当します：

• アカウントのクレジットが不足している。
• APIキー、ワークスペース、またはメンバーがクレジット上限に達した。
• アカウントが無料プランである。

クレジットとプランを確認してから再試行してください。

チームでIP Filteringが有効になっており、Meshyが画像を第三者の知的財産としてフラグしました。利用権限のある画像を送信してください。

以下のいずれかの上限に達しました：

• レート制限で許可されている数を超えるリクエストを送信した。数秒待ってから再試行してください。レート制限を参照してください。
• キューに入っている、または実行中のタスクが多すぎる。いくつか完了するのを待ってから再試行してください。
• 無制限プランでクレジットが残っていない状態で、クレジットなしで実行できるタスク数に達した。タスクが完了するのを待つか、クレジットを追加してください。

Meshyでサーバーエラーが発生しました。たとえば、画像に対する知的財産チェックを実行できなかった場合などです。Meshyはタスクを作成せず、課金されたクレジットがあれば返金します。リクエストを再試行してください。

ビルド対象のプロトタイプタスクのIDです。これは、あなたのアカウントがPOST /openapi/creative-lab/lamp/v1/prototypeで作成した、ステータスがSUCCEEDEDであるタスクである必要があります。

あなたのLampプロトタイプタスクでないIDをAPI経由で指定すると404が返されます。これにはウェブアプリで作成されたプロトタイプも含まれます。

タスクの名前で、最大100文字です。これはタスクのnameフィールドに返されます。名前が長すぎる場合は400が返されます。

ランプシェードの最大寸法のサイズで、ミリメートル単位で50から400までです。Meshyはモデルを均等にスケーリングして合わせます。0はデフォルト値を使用し、範囲外のその他の値は400を返します。

ランプシェードの肉厚で、ミリメートル単位で最大10までです。0はデフォルト値を使用し、負の値または10を超える値は400を返します。

モデルの高さのうち、底面で平らにカットする割合で、1から100までです。平らな底面により、ランプシェードをプリントベッドに置くことができ、フィクスチャー用のスペースも確保されます。範囲外の値は400を返します。

ライトフィクスチャーのプリセットで、Meshyが底面をどのように作成するかを設定します。

利用可能な値:

• bambu_mh001_60mm: 60mmのフィクスチャー穴があるベースプレート付きの、底面が開いたランプシェードで、両方ともmodel_urls.lamp_stlに含まれ、フィクスチャーマウントはmodel_urls.base_stlに含まれます
• none: model_urls.lamp_stlに単一の密閉されたランプシェードがあり、model_urls.base_stlはありません

ランプシェードの中心からX軸に沿ってフィクスチャー穴を移動する距離で、ミリメートル単位で-80から80までです。light_source_presetがnoneでない場合にのみ適用されます。

ランプシェードの中心からZ軸（奥行き）に沿ってフィクスチャー穴を移動する距離で、ミリメートル単位で-80から80までです。light_source_presetがnoneでない場合にのみ適用されます。

Meshyがモデルを処理する前に適用するX軸周りの回転で、度数単位で-360から360までです。Meshyはこの3つの回転を、モデルの中心を基準としたXYZオイラー角として適用します。

Meshyがモデルを処理する前に適用するY軸周りの回転で、度数単位で-360から360までです。

Meshyがモデルを処理する前に適用するZ軸周りの回転で、度数単位で-360から360までです。

zipバンドルにresult.jsonファイルを追加するかどうかで、実行したパイプラインの名前、警告、ファイルパスが含まれます。output.formatをzipに設定する必要があります。stlでtrueにすると400が返されます。

ビルドが返すファイルです。

利用可能な値:

• stl: model_urls.lamp_stl（フィクスチャープリセットがある場合はベースプレート付きのランプシェード）、およびlight_source_presetがnoneでない場合のmodel_urls.base_stl
• zip: model_urls.bundle_zip内の1つのzipファイルで、lamp.stl、該当する場合はbase.stlとresult.jsonを含みます

リクエストを実行できません。例えば:

• input_task_idが欠落しているか、有効なタスクIDではありません。
• プロトタイプタスクのステータスがSUCCEEDEDではありません。まだ実行中の場合は、しばらく待ってから再試行してください。失敗またはキャンセルされた場合は、新しいプロトタイプタスクを作成してください。
• プロトタイプタスクは成功しましたが、3Dモデルがありません。新しいプロトタイプタスクを作成してください。
• optionsフィールドが範囲外であるか、利用可能な値ではありません。
• output.formatがstlまたはzipではないか、zipなしでinclude_result_jsonがtrueになっています。

エラーメッセージには、検出された問題が示されます。

APIキーが欠落しているか無効です。Authorizationヘッダーを確認してください。

以下のいずれかに該当します:

• アカウントのクレジットが不足しています。
• APIキー、ワークスペース、またはメンバーがクレジット上限に達しました。
• アカウントが無料プランです。

クレジットとプランを確認してから再試行してください。

input_task_idが、あなたのアカウントがAPIで作成したLampプロトタイプタスクのいずれとも一致しません。ウェブアプリで作成されたプロトタイプも404を返します。プロトタイプ作成レスポンスのresultIDを送信してください。

以下のいずれかの制限に達しました:

• レート制限で許可されている数を超えるリクエストを送信しました。数秒待ってから再試行してください。レート制限を参照してください。
• キューに入っている、または実行中のタスクが多すぎます。いくつか完了するのを待ってから再試行してください。
• クレジットが残っていない無制限プランで、クレジットなしで実行できるタスク数に達しました。タスクが完了するのを待つか、クレジットを追加してください。

作成レスポンスからのタスクIDです。

id が有効なタスクIDではありません。作成レスポンスの result IDを送信してください。

あなたのチームでIPフィルタリングが有効になっており、Meshyがプロトタイプタスクの画像を第三者の知的財産としてフラグ付けしました。ビルドタスクおよびEnterpriseプランのチームではこのエラーは発生しません。使用権限のある画像からプロトタイプタスクを作成してください。

このIDを持つLampタスクはあなたのアカウントに属していないか、タスクのステージがパスと一致していません。IDを確認し、タスクに合わせて /prototype または /build を使用してください。

Meshyは知的財産チェックを実行できませんでした。リクエストを再試行してください。

キャンセルするタスクの ID。

以下のいずれかが該当します：

• id が有効なタスク ID ではありません。作成レスポンスの result ID を送信してください。
• タスクはすでに最終ステータス（SUCCEEDED、FAILED、または CANCELED）であるため、キャンセルできません。

この ID のランプタスクがあなたのアカウントに属していないか、タスクのステージがパスと一致していません。ID を確認し、タスクに合わせて /prototype または /build を使用してください。

作成レスポンスから得られるタスクID。

一覧取得するステージ。prototype または build。

返すページ。1 から 255。0 を指定すると最初のページが返されます。0 から 255 の範囲外の値を指定すると 400 が返されます。

1 ページあたりのタスク数。最大 100。101 から 255 の値を指定すると 100 件のタスクが返され、0 を指定するとデフォルト値が使用されます。0 から 255 の範囲外の値を指定すると 400 が返されます。

並び順。

使用可能な値:

• -created_at: 新しい順
• +created_at: 古い順

タスクID。そのフォーマットに依存しないでください。

タスクタイプ。常にcreative-lab-lamp-prototypeです。

タスク作成時に送信したnameです。送信しなかった場合は""になります。

タスクのステータスです。

利用可能な値：

• PENDING：キューで待機中
• IN_PROGRESS：結果を生成中
• SUCCEEDED：完了（結果あり）
• FAILED：完了（理由はtask_errorに記載）
• CANCELED：完了（結果なし）

作業の完了率を0から100で示します。タスクが開始するまでは0で、成功すると100になります。

タスクが作成された時刻（Unixミリ秒）。

ワーカーがタスクを開始した時刻（Unixミリ秒）。それまではnullです。

タスクが最終ステータスに到達した時刻（Unixミリ秒）。それまではnullです。

タスクの結果が期限切れになる時刻（Unixミリ秒）。これはfinished_atの3日後、またはタスクが完了するまではcreated_atの3日後です。APIの結果を無期限に保持するEnterpriseアカウントでは、約100年後になります。アセット保持期間を参照してください。

タスクがPENDINGの間のキュー内での位置です。1は次に開始することを意味します。タスクがキューを離れると0になり、リスト結果では常に0です。

タスクが失敗した理由です。statusがFAILEDでない限りnullです。エラーを参照してください。

返金分を差し引いた後、タスクに対して請求されたクレジット数です。エラーを返すリクエストには課金されません。失敗したタスクはMeshyが返金するため0になります。キャンセルによる返金は、タスクがPENDINGの間にのみ行われます。Meshyが課金情報を読み取れない場合、getまたはstreamのレスポンスではこのフィールドが省略され、listリクエストは500を返します。その場合はリクエストを再試行してください。

コンセプト画像から生成された3DモデルのダウンロードURLです。タスクが成功するまでは{}です。

3Dモデルのプレビュー画像のダウンロードURLです。タスクが成功するまでは""です。

コンセプト画像のダウンロードURLです。タスクが成功すると配列には1つのURLが入り、それまでは空です。

タスクID。フォーマットに依存しないでください。

タスクタイプ。常に creative-lab-lamp-build です。

タスク作成時に送信した name。送信しなかった場合は "" です。

タスクのステータス。

利用可能な値：

• PENDING：キューで待機中
• IN_PROGRESS：結果を生成中
• SUCCEEDED：確定、結果あり
• FAILED：確定、task_error に理由あり
• CANCELED：確定、結果なし

作業完了の割合（0 から 100）。タスクが開始するまでは 0 で、成功すると 100 になります。

タスクが作成された時刻（Unixミリ秒）。

ワーカーがタスクを開始した時刻（Unixミリ秒）。それまでは null です。

タスクが最終ステータスに達した時刻（Unixミリ秒）。それまでは null です。

タスクの結果が期限切れになる時刻（Unixミリ秒）。これは finished_at の3日後、またはタスクが完了するまでは created_at の3日後です。APIの結果を無期限に保持するEnterpriseアカウントの場合は、約100年後になります。アセット保持期間を参照してください。

タスクが PENDING である間のキュー内での位置。1 は次に開始することを意味します。タスクがキューを離れると 0 になり、リスト結果では常に 0 です。

タスクが失敗した理由。status が FAILED でない限り null です。エラーを参照してください。

払い戻し後にタスクに対して請求されたクレジット数。エラーを返すリクエストには課金されません。失敗したタスクはMeshyが払い戻すため 0 になります。キャンセルは、タスクが PENDING である間のみタスクを払い戻します。Meshyが請求を読み取れない場合、getまたはstreamのレスポンスではこのフィールドが省略され、listリクエストは 500 を返します。その場合は、リクエストを再試行してください。

印刷可能なファイルのダウンロードURL。どのキーが表示されるかは output.format と options.light_source_preset によって異なります。