Creative Lab Fidget Pixel API

ピクセルアートに変換する写真。公開URLまたはData URI（data:image/jpeg;base64,<your base64-encoded image data>）として指定します。

画像はJPG、JPEG、PNG、またはWebPファイルで、サイズは最大20MBである必要があります。MeshyはURLのファイル拡張子ではなく、画像データから形式を検出します。拡張子のないURLでも動作し、Meshyはリダイレクトをたどります。

写真が何を写しているかを指定し、これによりピクセルアートのスタイルが決まります。2つのスタイルは明確に異なります。これ以外の値を指定すると400が返されます。

利用可能な値：

• person：ポートレートまたは全身写真に写る人物。Meshyはちびキャラ風のピクセルスプライトを描画します。
• other：ペット、物、マスコット、ロゴ、風景など、それ以外の被写体。Meshyはビーズアート風のピクセルアイコンを描画します。

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

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

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

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

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

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

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

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

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

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

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

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

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

あなたのAPI経由のFidget PixelプロトタイプタスクのいずれでもないIDを指定すると、ウェブアプリで作成されたプロトタイプも含めて 404 が返されます。

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

各ピースのフットプリントです。これ以外の値を指定すると 400 が返されます。

指定可能な値:

• square: 正方形グリッド上の正方形ピース
• hex: 六角形グリッド上の六角形ピース。piece_size_mm は 6 または 8 に設定されます

ボードの各辺に沿ったグリッドセルの数で、16 または 32 です。これ以外の値を指定すると 400 が返されます。32 グリッドはより多くのディテールを保持します。16 グリッドは同じサイズのピースの数が少なくなるため、ボードの幅は約半分になります。

各ピースの辺の長さ（ミリメートル）で、6、8、または 10 です。これ以外の値を指定すると 400 が返されます。grid_size と組み合わせて、印刷されるボードのサイズを決定します。例えば、8mmピースの 32 グリッドの場合、一辺は約26.5cmになります。

10 は hex では使用できず 400 が返されます。これは、斜めの六角形の面が、一般的なコンシューマー向けFDMプリンターの多くでオーバーハングになるためです。

ピクセルアートパレットの最大色数で、1 から 8 までです。この範囲外の値を指定すると 400 が返されます。印刷するには、各色用に1つ、グレーの本体用に1つの、合計で color_count 加1個までのフィラメントが必要です。

各ピースの高さ（ミリメートル）で、10 から 80 までです。この範囲外の値を指定すると 400 が返されます。

結果のファイル形式です。これ以外の値を指定すると 400 が返されます。

指定可能な値:

• 3mf: 単一のマルチカラー model.3mf ファイルで、model_urls.3mf に返されます

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

• input_task_id が指定されていない、または有効なタスクIDではない。
• プロトタイプタスクのステータスが SUCCEEDED ではない。まだ実行中の場合は、待ってから再試行してください。失敗またはキャンセルされた場合は、新しいプロトタイプタスクを作成してください。
• プロトタイプタスクは成功したが画像がない。新しいプロトタイプタスクを作成してください。
• options のフィールドが許可された値の範囲外である。例えば grid_size が 16 または 32 以外である場合。
• piece_size_mm が 10 で、shape が hex である。六角形ピースは6mmと8mmのみ対応しています。
• output.format が 3mf ではない。

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

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

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

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

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

あなたのチームでIPフィルタリングが有効になっており、Meshy がプロトタイプタスクの画像を第三者の知的財産としてフラグ付けしました。使用権を持つ画像からプロトタイプタスクを作成してください。

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

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

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

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

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

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

チームで IP Filtering が有効になっており、Meshy が prototype タスクの画像をサードパーティの知的財産であるとフラグ付けしました。build タスクおよび Enterprise プランのチームではこのエラーは発生しません。利用権限のある画像から prototype タスクを作成してください。

このアカウントに該当する ID の Fidget Pixel タスクが存在しないか、タスクのステージがパスと一致していません。ID を確認し、タスクに合わせて /prototype または /build を使用してください。

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

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

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

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

このIDを持つFidget Pixelタスクがあなたのアカウントに属していないか、タスクのステージがパスと一致していません。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-fidget-pixel-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つ含まれ、それまでは空です。

これらのURLは署名付きのため、Authorizationヘッダーなしで取得してください。expires_atまで有効です。それ以前に再度タスクを取得しても、新たに署名されたものではなく同じURLが返されます。期限切れになったURLは更新できないため、その前にファイルをダウンロードして保存してください。

タスクID。形式に依存しないでください。

タスクの種類。常に creative-lab-fidget-pixel-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つあり、タスクが成功するまでは空です。

URLは署名済みのため、Authorization ヘッダーなしで取得してください。これらは expires_at まで有効です。それ以前に同じタスクを再度取得しても、新たに署名されたものではなく同じURLが返されます。失効したURLは更新できないため、それより前にファイルをダウンロードして保存してください。