Creative Lab — Fidget Pixel API

Pinagmulang larawan na i-pixelize ni Meshy. Kasalukuyan naming sinusuportahan ang mga format na .jpg, .jpeg, .png, at .webp.

Ang format ay natutukoy sa pamamagitan ng pag-decode sa data ng imahe, hindi mula sa file extension ng URL — isang URL na walang extension, o isa na nagre-redirect, ay gagana hangga't ang mga byte ay nade-decode sa isang suportadong format. Sinusunod ang mga HTTP redirect.

May dalawang paraan para maibigay ang imahe:

• Publicly accessible URL: Isang URL na maaaring ma-access mula sa pampublikong internet.
• Data URI: Isang base64-encoded na data URI ng imahe. Halimbawa ng data URI: data:image/jpeg;base64,<your base64-encoded image data>.

Kung ano ang ipinapakita ng larawan. Pinipili nito ang istilo ng pixelization, kaya piliin ito nang maingat — ang dalawa ay gumagawa ng kapansin-pansing magkaibang resulta. Mga available na value:

• person — ang subject ay isang tao (portrait o buong katawan). Gumagawa ng chibi-style na pixel sprite ng subject.
• other — anumang iba pa: mga alagang hayop, bagay, mascot, logo, tanawin. Gumagawa ng bead-art style na pixel icon ng subject.

Opsyonal na pangalan ng task para sa layuning ipakita. Maximum na 100 character.

Hindi katanggap-tanggap ang request. Karaniwang sanhi:

• Nawawalang parameter: Kapwa kinakailangan ang image_url at type.
• Di-wastong type: Ang type ay dapat na person o other.
• Di-wastong format ng imahe: Ang ibinigay na image_url ay hindi isang suportadong format (.jpg, .jpeg, .png, .webp).
• Wala sa saklaw ang mga dimensyon ng imahe: Masyadong maliit ang imahe, lumalampas sa maximum na laki ng file, o lumalampas sa maximum na bilang ng pixel.
• Hindi maabot na URL: Hindi ma-download ang image_url (404 o timeout).
• Di-wastong Data URI: Malformed ang base64 string.
• Na-flag na nilalaman: Ang input na imahe ay na-flag ng NSFW moderation.

Nabigo ang authentication. Pakisuri ang iyong API key.

Hindi sapat na credits para gawin ang task na ito, o ang API key ay pag-aari ng isang free-plan account.

Ang input na imahe ay na-flag ng intellectual property moderation (Content flagged for intellectual property violation). Tanging mga Enterprise account na may naka-enable na intellectual property filtering ang naharangan; walang sinisingil.

Nalagpasan mo na ang iyong rate limit.

Hindi makumpleto ang mismong pagsusuri ng intellectual property (Unable to perform intellectual property check, please try again). Ang mga Enterprise account na may naka-enable na intellectual property filtering ay nabibigo nang paksara sa pagsusuring ito; walang sinisingil — subukan muli ang request.

Ang task ID ng isang prototype task na ginawa sa pamamagitan ng parehong OpenAPI endpoint na ito. Dapat na ginawa ang prototype ng parehong Meshy account at dapat na naabot na ang SUCCEEDED.

Ang mga prototype task na ginawa sa pamamagitan ng webapp ay hindi tinatanggap — ang build endpoint ay tumatanggap lamang ng mga prototype task na nabuo ng POST /openapi/creative-lab/fidget-pixel/v1/prototype at tumatanggi sa anumang ibang pinagmulan na may 404.

Opsyonal na pangalan ng task para sa layuning pagpapakita. Maximum na 100 na character.

Footprint ng bawat piraso. Mga magagamit na value:

• square (default) — mga parisukat na piraso sa isang parisukat na grid.
• hex — mga hexagonal na piraso sa isang hexagonal na grid. Available lamang ang mga hex na piraso sa 6 at 8 mm.

Bilang ng mga piraso sa bawat gilid ng board. Mga magagamit na value: 16 o 32. Ang 32 na grid ay nagpapanatili ng mas maraming detalye; ang 16 na grid ay nangangahulugan ng mas kaunti, mas malalaking piraso para sa parehong subject.

Haba ng gilid ng bawat piraso, sa millimeters. Mga magagamit na value: 6, 8, o 10. Kasama ng grid_size, tinatakda nito ang naka-print na laki ng board — halimbawa 32 × 8 mm ≈ 26 cm bawat gilid. Hindi available ang 10 para sa shape: "hex" (ang pahilis na hex face ay may overhang sa karamihan ng consumer FDM printer).

Maximum na bilang ng mga kulay sa palette na kino-quantize ang larawan. Saklaw: [1, 8]. Ang bawat kulay ay nagiging isang filament sa iyong slicer.

Taas ng bawat piraso, sa millimeters. Saklaw: [10, 80].

Artifact na ibinabalik ng build. Mga magagamit na value:

• 3mf (default) — nagbabalik ng isang solong model.3mf sa ilalim ng model_urls.3mf, na may isang object bawat piraso at ang kulay ng piraso na naka-attach sa bawat object.

Hindi katanggap-tanggap ang request. Karaniwang mga dahilan:

• Kulang na parameter: Kailangan ang input_task_id.
• Hindi wastong UUID: Ang input_task_id ay hindi wastong UUID.
• Hindi pa matagumpay ang parent: Ang tinutukoy na prototype task ay hindi pa umaabot sa SUCCEEDED.
• Walang kandidato: Matagumpay ang prototype task ngunit hindi nakabuo ng pixel-art na larawan; gumawa ng bagong prototype.
• Options wala sa saklaw: Isa sa mga field ng options ay wala sa pinapayagang set o saklaw nito — halimbawa options.grid_size must be 16 or 32, o options.piece_size_mm=10 is not supported for shape=hex; hex pieces are available in 6 and 8 mm.
• Hindi suportadong format: Dapat na 3mf ang output.format.

Nabigo ang authentication. Pakisuri ang iyong API key.

Hindi sapat na credits upang isagawa ang task na ito, o ang API key ay kabilang sa isang free-plan account.

Na-flag ng intellectual property moderation ang larawan ng tinutukoy na prototype. Mga Enterprise account lamang na may pinaganang intellectual property filtering ang naba-block; walang sisingilin.

Ang tinutukoy na prototype task ay hindi umiiral, kabilang sa ibang user, o ginawa sa pamamagitan ng webapp (mga prototype task lamang sa API-mode ang maaaring i-chain sa build).

Lumampas ka na sa iyong rate limit.

Hindi maitatag ang intellectual property verdict ng tinutukoy na prototype (Unable to perform intellectual property check, please try again). Ang mga Enterprise account na may pinaganang intellectual property filtering ay nabigo nang naka-close sa pagsusuring ito; walang sisingilin — subukan muli ang request.

Natatanging identifier para sa fidget pixel task na kukunin.

Ang id ay hindi wastong UUID (Invalid ID).

Na-flag ng intellectual property moderation ang larawan ng task. Tanging mga Enterprise account na may pinagana ang intellectual property filtering lamang ang haharangin.

Hindi umiiral ang task, pag-aari ito ng ibang user, o hindi tumutugma ang yugto (stage) nito sa URL path.

Hindi natapos ang pagsusuri ng intellectual property (Unable to perform intellectual property check, please try again); ang mga Enterprise account na may pinagana ang intellectual property filtering ay mabibigo nang sarado (fail closed). Ulitin ang kahilingan.

Natatanging identifier para sa fidget pixel task na kakanselahin.

Hindi katanggap-tanggap ang request. Mga karaniwang dahilan:

• Invalid ID: Ang id ay hindi isang valid na UUID.
• Terminal state: Ang task ay SUCCEEDED, FAILED, o CANCELED na at hindi na maaaring kanselahin.

Hindi umiiral ang task, pag-aari ito ng ibang user, o hindi tumutugma ang stage nito sa URL path.

Natatanging identifier para sa fidget pixel task na i-stream.

Alinman sa prototype o build. Ang koleksyon ay nagbabalik lamang ng mga task na ang yugto ay tumutugma sa URL — ang pagkuha ng /prototype ay hindi kailanman nagbabalik ng mga build task at vice versa.

Numero ng pahina para sa pagination.

Limitasyon sa laki ng pahina. Ang maximum na pinapayagan ay 100 item.

Field na gagamitin sa pag-uuri. Mga available na value:

• +created_at: Ayusin ayon sa oras ng paglikha nang paakyat (ascending).
• -created_at: Ayusin ayon sa oras ng paglikha nang pababa (descending).

Natatanging identifier para sa task. Bagaman gumagamit kami ng k-sortable UUID para sa mga task id bilang detalye ng implementasyon, hindi mo dapat ipagpalagay ang anumang bagay tungkol sa format ng id.

Uri ng task. Ang value ay creative-lab-fidget-pixel-prototype.

Ang pangalan ng task na ibinigay noong nilikha ang task. Empty string kung walang ibinigay na pangalan.

Status ng task. Ang mga posibleng value ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Progress ng task. Kung hindi pa nasisimulan ang task, ang property na ito ay magiging 0. Kapag nagtagumpay na ang task, ito ay magiging 100.

Timestamp ng kung kailan nilikha ang task, sa milliseconds.

Timestamp ng kung kailan sinimulan ang task, sa milliseconds. Kung hindi pa nasisimulan ang task, ang property na ito ay magiging null.

Timestamp ng kung kailan natapos ang task, sa milliseconds. Kung hindi pa natatapos ang task, ang property na ito ay magiging null.

Timestamp ng kung kailan mag-eexpire ang resulta ng task, sa milliseconds — 3 araw pagkatapos matapos ang task. Ang mga Enterprise account ay nagpapanatili ng mga resulta ng API nang walang hanggan (tingnan ang Asset Retention); para sa kanila, ang timestamp na ito ay itinakda nang halos 100 taon ang layo.

Ang bilang ng mga naunang task.

Detalye ng error para sa mga nabigong task. Tingnan ang Errors para sa kumpletong reference ng task_error object.

Ang bilang ng credits na ginamit ng task na ito. Ang isang task na umabot sa SUCCEEDED ay sisingilin ng buong halaga para sa yugto nito. Ang isang task na hindi kailanman nalikha (isang 4xx sa oras ng request, kasama ang pagtanggi ng moderation) ay hindi sisingilin. Ang isang task na umabot sa FAILED ay nagbabalik ng 0 — nire-refund ang singil. Ang pagkansela sa pamamagitan ng DELETE ay nagre-refund lamang habang PENDING pa ang task; ang isang task na IN_PROGRESS na ay mananatiling sisingilin, dahil nagamit na ang trabaho.

Mga URL na maaaring i-download para sa pixel-art image na nilikha ng prototype task na ito. Sa kasalukuyan, palaging nagbabalik ang API ng eksaktong isang imahe; ang field ay isang array upang ang mga susunod na revision ay makapaglabas ng maraming kandidato nang hindi nasisira ang compatibility. Walang laman hanggang umabot ang task sa SUCCEEDED.

Ito ay mga naka-sign na URL: kunin ang mga ito nang walang Authorization header. Mananatili itong valid hanggang expires_at, na 3 araw pagkatapos ng finished_at, at ang pagbabasa muli sa task sa loob ng window na iyon ay magbabalik ng magkaparehong URL sa halip na bago-lang-nai-sign. I-download at i-store ang mga file sa iyong sarili bago mangyari iyon — walang paraan upang i-refresh ang isang expired na link.

Natatanging identifier para sa task.

Uri ng task. Ang value ay creative-lab-fidget-pixel-build.

Ang pangalan ng task na ibinigay noong nilikha ang task. Walang laman na string kung walang ibinigay na pangalan.

Status ng task. Ang mga posibleng value ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Progress ng task. Kung hindi pa nasisimulan ang task, ang property na ito ay magiging 0. Kapag nagtagumpay na ang task, ito ay magiging 100.

Timestamp kung kailan nilikha ang task, sa milliseconds.

Timestamp kung kailan sinimulan ang task, sa milliseconds. null hanggang magsimula ang task.

Timestamp kung kailan natapos ang task, sa milliseconds. null hanggang matapos ang task.

Timestamp kung kailan mag-e-expire ang resulta ng task, sa milliseconds — 3 araw pagkatapos matapos ang task. Ang mga Enterprise account ay nagpapanatili ng mga resulta ng API nang walang hanggan (tingnan ang Asset Retention); para sa kanila, ang timestamp na ito ay naka-set sa mga 100 taon mula ngayon.

Ang bilang ng mga naunang task. May kahulugan lamang kapag ang status ay PENDING.

Mga detalye ng error para sa mga nabigong task. Tingnan ang Errors para sa kumpletong reference ng task_error object.

Ang bilang ng credits na nagamit ng task na ito. Ang task na umabot sa SUCCEEDED ay sisingilin ng buong halaga para sa yugto nito. Ang task na hindi kailanman nalikha (isang 4xx sa oras ng request, kasama na ang pagtanggi ng moderation) ay hindi sinisingil. Ang task na umabot sa FAILED ay nagbabalik ng 0 — ang singil ay ire-refund. Ang pagkansela sa pamamagitan ng DELETE ay nagre-refund lamang habang ang task ay PENDING pa rin; ang task na IN_PROGRESS na ay mananatiling sisingilin, dahil nagamit na ang trabaho.

Mga na-download na URL para sa nagawang artifact, na naka-key ayon sa format. Naglalaman ng eksaktong isang entry — ang format na hiniling sa pamamagitan ng output.format ng build request. Walang laman hanggang umabot ang task sa SUCCEEDED.

Ang mga ito ay signed URL: kunin ang mga ito nang walang Authorization header. Mananatili silang valid hanggang sa expires_at, na 3 araw pagkatapos ng finished_at, at ang muling pagbasa sa task sa loob ng window na iyon ay magbabalik ng eksaktong parehong URL sa halip na isang bagong-signed na URL. I-download at itago ang mga file bago mangyari iyon — walang paraan upang i-refresh ang isang na-expire na link.