Gawing isang brick-style na makukulektang 3D minifigure ang isang pinagmulang larawan sa dalawang yugto:
ang prototype ay bumubuo ng isang na-istilong larawan ng konsepto mula sa iyong input na larawan, pagkatapos
ang build ay ginagawa ang larawang iyon ng konsepto tungo sa isang textured na 3D na modelo. Ang dalawang yugto
ay magkakaugnay sa pamamagitan ng input_task_id.
POST /openapi/creative-lab/brick-figure/v1/prototype
Gumawa ng isang brick-style concept image mula sa source photo. Ang
ibinalik na task ID ang ipapasa mo bilang input_task_id sa build
endpoint. Sumangguni sa
The Brick Figure Prototype Task Object
para sa hugis ng response.
Mga Parameter
Name
image_url
Type
string
Kinakailangan
Description
Source photo na gagamitin ni Meshy para i-stylize bilang brick minifigure. Kasalukuyang sinusuportahan namin ang .jpg, .jpeg, .png, at .webp na format.
May dalawang paraan para maibigay ang imahe:
Publicly accessible URL: Isang URL na naa-access mula sa pampublikong internet.
Data URI: Isang base64-encoded data URI ng imahe. Halimbawa ng data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
Opsyonal na pangalan ng task para sa layuning pagpapakita. Maximum na 100 characters.
Name
remove_background
Type
boolean
default false
Description
Kapag naitakda sa true, ang prototype image ay ibinabalik bilang isang transparent RGBA PNG na may tinanggal na background, para maisama mo ang subject sa kahit anong background.
Ibinabalik
Ang result property ng response ay naglalaman ng task id ng bagong ginawang brick figure prototype task. I-poll ang Get a Task endpoint o mag-subscribe sa stream hanggang maabot ng task ang SUCCEEDED, at pagkatapos ipasa ang ID na iyon sa build endpoint bilang input_task_id.
Mga Mode ng Pagkabigo
Name
400 - Bad Request
Description
Ang request ay hindi tinanggap. Karaniwang mga dahilan:
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: Masyadong maliit ang imahe, lumalagpas sa maximum na file size, o lumalagpas sa maximum na pixel count.
Unreachable URL: Hindi ma-download ang image_url (404 o timeout).
Invalid Data URI: Malformed ang base64 string.
Content flagged: Na-flag ang input image ng NSFW moderation.
Name
401 - Unauthorized
Description
Nabigo ang authentication. Pakisuri ang iyong API key.
Name
402 - Payment Required
Description
Hindi sapat na credits para maisagawa ang task na ito.
Name
403 - Forbidden
Description
Na-flag ang input image para sa paglabag sa intellectual property.
Name
429 - Too Many Requests
Description
Nalagpasan mo na ang iyong rate limit.
Request
POST
/openapi/creative-lab/brick-figure/v1/prototype
# Stage 1: generate a brick-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_url": "<your publicly accessible image url or base64-encoded data URI>" }'
Bumuo ng huling na-texture na 3D brick figure mula sa isang matagumpay na (succeeded) prototype task. Ang build ay tumatakbo gamit ang parehong image-to-3D pipeline tulad ng
Image to 3D, kaya ang format ng response object at ang
listahan ng output URLs ay eksaktong tugma. Tingnan ang
The Brick Figure Build Task Object para sa
hugis ng response.
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 nilikha gamit ang parehong API key, dapat nakarating sa SUCCEEDED, at dapat nakabuo nang eksaktong isang candidate image.
Ang mga prototype task na nilikha sa pamamagitan ng webapp ay hindi tinatanggap — ang build endpoint ay tumatanggap lamang ng mga prototype task na nabuo ng POST /openapi/creative-lab/brick-figure/v1/prototype at tinatanggihan ang anumang ibang pinagmulan na may 404.
Name
name
Type
string
Description
Opsyonal na pangalan ng task para sa layuning ipapakita. Pinakamataas na 100 na character.
Mga Ibabalik
Ang result property ng response ay naglalaman ng task id ng bagong nilikhang brick figure build task. I-poll ang Get a Task endpoint o mag-subscribe sa stream hanggang sa maabot ng task ang SUCCEEDED, pagkatapos ay i-download ang na-texture na GLB mula sa model_urls.glb (o ang pares ng OBJ + MTL mula sa model_urls.obj at model_urls.mtl kung mas gusto ng iyong downstream pipeline ang OBJ).
Mga Paraan ng Pagkabigo
Name
400 - Bad Request
Description
Hindi katanggap-tanggap ang request. Karaniwang mga dahilan:
Nawawalang parameter: Kinakailangan ang input_task_id.
Di-wastong UUID: Ang input_task_id ay hindi wastong UUID.
Hindi nagtagumpay ang parent: Ang tinukoy na prototype task ay hindi pa nakarating sa SUCCEEDED.
Walang candidate: Nagtagumpay ang prototype task ngunit hindi nakabuo ng candidate image.
Name
401 - Unauthorized
Description
Nabigo ang authentication. Pakisuri ang iyong API key.
Name
402 - Payment Required
Description
Hindi sapat na credits upang isagawa ang task na ito.
Name
404 - Not Found
Description
Ang tinukoy na prototype task ay hindi umiiral, pag-aari ng ibang user, o nilikha sa pamamagitan ng webapp (ang mga prototype task lamang sa API-mode ang maaaring i-chain sa build).
Name
429 - Too Many Requests
Description
Nalagpasan mo na ang iyong rate limit.
Request
POST
/openapi/creative-lab/brick-figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578" }'
Kunin ang isang prototype o build task gamit ang wastong task id. Ang URL path
ay dapat tumugma sa stage ng task — ang isang build task na kinuha sa pamamagitan ng
/prototype/:id ay magbabalik ng 404, at vice versa.
Kanselahin ang isang brick figure task. Kung ang task ay PENDING pa rin, ang mga
credits na ginastos noong oras ng paggawa ay isasauli. Ang mga task na
IN_PROGRESS na ay kinakansela nang walang refund (posibleng nagsisimula na
ang worker na gumamit ng resources). Ang mga task na naabot na sa isang
terminal state (SUCCEEDED, FAILED, CANCELED) ay hindi na maaaring
kanselahin.
Ang URL path ay dapat tumugma sa stage ng task — ang DELETE sa
/prototype/:buildId ay nagbabalik ng 404.
Path Parameters
Name
id
Type
path
Description
Ang natatanging identifier para sa brick figure task na kakanselahin.
Returns
Nagbabalik ng 204 No Content kapag matagumpay, na may walang laman na body.
Failure Modes
Name
400 - Bad Request
Description
Ang task ay nasa terminal state na at hindi na maaaring kanselahin.
Name
404 - Not Found
Description
Ang task ay hindi umiiral, pag-aari ng ibang user, o ang stage nito ay hindi tumutugma sa URL path.
Mag-stream ng real-time updates para sa isang brick figure task sa pamamagitan ng Server-Sent Events (SSE).
Ang URL path ay dapat tumugma sa yugto (stage) ng task — ang pagbukas ng stream sa
/prototype/:buildId/stream ay maglalabas ng iisang event: error na payload na may
status_code: 404 at isasara ang stream.
Mga Parameter
Name
id
Type
path
Description
Natatanging identifier para sa brick figure task na is-stream.
Ibinabalik
Nagbabalik ng stream ng Brick Figure Prototype
o Brick Figure Build na mga task object bilang
Server-Sent Events. Bawat frame ay nagdadala ng buong task object para sa yugtong iyon — ang parehong
hugis na ibinabalik ng Get endpoint — kaya habang ang task ay PENDING o IN_PROGRESS, ang
mga output field ay hindi pa lamang napopopulate (null, [] o {}) at
ang finished_at ay null.
Kunin ang isang naka-pagination na listahan ng iyong mga brick figure task para sa isang yugto. Ang URL
path ang pumipili ng yugto — ibinabalik ng /prototype ang mga prototype task; ibinabalik naman
ng /build ang mga build task. Hindi kasama sa alinman sa dalawang tugon ang mga task
mula sa kabilang yugto.
Mga Path Parameter
Name
stage
Type
path
Kinakailangan
Description
Alinman sa prototype o build. Ibinabalik ng koleksyon ang mga task lamang
na tumutugma ang yugto sa URL — ang pagkuha sa /prototype ay hindi kailanman nagbabalik ng
mga build task at vice versa.
Mga Query Parameter
Name
page_num
Type
integer
default 1
Description
Numero ng pahina para sa pagination.
Name
page_size
Type
integer
default 10
Description
Limitasyon sa laki ng pahina. Ang pinakamataas na pinapayagan ay 100 item.
Name
sort_by
Type
string
default -created_at
Description
Field na gagamitin sa pag-sort. Mga available na value:
+created_at: Isunod ayon sa oras ng paglikha nang pataas (ascending).
-created_at: Isunod ayon sa oras ng paglikha nang pababa (descending).
Ang Brick Figure Prototype Task object ay isang work unit na sinusubaybayan ng Meshy upang
bumuo ng brick-style na concept image mula sa isang source na larawan. Ang output ng
yugtong ito ay naka-chain sa build stage
sa pamamagitan ng input_task_id.
Mga Properties
Name
id
Type
string
Description
Natatanging identifier para sa task. Bagama't gumagamit kami ng k-sortable UUID para sa mga task id bilang detalye ng implementasyon, hindi ka dapat gumawa ng anumang palagay tungkol sa format ng id.
Name
type
Type
string
Description
Uri ng task. Ang value ay creative-lab-brick-figure-prototype.
Name
name
Type
string
Description
Ang pangalan ng task na ibinigay noong ginawa ang task. Walang laman na string kung walang ibinigay na pangalan.
Name
status
Type
string
Description
Status ng task. Ang mga posibleng value ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Ang 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.
Name
created_at
Type
timestamp
Description
Timestamp kung kailan ginawa ang task, sa milliseconds.
Ang isang timestamp ay kumakatawan sa bilang ng mga millisecond na lumipas mula Enero 1, 1970 UTC, ayon
sa RFC 3339 standard.
Halimbawa, ang Biyernes, Setyembre 1, 2023 12:00:00 PM GMT ay kinakatawan bilang 1693569600000. Ito ay
naaangkop sa lahat ng timestamp sa Meshy API.
Name
started_at
Type
timestamp
Description
Timestamp kung kailan sinimulan ang task, sa milliseconds. Kung hindi pa nasisimulan ang task, ang property na ito ay magiging null.
Name
finished_at
Type
timestamp
Description
Timestamp kung kailan natapos ang task, sa milliseconds. Kung hindi pa natatapos ang task, ang property na ito ay magiging null.
Name
expires_at
Type
timestamp
Description
Timestamp kung kailan mag-e-expire ang resulta ng task, sa milliseconds.
Name
preceding_tasks
Type
integer
Description
Ang bilang ng mga naunang task.
Makabuluhan lamang ang value ng field na ito kung ang status ng task ay PENDING.
Name
task_error
Type
object
Description
Mga detalye ng error para sa mga nabigong task. Tingnan ang Errors para sa kumpletong reference ng task_error object.
Name
consumed_credits
Type
integer
Description
Ang bilang ng mga credits na nagamit ng task na ito. Naririto kapag ang status ng task ay PENDING, IN_PROGRESS, o SUCCEEDED. Nagbabalik ng 0 para sa mga FAILED na task (ang mga credits ay ire-refund kapag nabigo).
Name
image_urls
Type
array of strings
Description
Mga URL na maaaring i-download para sa mga kandidatong concept image na nabuo ng prototype task na ito. Sa kasalukuyan, palaging nagbabalik ang API ng eksaktong isang kandidato; ang field ay isang array upang ang mga susunod na revision ay makapaglahad ng maraming kandidato nang hindi nakakasira sa functionality.
Ang Brick Figure Build Task object ay isang work unit na sinusubaybayan ng Meshy upang mabuo ang isang textured na 3D brick figure mula sa isang matagumpay na prototype task. Ginagamit nito ang parehong image-to-3D pipeline na ginagamit ng Image to 3D,
kaya ang mga output field nito ay sumasalamin sa task object ng endpoint na iyon.
Mga Property
Name
id
Type
string
Description
Natatanging identifier para sa task.
Name
type
Type
string
Description
Uri ng task. Ang value ay creative-lab-brick-figure-build.
Name
name
Type
string
Description
Ang pangalan ng task na ibinigay noong ginawa ang task. Empty string kung walang ibinigay na pangalan.
Name
status
Type
string
Description
Status ng task. Ang mga posibleng value ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress ng task. Kung hindi pa nasisimulan ang task, ang property na ito ay magiging 0. Kapag matagumpay na natapos ang task, magiging 100 ito.
Name
created_at
Type
timestamp
Description
Timestamp ng oras nang ginawa ang task, sa milliseconds.
Name
started_at
Type
timestamp
Description
Timestamp ng oras nang sinimulan ang task, sa milliseconds.
Name
finished_at
Type
timestamp
Description
Timestamp ng oras nang natapos ang task, sa milliseconds.
Name
expires_at
Type
timestamp
Description
Timestamp ng oras kung kailan mag-e-expire ang resulta ng task, sa milliseconds.
Name
preceding_tasks
Type
integer
Description
Ang bilang ng mga nauunang task. May kahulugan lamang kapag ang status ay PENDING.
Name
task_error
Type
object
Description
Mga detalye ng error para sa mga nabigong task. Tingnan ang Errors para sa kumpletong reference ng task_error object.
Name
consumed_credits
Type
integer
Description
Ang bilang ng mga credits na nagamit ng task na ito. Nagbabalik ng 0 para sa mga FAILED na task (ibinabalik ang credits kapag nabigo).
Name
prompt
Type
string
Description
Palaging walang laman para sa brick figure build. Naroroon para sa cross-endpoint compatibility sa shared na V2ImageTo3DTaskResponse shape 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 compatibility.
Name
texture_prompt
Type
string
Description
Palaging walang laman para sa brick figure build. Naroroon para sa cross-endpoint compatibility.
Name
texture_image_url
Type
string
Description
Palaging walang laman para sa brick figure build. Naroroon para sa cross-endpoint compatibility.
Name
model_urls
Type
object
Description
Mga na-download na URL para sa nabuong 3D model. Ang brick figure build ay naglalabas ng textured GLB kasama ang pares ng OBJ + MTL para sa mga pipeline na mas gustong gamitin ang Wavefront OBJ. Ang hugis ng field na ito ay tumutugma sa Image to 3D model_urls object upang ang mga karagdagang format sa hinaharap ay maidagdag nang walang breaking change.
Name
glb
Type
string
Description
Na-download na URL patungo sa textured GLB file.
Name
obj
Type
string
Description
Na-download na URL patungo sa Wavefront OBJ file (heometriya + UV).
Name
mtl
Type
string
Description
Na-download na URL patungo sa OBJ companion MTL material file. Ipares sa obj at sa entry mula sa texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
Na-download na URL patungo sa thumbnail image ng model file.
Name
texture_urls
Type
array
Description
Isang array ng mga texture URL object na nabuo ng task na ito. Sa kasalukuyan, may nag-iisang object na naglalaman ng base color map.
Name
base_color
Type
string
Description
Na-download na URL patungo sa base color map image.