I-transform ang isang pinagmulang larawan sa isang brick-style collectible 3D minifigure sa dalawang yugto:
prototype ay bumubuo ng isang estilong konsepto ng larawan mula sa iyong input na larawan, pagkatapos ay
build ay nagko-convert ng konsepto ng larawan sa isang textured na 3D modelo. Ang dalawang yugto
ay konektado sa pamamagitan ng input_task_id.
POST /openapi/creative-lab/brick-figure/v1/prototype
Bumuo ng isang brick-style na concept na imahe mula sa pinagmulan na litrato. Ang
bumalik na task ID ay siyang ipapasa mo bilang input_task_id sa build
endpoint. Tingnan ang
The Brick Figure Prototype Task Object
para sa hugis ng tugon.
Mga Parameter
Name
image_url
Type
string
Kinakailangan
Description
Pinagmulan na litrato para i-stylize ng Meshy bilang isang brick minifigure. Kasalukuyan naming sinusuportahan ang .jpg, .jpeg, .png, at .webp na mga format.
Mayroong dalawang paraan upang ibigay ang imahe:
Publicly accessible URL: Isang URL na maaring ma-access mula sa pampublikong internet.
Data URI: Isang base64-encoded na data URI ng imahe. Halimbawa ng isang data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
Opsyonal na pangalan ng task para sa layunin ng pagpapakita. Maximum na 100 na mga karakter.
Mga Ibabalik
Ang result na ari-arian ng tugon ay naglalaman ng id ng bagong likha na brick figure prototype task. I-poll ang Get a Task endpoint o mag-subscribe sa stream hanggang sa umabot ang task sa SUCCEEDED, pagkatapos ay ipasa ang ID na iyon sa build endpoint bilang input_task_id.
Mga Pagkabigo
Name
400 - Bad Request
Description
Ang kahilingan ay hindi katanggap-tanggap. Mga karaniwang sanhi:
Missing parameter: Kinakailangan ang image_url.
Invalid image format: Ang ibinigay na image_url ay hindi suportadong format (.jpg, .jpeg, .png, .webp).
Image dimensions out of range: Ang imahe ay masyadong maliit, lumalampas sa maximum na laki ng file, o lumalampas sa maximum na bilang ng pixel.
Unreachable URL: Ang image_url ay hindi ma-download (404 o timeout).
Invalid Data URI: Ang base64 na string ay hindi tama ang format.
Content flagged: Ang ipinapasok na imahe ay na-flag ng NSFW o intellectual property moderation.
Name
401 - Unauthorized
Description
Nabigo ang authentication. Mangyaring suriin ang iyong API key.
Name
402 - Payment Required
Description
Hindi sapat ang mga credits upang isagawa ang task na ito.
Name
403 - Forbidden
Description
Ang input na larawan ay na-flag dahil sa paglabag sa intelektwal na pag-aari.
Name
429 - Too Many Requests
Description
Lumampas ka sa iyong rate limit.
Request
POST
/openapi/creative-lab/brick-figure/v1/prototype
# Stage 1: bumuo ng brick-style na concept na imahecurl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "image_url": "<your publicly accessible image url or base64-encoded data URI>" }'
Lumikha ng panghuling may teksturang 3D brick figure mula sa isang matagumpay na prototype task. Ang proseso ng build ay tumatakbo sa parehong Image to 3D pipeline gaya ng Image to 3D, kaya't ang format ng response object at listahan ng output URLs ay eksaktong tumutugma. Tingnan ang The Brick Figure Build Task Object para sa hugis ng tugon.
Mga Parameter
Name
input_task_id
Type
string
Kinakailangan
Description
Ang task ID ng isang prototype task na nilikha sa pamamagitan ng parehong OpenAPI endpoint na ito. Ang prototype ay dapat na nalikha gamit ang parehong API key, dapat naabot ang SUCCEEDED, at dapat na lumikha ng eksaktong isa lamang na kandidato na imahe.
Ang mga prototype task na nilikha sa pamamagitan ng webapp ay hindi tatanggapin — ang build endpoint ay tumatanggap lamang ng prototype tasks na nilikha ng POST /openapi/creative-lab/brick-figure/v1/prototype at tinatanggihan ang anumang iba pang pinagmulan sa 404.
Name
name
Type
string
Description
Opsyonal na pangalan ng task para sa layuning pagpapakita. Maximum na 100 mga karakter.
Mga Ibinabalik
Ang result na property ng tugon ay naglalaman ng task id ng bagong likhang brick figure build task. Mag-poll ng Get a Task endpoint o mag-subscribe sa stream hanggang maabot ng task ang SUCCEEDED, pagkatapos ay i-download ang may teksturang GLB mula sa model_urls.glb (o ang OBJ + MTL na pares mula sa model_urls.obj at model_urls.mtl kung ang iyong downstream pipeline ay mas gusto ang OBJ).
Mga Pagsablay na Mode
Name
400 - Bad Request
Description
Ang kahilingan ay hindi katanggap-tanggap. Mga karaniwang sanhi:
Kulanging parameter: Ang input_task_id ay kinakailangan.
Di-wastong UUID: Ang input_task_id ay hindi wastong UUID.
Hindi nagtagumpay ang Parent: Ang tinukoy na prototype task ay hindi pa naaabot ang SUCCEEDED.
Walang kandidato: Nagtagumpay ang prototype task ngunit walang nalikha na kandidato na imahe.
Name
401 - Unauthorized
Description
Nabigo ang authentication. Paki-suri ang iyong API key.
Name
402 - Payment Required
Description
Kulang ang credits upang maisagawa ang task na ito.
Name
404 - Not Found
Description
Ang tinutukoy na prototype task ay hindi umiiral, pagmamay-ari ng ibang gumagamit, o nilikha sa pamamagitan ng webapp (tanging ang mga API-mode prototype tasks ay maaaring i-chain sa build).
Name
429 - Too Many Requests
Description
Naabot mo na ang iyong rate limit.
Request
POST
/openapi/creative-lab/brick-figure/v1/build
# Yugto 2: chain ang build mula sa isang matagumpay na prototype taskcurl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578" }'
Kunin ang prototype o build task gamit ang wastong task id. Ang URL path
ay dapat na tumutugma sa yugto ng task — ang build task na kinukuha sa
pamamagitan ng /prototype/:id ay magbabalik ng 404, at kabaligtaran.
Kanselahin ang task ng brick figure. Kung ang task ay nasa PENDING pa, ang mga credits
na nagamit sa oras ng paggawa ay maibabalik. Ang mga task na nasa
IN_PROGRESS ay kakanselahin na walang refund (maaari nang gumagamit ng
resources ang manggagawa). Ang mga task na umabot na sa terminal state
(SUCCEEDED, FAILED, CANCELED) ay hindi na maaaring kanselahin.
Ang URL path ay dapat na tumugma sa yugto ng task — DELETE sa
/prototype/:buildId ay magbabalik ng 404.
Mga Parameter ng Daan
Name
id
Type
path
Description
Natatanging pagkakakilanlan para sa brick figure task na kakanselahin.
Ibinabalik
Nagbabalik ng 204 No Content sa tagumpay na may walang laman na katawan.
Mga Paraan ng Pagkabigo
Name
400 - Bad Request
Description
Ang task ay nasa isang terminal state na at hindi maaaring kanselahin.
Name
404 - Not Found
Description
Ang task ay hindi umiiral, kabilang sa ibang user, o ang yugto nito ay hindi tumutugma sa URL path.
I-stream ang real-time na mga update para sa isang brick figure task sa pamamagitan ng Server-Sent Events (SSE).
Dapat magtugma ang URL path sa yugto ng task — ang pagbukas ng stream sa
/prototype/:buildId/stream ay naglalabas ng isang event: error payload na may
status_code: 404 at isinasara ang stream.
Mga Parameter
Name
id
Type
path
Description
Natatanging identifier para sa brick figure task na i-stream.
Mga Resulta
Nagbabalik ng stream ng mga Brick Figure Prototype
o mga Brick Figure Build task objects bilang
Server-Sent Events. Para sa mga PENDING o IN_PROGRESS na mga task, ang response
stream ay maglalaman lamang ng mga kinakailangang progress at status fields.
// Halimbawa ng error event (mali ang yugto o task ay hindi natagpuan)event: errordata: {"status_code": 404,"message": "Task not found"}// Ang mga halimbawang mensahe ng event ay naglalarawan ng progreso ng task.// Para sa mga PENDING o IN_PROGRESS na mga task, hindi isasama sa response stream ang lahat ng fields.event: messagedata: {"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb","progress": 0,"status": "PENDING"}event: messagedata: {"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb","type": "creative-lab-brick-figure-build","status": "SUCCEEDED","progress": 100,"created_at": 1729123500000,"started_at": 1729123510000,"finished_at": 1729123535000,"expires_at": 1729382735000,"task_error": null,"consumed_credits": 30,"prompt": "","negative_prompt": "","texture_prompt": "","texture_image_url": "","model_urls": {"glb":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***","obj":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***","mtl":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***" },"thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***","texture_urls": [ {"base_color":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***" } ]}
Kunin ang isang listahan na may pagination ng iyong mga brick figure na gawain para sa isang yugto lamang. Ang URL na path ay pipiliin ang yugto — /prototype ay magbabalik ng prototype na gawain; /build ay magbabalik ng build na gawain. Ang mga gawain mula sa ibang yugto ay hindi kasama sa alinmang tugon.
Path na Parameter
Name
stage
Type
path
Kinakailangan
Description
Alinman sa prototype o build. Ang koleksyon ay magbabalik lamang ng mga gawain
na ang yugto ay tumutugma sa URL — ang pagkuha sa /prototype ay hindi kailanman magbabalik
ng build na gawain at kabaliktaran.
Query na Parameter
Name
page_num
Type
integer
default 1
Description
Numero ng pahina para sa pagination.
Name
page_size
Type
integer
default 10
Description
Limitasyon ng laki ng pahina. Pinakamataas na pinapayagan ay 100 na item.
Name
sort_by
Type
string
default -created_at
Description
Patlang na pagbabatayan ng pagkakasunud-sunod. Mga available na halaga:
+created_at: Iayos batay sa oras ng paggawa nang pataas ang ayos.
-created_at: Iayos batay sa oras ng paggawa nang pababa ang ayos.
# Listahan ng prototype na mga gawaincurl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype?page_size=10 \ -H "Authorization: Bearer ${YOUR_API_KEY}"# Listahan ng build na mga gawaincurl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build?page_size=10 \ -H "Authorization: Bearer ${YOUR_API_KEY}"
Ang Brick Figure Prototype Task object ay isang yunit ng trabaho na sinusubaybayan ng Meshy upang bumuo ng isang brick-style na concept image mula sa isang source na larawan. Ang output ng yugtong ito ay nakasunod sa yugto ng pagbuo sa pamamagitan ng input_task_id.
Mga Katangian
Name
id
Type
string
Description
Natatanging pagkakakilanlan para sa gawain. Habang gumagamit kami ng k-sortable UUID para sa task ids bilang detalye ng implementasyon, hindi ka dapat gumawa ng anumang mga palagay tungkol sa format ng id.
Name
type
Type
string
Description
Uri ng gawain. Ang halaga ay creative-lab-brick-figure-prototype.
Name
name
Type
string
Description
Ang pangalan ng gawain na ibinigay noong nilikha ang gawain. Walang laman kung walang ibinigay na pangalan.
Name
status
Type
string
Description
Status ng gawain. Ang mga posibleng halaga ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Pag-unlad ng gawain. Kung hindi pa nasisimulan ang gawain, ang katangian na ito ay magiging 0. Kapag ang gawain ay matagumpay, ito ay magiging 100.
Name
created_at
Type
timestamp
Description
Timestamp kung kailan nilikha ang gawain, sa milliseconds.
Ang isang timestamp ay kumakatawan sa bilang ng mga milliseconds na lumipas mula Enero 1, 1970 UTC, kasunod ng
RFC 3339 na pamantayan.
Halimbawa, Biyernes, Setyembre 1, 2023 12:00:00 PM GMT ay kinakatawan bilang 1693569600000. Ito ay naaangkop
sa lahat ng timestamps sa Meshy API.
Name
started_at
Type
timestamp
Description
Timestamp kung kailan sinimulan ang gawain, sa milliseconds. Kung hindi pa nasisimulan ang gawain, ang katangian na ito ay magiging null.
Name
finished_at
Type
timestamp
Description
Timestamp kung kailan natapos ang gawain, sa milliseconds. Kung hindi pa natatapos ang gawain, ang katangian na ito ay magiging null.
Name
expires_at
Type
timestamp
Description
Timestamp kung kailan mag-e-expire ang resulta ng gawain, sa milliseconds.
Name
preceding_tasks
Type
integer
Description
Ang bilang ng mga naunang gawain.
Ang halaga ng patlang na ito ay makabuluhan lamang kung ang status ng gawain ay PENDING.
Name
task_error
Type
object
Description
Mga detalye ng error para sa mga nabigong gawain. Tingnan ang Errors para sa buong task_error object reference.
Name
consumed_credits
Type
integer
Description
Ang bilang ng credits na nagamit ng gawain na ito. Present kapag ang status ng gawain ay PENDING, IN_PROGRESS, o SUCCEEDED. Nagbabalik 0 para sa mga FAILED na gawain (ang credits ay ibinabalik kapag nagkaroon ng pagkabigo).
Name
image_urls
Type
array of strings
Description
Mga downloadable URL para sa mga candidate na imaheng konsepto na nalikha ng prototype na gawain na ito. Kasalukuyan ang API ay palaging nagbabalik ng eksaktong isang kandidato; ang patlang ay isang array kaya ang mga hinaharap na rebisyon ay makakakuha ng higit pang mga kandidato nang hindi nagkakaroon ng pagbabagong magdudulot ng pagkasira.
Ang Brick Figure Build Task object ay isang yunit ng trabaho na tinutunton ng Meshy upang
makabuo ng isang may tekstura na 3D brick figure mula sa isang nagtagumpay na prototype na gawain. Ito
ay nagpapatakbo ng parehong image-to-3D pipeline na ginagamit ng Image to 3D,
kaya't ang mga output fields ay katulad ng sa endpoint's task object.
Properties
Name
id
Type
string
Description
Natatanging pagkakakilanlan para sa gawain.
Name
type
Type
string
Description
Uri ng gawain. Ang halaga ay creative-lab-brick-figure-build.
Name
name
Type
string
Description
Ang pangalan ng gawain na ibinigay noong ginawa ang gawain. Walang laman na string kung walang ibinigay na pangalan.
Name
status
Type
string
Description
Katayuan ng gawain. Ang posibleng mga halaga ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progreso ng gawain. Kung ang gawain ay hindi pa nasisimulan, ang property na ito ay magiging 0. Kapag naging matagumpay na ang gawain, ito ay magiging 100.
Name
created_at
Type
timestamp
Description
Timestamp kung kailan nilikha ang gawain, sa milisegundo.
Name
started_at
Type
timestamp
Description
Timestamp kung kailan sinimulan ang gawain, sa milisegundo.
Name
finished_at
Type
timestamp
Description
Timestamp kung kailan natapos ang gawain, sa milisegundo.
Name
expires_at
Type
timestamp
Description
Timestamp kung kailan magwawakas ang resulta ng gawain, sa milisegundo.
Name
preceding_tasks
Type
integer
Description
Ang bilang ng mga naunang gawain. Makabuluhan lamang kapag ang status ay PENDING.
Name
task_error
Type
object
Description
Mga detalye ng error para sa mga nabigong gawain. Tingnan ang Errors para sa buong task_error na reference ng object.
Name
consumed_credits
Type
integer
Description
Ang bilang ng mga credits na nagamit sa gawain na ito. Nagbabalik ng 0 para sa FAILED na gawain (ang mga credits ay naibabalik sa pagkabigo).
Name
prompt
Type
string
Description
Palaging walang laman para sa brick figure build. Naroroon para sa cross-endpoint na pagkakatugma sa ibinahaging V2ImageTo3DTaskResponse na hugis na ginagamit ng Image to 3D.
Name
negative_prompt
Type
string
Description
Palaging walang laman para sa brick figure build. Naroroon para sa cross-endpoint na pagkakatugma.
Name
texture_prompt
Type
string
Description
Palaging walang laman para sa brick figure build. Naroroon para sa cross-endpoint na pagkakatugma.
Name
texture_image_url
Type
string
Description
Palaging walang laman para sa brick figure build. Naroroon para sa cross-endpoint na pagkakatugma.
Name
model_urls
Type
object
Description
Mga downloadable na URL para sa nabuo na 3D model. Naglalabas ang brick figure build ng isang teksturadong GLB kasama ang OBJ + MTL na pares para sa mga pipeline na mas gusto ang Wavefront OBJ. Ang hugis ng field ay tumutugma sa Image to 3D model_urls na object kaya't ang mga karagdagang format sa hinaharap ay maaaring ilagay nang walang anumang breaking change.
Name
glb
Type
string
Description
Downloadable URL sa teksturadong GLB file.
Name
obj
Type
string
Description
Downloadable URL sa Wavefront OBJ file (heometriya + UV).
Name
mtl
Type
string
Description
Downloadable URL sa OBJ companion MTL material file. Ipares sa obj at ang entry mula sa texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
Downloadable URL sa thumbnail image ng model file.
Name
texture_urls
Type
array
Description
Isang array ng mga texture URL object na nabuo ng gawain na ito. Kasalukuyang naglalaman ng isang object na may base color map.