Creative Lab 冷蔵庫マグネット API

冷蔵庫マグネットのコンセプト画像に変換する写真。公開URLまたはData URI（data:image/jpeg;base64,<your base64-encoded image data>）として指定します。

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

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

プロトタイプ画像から背景を削除するかどうか。trueの場合、マグネット全体を保持した透明なRGBA PNGが返されるため、任意の背景に配置できます。ビルドも背景を取り除いた画像から開始されます。Meshyが背景を削除できない場合は、背景付きの画像が返されますが、タスク自体は成功として扱われます。

ビルドのremove_backgroundオプションは独立しています。

リクエストを実行できません。例えば次のような場合です。

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

エラーメッセージには、見つかった問題の内容が記載されます。リクエストを修正してから再送信してください。

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

次のいずれかに該当します。

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

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

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

次のいずれかの上限に達しました。

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

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

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

あなたのFridge Magnetプロトタイプタスクに該当しないIDを指定すると、ウェブアプリで作成したプロトタイプも含めて404が返されます。

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

Meshyが被写体から輪郭をトレースしない場合のマグネットの外形です。remove_backgroundがfalseの場合、または被写体の輪郭が見つからない場合にMeshyはこれを使用します。

利用可能な値：

• circle
• rounded-rect
• hexagon
• shield
• star

マグネットのバウンディング正方形の辺の長さ（ミリメートル単位）で、最大400です。0はデフォルト値を使用します。

ベースから見たレリーフの最大高さ（ミリメートル単位）で、0から20までです。

レリーフをどれだけ下げるか（ミリメートル単位）で、0から20までです。Meshyはこれをレリーフの高さ全体からベースに至るまで差し引きます。

レリーフの背後にある平らなベースプレートの厚さ（ミリメートル単位）で、0から20までです。デフォルトの2mmのベースは、マグネットが冷蔵庫にしっかりとくっつくための十分な本体を与えるため、レリーフが脆弱に感じられなくなります。

マグネットの背面（マグネットを接着する側）を閉じるかどうかです。falseにすると背面が開いたままになり、シェル状になります。

深度マップの値をレリーフの高さにマッピングするカーブです。

利用可能な値：

• linear
• gamma
• s-curve

カーブの強さで、最大10です。gammaとs-curveのカーブで使用され、linearでは無視されます。0はデフォルト値を使用します。

深度マップを反転させ、暗い領域がより高いレリーフになるようにするかどうかです。

Meshyがレリーフを構築する前に深度マップをどの程度平滑化するかで、0から10までです。

輪郭内でレリーフとそのテクスチャを中心を基準にどれだけ拡大するかで、最大10です。1を超える値は被写体を拡大し、1未満の値は縮小します。レリーフの高さは変わりません。0はデフォルト値を使用します。

Meshyが深度をゼロに設定する基準となる深度マップの値で、0から1までです。

被写体からマグネットの輪郭をトレースし、マグネットが被写体の形状に沿うようにするかどうかです。falseにすると、代わりにbadge_shapeの輪郭が使用されます。被写体の輪郭が見つからない場合も、Meshyはbadge_shapeを使用します。

これはプロトタイプのremove_backgroundパラメータとは別物で、そちらはプロトタイプ画像の背景を透明にするかどうかを設定するものです。

エクスポートされるモデルのメッシュ解像度で、64から512までです。Meshyは512ピクセルの深度マップからジオメトリを構築するため、これより細かいメッシュにしても詳細は増えずフェイス数だけが増加します。0はデフォルト値を使用します。

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

利用可能な値：

• glb：1つのmodel.glbファイルで、model_urls.glbに格納されます
• obj：model.obj、model.mtl、texture.pngを含むzipファイルで、model_urls.objに格納されます
• zip：Meshyが生成するすべてのファイルを含むzipファイルで、model_urls.bundle_zipに格納されます

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

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

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

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

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

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

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

input_task_idが、あなたのアカウントがAPIで作成した冷蔵庫マグネットのプロトタイプタスクと一致しません。ウェブアプリで作成したプロトタイプも404を返します。プロトタイプ作成レスポンスのresult IDを送信してください。

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

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

作成レスポンスから取得したタスクIDです。

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

あなたのチームでIP Filteringがオンになっており、Meshyがprototypeタスクの画像を第三者の知的財産として検出しました。buildタスクおよびEnterpriseプランのチームでは、このエラーは発生しません。使用権を持っている画像からprototypeタスクを作成してください。

このIDを持つ冷蔵庫マグネットタスクはあなたのアカウントに属していないか、タスクのステージがパスと一致していません。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-fridge-magnet-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 を返します。その場合は、リクエストを再試行してください。

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

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

タスクタイプ。常に creative-lab-fridge-magnet-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 に対応するエントリが1つあります。タスクが成功するまでは {} です。