Gawing chibi-style na collectible 3D figure ang isang orihinal na larawan sa dalawang yugto:
ang prototype ay bumubuo ng styled na concept image mula sa iyong input na larawan, pagkatapos
ay ginagawa ng build ang concept image na iyon na isang textured na 3D model. Ang dalawang yugto
ay konektado sa pamamagitan ng input_task_id.
Bumuo ng iisang chibi-style na larawang konsepto mula sa pinagmulang larawan. Ang ibinalik na task ID ang ipapasa mo bilang input_task_id sa build endpoint. Sumangguni sa
The Figure Prototype Task Object
para sa hugis ng response.
Mga Parameter
Name
image_url
Type
string
Kinakailangan
Description
Pinagmulang larawan na i-stylize ni Meshy bilang chibi figure. Kasalukuyan naming sinusuportahan ang mga format na .jpg, .jpeg, .png, at .webp.
Mayroong dalawang paraan upang magbigay ng larawan:
URL na naa-access ng publiko: Isang URL na naa-access mula sa pampublikong internet.
Data URI: Isang base64-encoded data URI ng larawan. 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 character.
Name
remove_background
Type
boolean
default false
Description
Kapag itinakda sa true, ang prototype na larawan ay ibinabalik bilang transparent na RGBA PNG na tinanggal ang background, upang maaari mong i-composite ang subject sa anumang background.
Mga Ibinabalik
Ang property na result ng response ay naglalaman ng id ng task ng bagong likhang figure prototype task. I-poll ang Get a Task endpoint o mag-subscribe sa stream hanggang maabot ng task ang SUCCEEDED, pagkatapos ay ipasa ang ID na iyon sa build endpoint bilang input_task_id.
Mga Paraan ng Pagkabigo
Name
400 - Bad Request
Description
Hindi katanggap-tanggap ang request. Karaniwang mga dahilan:
Kulang na parameter: kinakailangan ang image_url.
Di-wastong format ng larawan: Ang ibinigay na image_url ay hindi isang suportadong format (.jpg, .jpeg, .png, .webp).
Wala sa saklaw ang mga dimensyon ng larawan: Masyadong maliit ang larawan, lumampas sa maximum na laki ng file, o lumampas sa maximum na bilang ng pixel.
Hindi maabot na URL: Hindi ma-download ang image_url (404 o timeout).
Di-wastong Data URI: Sira ang base64 string.
Nai-flag ang nilalaman: Ang input na larawan ay na-flag ng NSFW o intellectual property moderation.
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
429 - Too Many Requests
Description
Nalampasan mo na ang iyong rate limit.
Request
POST
/openapi/creative-lab/figure/v1/prototype
# Stage 1: generate a chibi-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/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>" }'
Response
{"result":"018a210d-8ba4-705c-b111-1f1776f7f578"}
Halimbawa ng prototype
Magsimula sa isang pinagmulang portrait, pagkatapos ay bumuo ng prototype na larawan na gagamitin ng build stage.
Bumuo ng huling na-texture na 3D figure mula sa isang matagumpay na prototype task.
Ang build ay tumatakbo gamit ang parehong image-to-3D pipeline gaya ng
Image to 3D, kaya ang response object format at ang
listahan ng output URLs ay eksaktong tumutugma. Sumangguni sa
The 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 ginawa sa pamamagitan ng parehong OpenAPI endpoint na ito. Ang prototype ay dapat ginawa gamit ang parehong API key, dapat naabot ang SUCCEEDED, at dapat nakabuo ng eksaktong isang candidate image.
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/figure/v1/prototype at tinatanggihan ang anumang ibang pinagmulan gamit ang 404.
Name
name
Type
string
Description
Opsyonal na pangalan ng task para sa layuning pagpapakita. Maximum na 100 characters.
Mga Ibinabalik
Ang result property ng response ay naglalaman ng id ng task ng bagong ginawang figure build task. I-poll ang Get a Task endpoint o mag-subscribe sa stream hanggang maabot ng task ang SUCCEEDED, pagkatapos ay i-download ang na-texture na GLB mula sa model_urls.glb (o ang OBJ + MTL pair mula sa model_urls.obj at model_urls.mtl kung mas gusto ng downstream pipeline mo ang OBJ).
Mga Mode ng Kabiguan
Name
400 - Bad Request
Description
Hindi katanggap-tanggap ang request. Karaniwang dahilan:
Kulang na parameter: Kinakailangan ang input_task_id.
Di-wastong UUID: Ang input_task_id ay hindi isang wastong UUID.
Hindi matagumpay ang parent: Ang tinutukoy na prototype task ay hindi pa umaabot sa SUCCEEDED.
Walang candidate: Matagumpay ang prototype task ngunit walang nabuong candidate image.
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
404 - Not Found
Description
Ang tinutukoy na prototype task ay hindi umiiral, pag-aari ng ibang user, o ginawa sa pamamagitan ng webapp (tanging mga prototype task sa API mode lamang ang maaaring i-chain patungo sa build).
Name
429 - Too Many Requests
Description
Lumampas ka sa iyong rate limit.
Request
POST
/openapi/creative-lab/figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578" }'
Response
{"result":"019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"}
Halimbawa ng build
Ginagawa ng build task ang napiling prototype image na isang downloadable na na-texture na 3D model.
Kunin ang isang prototype o build task gamit ang isang valid na 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 figure task. Kung ang task ay PENDING pa rin, ire-refund
ang mga credits na nagamit noong oras ng paggawa. Ang mga task na IN_PROGRESS
na ay kinakansela nang walang refund (maaaring gumagamit na ng resources
ang worker). Ang mga task na nakarating na sa isang huling estado
(SUCCEEDED, FAILED, CANCELED) ay hindi na maaaring kanselahin.
Dapat tumugma ang URL path sa stage ng task — ang DELETE sa
/prototype/:buildId ay nagbabalik ng 404.
Path Parameters
Name
id
Type
path
Description
Natatanging identifier para sa figure task na kakanselahin.
Ibinabalik
Nagbabalik ng 204 No Content kapag matagumpay, na may walang laman na body.
Mga Mode ng Kabiguan
Name
400 - Bad Request
Description
Nasa huling estado na ang task at hindi na ito maaaring kanselahin.
Name
404 - Not Found
Description
Hindi umiiral ang task, pag-aari ito ng ibang user, o hindi tumutugma ang stage nito sa URL path.
Nag-stream ng real-time na mga update para sa isang 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 figure task na i-stream.
Mga Ibinabalik
Nagbabalik ng stream ng Figure Prototype
o Figure Build na mga task object bilang
Server-Sent Events. Bawat frame ay may dalang 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 paginated na listahan ng iyong mga figure task para sa isang yugto (stage). Ang URL
path ang pumipili ng yugto — ang /prototype ay nagbabalik ng mga prototype task; ang /build
ay nagbabalik ng mga build task. Ang mga task mula sa kabilang yugto ay hindi kasama sa alinman
sa dalawang tugon.
Path Parameters
Name
stage
Type
path
Kinakailangan
Description
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
magbabalik ng mga build task at ganoon din sa kabaliktaran.
Query Parameters
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 na item.
Name
sort_by
Type
string
default -created_at
Description
Field na pagbabatayan sa pag-uuri. Mga magagamit na halaga:
+created_at: Umuri ayon sa oras ng paglikha nang pataas.
-created_at: Umuri ayon sa oras ng paglikha nang pababa.
Ang Figure Prototype Task object ay isang work unit na sinusubaybayan ng Meshy upang bumuo ng chibi-style na concept image mula sa isang source photo. Ang output ng stage na ito ay naka-chain sa build stage
sa pamamagitan ng input_task_id.
Mga Property
Name
id
Type
string
Description
Natatanging identifier para sa task. Bagama't gumagamit kami ng k-sortable UUID para sa mga task id bilang implementation detail, hindi dapat kayo gumawa ng anumang palagay tungkol sa format ng id.
Name
type
Type
string
Description
Uri ng task. Ang value ay creative-lab-figure-prototype.
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 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, sinusunod
ang RFC 3339 standard.
Halimbawa, ang Biyernes, Setyembre 1, 2023 12:00:00 PM GMT ay ipinapakita bilang 1693569600000. Nalalapat ito
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 0.
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 0.
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 nakabinbing task bago ito.
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 buong reference ng task_error object.
Name
consumed_credits
Type
integer
Description
Ang bilang ng credits na nagamit ng task na ito. Naroroon kapag ang status ng task ay PENDING, IN_PROGRESS, o SUCCEEDED. Nagbabalik ng 0 para sa mga FAILED na task (ire-refund ang credits kapag nabigo).
Name
image_urls
Type
array of strings
Description
Mga URL na madodownload para sa mga concept image candidate na nabuo ng prototype task na ito. Sa kasalukuyan, palaging nagbabalik ang API ng eksaktong isang candidate; ang field ay isang array upang ang mga susunod na revision ay makapaglabas ng maraming candidate nang walang breaking change.
Ang Figure Build Task object ay isang yunit ng trabaho na sinusubaybayan ng Meshy upang bumuo ng isang textured na 3D 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 Katangian
Name
id
Type
string
Description
Natatanging identifier para sa task.
Name
type
Type
string
Description
Uri ng task. Ang value ay creative-lab-figure-build.
Name
name
Type
string
Description
Ang pangalan ng task na ibinigay noong nilikha ang task. Walang laman na string kung walang ibinigay na pangalan.
Name
status
Type
string
Description
Status ng task. Ang posibleng mga 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, ito ay magiging 100.
Name
created_at
Type
timestamp
Description
Timestamp kung kailan nilikha ang task, sa milliseconds.
Name
started_at
Type
timestamp
Description
Timestamp kung kailan sinimulan ang task, sa milliseconds.
Name
finished_at
Type
timestamp
Description
Timestamp kung kailan natapos ang task, sa milliseconds.
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 nauunang task. May kabuluhan 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 buong reference ng task_error object.
Name
consumed_credits
Type
integer
Description
Ang bilang ng credits na nagamit ng task na ito. Nagbabalik ng 0 para sa mga FAILED na task (ang credits ay ire-refund kapag nabigo).
Name
prompt
Type
string
Description
Palaging walang laman para sa 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 figure build. Naroroon para sa cross-endpoint compatibility.
Name
texture_prompt
Type
string
Description
Palaging walang laman para sa figure build. Naroroon para sa cross-endpoint compatibility.
Name
texture_image_url
Type
string
Description
Palaging walang laman para sa figure build. Naroroon para sa cross-endpoint compatibility.
Name
model_urls
Type
object
Description
Mga downloadable URL para sa nabuong 3D model. Ang figure build ay naglalabas ng textured GLB kasama ang OBJ + MTL pair para sa mga pipeline na mas gusto ang Wavefront OBJ. Ang hugis ng field ay tumutugma sa Image to 3D model_urls object kaya ang mga karagdagang format sa hinaharap ay madaling maisasama nang walang breaking change.
Name
glb
Type
string
Description
Downloadable URL patungo sa textured GLB file.
Name
obj
Type
string
Description
Downloadable URL patungo sa Wavefront OBJ file (heometriya + UV).
Name
mtl
Type
string
Description
Downloadable URL patungo sa kasamang OBJ MTL material file. Ipares sa obj at sa entry mula sa texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
Downloadable URL patungo sa thumbnail image ng model file.
Name
texture_urls
Type
array
Description
Isang array ng texture URL object na nabuo ng task na ito. Sa kasalukuyan ay naglalaman ng isang solong object na may base color map.