Gawing chibi-style collectible na 3D figure ang isang source photo sa dalawang yugto:
ang prototype ay bumubuo ng naka-style na concept image mula sa iyong input photo, pagkatapos
ginagawang textured na 3D model ng build ang concept image na iyon. Ang dalawang yugto
ay naka-link sa pamamagitan ng input_task_id.
Bumuo ng iisang chibi-style na concept image mula sa source photo. Ang
ibinalik na task ID ang ipapasa mo bilang input_task_id sa build
endpoint. Sumangguni sa
The Figure Prototype Task Object
para sa anyo ng response.
Mga Parameter
Name
image_url
Type
string
Kinakailangan
Description
Source photo para i-stylize ng Meshy bilang chibi figure. Kasalukuyan naming sinusuportahan ang mga format na .jpg, .jpeg, .png, at .webp.
May dalawang paraan para ibigay ang image:
URL na publicly accessible: Isang URL na naa-access mula sa public internet.
Data URI: Isang base64-encoded na Data URI ng image. Halimbawa ng data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
Opsyonal na task name para sa display purposes. Maximum na 100 character.
Mga Ibinabalik
Ang result property ng response ay naglalaman ng task id ng bagong-gawang 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 Failure Mode
Name
400 - Bad Request
Description
Hindi katanggap-tanggap ang request. Mga karaniwang sanhi:
Nawawalang parameter: Kinakailangan ang image_url.
Hindi valid na image format: Ang ibinigay na image_url ay hindi suportadong format (.jpg, .jpeg, .png, .webp).
Lampas sa saklaw ang mga dimension ng image: Masyadong maliit ang image, lumalampas sa maximum na file size, o lumalampas sa maximum na pixel count.
Hindi maabot na URL: Hindi ma-download ang image_url (404 o timeout).
Hindi valid na Data URI: Mali ang pagkakaayos ng base64 string.
Na-flag na content: Na-flag ang input image ng NSFW o intellectual property moderation.
Name
401 - Unauthorized
Description
Nabigo ang authentication. Pakisuri ang iyong API key.
Name
402 - Payment Required
Description
Kulang ang credits para gawin ang task na ito.
Name
429 - Too Many Requests
Description
Lumampas ka na sa iyong rate limit.
Request
POST
/openapi/creative-lab/figure/v1/prototype
# Stage 1: generate a chibi-style concept imagecurl https://api.meshy.ai/openapi/creative-lab/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>" }'
Response
{"result":"018a210d-8ba4-705c-b111-1f1776f7f578"}
Prototype example
Start with a source portrait, then generate the prototype image used by the build stage.
Bumuo ng pinal na may-texture na 3D figure mula sa isang matagumpay na prototype task.
Ang build ay tumatakbo sa parehong image-to-3D pipeline tulad ng
Image to 3D, kaya eksaktong magkapareho ang format ng response object at ang
listahan ng mga output URL. Sumangguni sa
Ang 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. Dapat nagawa ang prototype gamit ang parehong API key, dapat umabot ito sa SUCCEEDED, at dapat nakagawa ito ng eksaktong isang candidate image.
Ang mga prototype task na ginawa sa pamamagitan ng webapp ay hindi tinatanggap — tumatanggap lamang ang build endpoint ng mga prototype task na ginawa ng POST /openapi/creative-lab/figure/v1/prototype at tinatanggihan ang anumang ibang source gamit ang 404.
Name
name
Type
string
Description
Opsyonal na pangalan ng task para sa display. Maximum na 100 character.
Ibinabalik
Ang result property ng response ay naglalaman ng task id ng bagong ginawang figure build task. I-poll ang Get a Task endpoint o mag-subscribe sa stream hanggang umabot ang task sa SUCCEEDED, pagkatapos ay i-download ang may-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 iyong downstream pipeline ang OBJ).
Mga Failure Mode
Name
400 - Bad Request
Description
Hindi katanggap-tanggap ang request. Mga karaniwang sanhi:
Nawawalang parameter: kinakailangan ang input_task_id.
Invalid UUID: Ang input_task_id ay hindi valid na UUID.
Hindi nagtagumpay ang parent: Ang tinukoy na prototype task ay hindi pa umabot sa SUCCEEDED.
Walang candidate: Nagtagumpay ang prototype task ngunit walang nagawang candidate image.
Name
401 - Unauthorized
Description
Nabigo ang authentication. Pakisuri ang iyong API key.
Name
402 - Payment Required
Description
Hindi sapat ang credits upang maisagawa ang task na ito.
Name
404 - Not Found
Description
Ang tinukoy na prototype task ay hindi umiiral, pag-aari ng ibang user, o ginawa sa pamamagitan ng webapp (tanging API-mode prototype tasks lamang ang maaaring i-chain papunta sa build).
Name
429 - Too Many Requests
Description
Lumampas ka na sa iyong rate limit.
Request
POST
/openapi/creative-lab/figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurl https://api.meshy.ai/openapi/creative-lab/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" }'
Response
{"result":"019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"}
Build example
The build task turns the selected prototype image into a downloadable textured 3D model.
Kunin ang isang prototype o build task gamit ang valid na task id. Ang URL path
ay dapat tumugma sa stage ng task — ang build task na kinuha sa pamamagitan ng
/prototype/:id ay nagbabalik ng 404, at kabaliktaran.
I-cancel ang isang figure task. Kung ang task ay PENDING pa rin, ang credits
na nakonsumo sa create-time ay ire-refund. 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 terminal state
(SUCCEEDED, FAILED, CANCELED) ay hindi maaaring i-cancel.
Dapat tumugma ang URL path sa stage ng task — ang DELETE sa
/prototype/:buildId ay nagbabalik ng 404.
Mga Path Parameter
Name
id
Type
path
Description
Natatanging identifier para sa figure task na ika-cancel.
Mga Return
Nagbabalik ng 204 No Content kapag matagumpay na may empty body.
Mga Failure Mode
Name
400 - Bad Request
Description
Ang task ay nasa terminal state na at hindi na maaaring i-cancel.
Name
404 - Not Found
Description
Hindi umiiral ang task, kabilang sa ibang user, o hindi tumutugma ang stage nito sa URL path.
Mag-stream ng mga real-time na update para sa isang figure task sa pamamagitan ng Server-Sent Events (SSE).
Dapat tumugma ang URL path sa yugto ng task — ang pagbubukas 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 figure task na i-stream.
Mga Ibinabalik
Nagbabalik ng stream ng mga task object ng Prototype ng figure
o Build ng figure bilang
Server-Sent Events. Para sa mga task na PENDING o IN_PROGRESS, ang response
stream ay maglalaman lamang ng mga kinakailangang field na progress at status.
Kunin ang naka-pagination na listahan ng iyong mga figure task para sa iisang yugto. Pinipili ng URL
path ang yugto — ang /prototype ay nagbabalik ng mga prototype task; ang /build
ay nagbabalik ng mga build task. Hindi kasama ang mga task mula sa ibang yugto sa alinmang
response.
Mga Path Parameter
Name
stage
Type
path
Kinakailangan
Description
Alinman sa prototype o build. Nagbabalik lamang ang koleksyon ng mga task
na ang yugto ay tumutugma sa URL — ang pagkuha ng /prototype ay hindi kailanman nagbabalik ng
mga build task at gayundin sa kabaligtaran.
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 maximum na pinapayagan ay 50 item.
Name
sort_by
Type
string
default -created_at
Description
Field na pagbabatayan ng pag-sort. Mga available na value:
+created_at: I-sort ayon sa oras ng paggawa sa pataas na pagkakasunod-sunod.
-created_at: I-sort ayon sa oras ng paggawa sa pababang pagkakasunod-sunod.
Ang Figure Prototype Task object ay isang work unit na sinusubaybayan ng Meshy upang
makabuo ng larawan ng konsepto na estilong chibi mula sa pinagmulang larawan. Ang output ng
yugtong ito ay ikinakadena sa yugto ng build
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 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-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, magiging 100 ito.
Name
created_at
Type
timestamp
Description
timestamp kung kailan ginawa ang task, sa milliseconds.
Ang timestamp ay kumakatawan sa bilang ng milliseconds na lumipas mula Enero 1, 1970 UTC, alinsunod sa
pamantayang RFC 3339.
Halimbawa, ang Friday, September 1, 2023 12:00:00 PM GMT ay kinakatawan 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 tapos 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 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 buong task_error object reference.
Name
consumed_credits
Type
integer
Description
Ang bilang ng credits na nakonsumo 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 (ibinabalik ang credits kapag nabigo).
Name
image_urls
Type
array of strings
Description
Mga nada-download na URL para sa mga candidate na concept image na nabuo ng prototype task na ito. Sa kasalukuyan, palaging eksaktong isang candidate ang ibinabalik ng API; array ang field upang sa mga susunod na rebisyon ay maipakita ang maraming candidate nang walang breaking change.
Ang object ng Gawain sa Pagbuo ng figure ay isang work unit na sinusubaybayan ng Meshy upang
makabuo ng may texture na 3D figure mula sa isang matagumpay na prototype task. Ito ay
nagpapatakbo ng parehong image-to-3D pipeline na ginagamit ng Image to 3D,
kaya ang mga output field ay tumutugma sa task object ng endpoint na iyon.
Mga Katangian
Name
id
Type
string
Description
Natatanging identifier para sa gawain.
Name
type
Type
string
Description
Uri ng gawain. Ang value ay creative-lab-figure-build.
Name
name
Type
string
Description
Ang pangalan ng gawain na ibinigay noong ginawa ang gawain. Empty string kung walang ibinigay na pangalan.
Name
status
Type
string
Description
Status ng gawain. Ang mga posibleng value ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress ng gawain. Kung hindi pa nasisimulan ang gawain, ang property na ito ay magiging 0. Kapag nagtagumpay na ang gawain, magiging 100 ito.
Name
created_at
Type
timestamp
Description
Ang timestamp kung kailan ginawa ang gawain, sa milliseconds.
Name
started_at
Type
timestamp
Description
Ang timestamp kung kailan sinimulan ang gawain, sa milliseconds.
Name
finished_at
Type
timestamp
Description
Ang timestamp kung kailan natapos ang gawain, sa milliseconds.
Name
expires_at
Type
timestamp
Description
Ang timestamp kung kailan mag-e-expire ang resulta ng gawain, sa milliseconds.
Name
preceding_tasks
Type
integer
Description
Ang bilang ng mga nauunang gawain. May kahulugan 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 object reference.
Name
consumed_credits
Type
integer
Description
Ang bilang ng credits na nakonsumo ng gawaing ito. Nagbabalik ng 0 para sa mga FAILED na gawain (ibinabalik ang credits kapag nabigo).
Name
prompt
Type
string
Description
Palaging empty 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 empty para sa figure build. Naroroon para sa cross-endpoint compatibility.
Name
texture_prompt
Type
string
Description
Palaging empty para sa figure build. Naroroon para sa cross-endpoint compatibility.
Name
texture_image_url
Type
string
Description
Palaging empty para sa figure build. Naroroon para sa cross-endpoint compatibility.
Name
model_urls
Type
object
Description
Mga mada-download na 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 pinipili ang Wavefront OBJ. Ang field shape ay tumutugma sa Image to 3D model_urls object kaya ang mga pagdaragdag ng format sa hinaharap ay magkakasya nang walang breaking change.
Name
glb
Type
string
Description
Mada-download na URL papunta sa textured GLB file.
Name
obj
Type
string
Description
Mada-download na URL papunta sa Wavefront OBJ file (heometriya + UV).
Name
mtl
Type
string
Description
Mada-download na URL papunta 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
Mada-download na URL papunta sa thumbnail image ng model file.
Name
texture_urls
Type
array
Description
Isang array ng mga texture URL object na nabuo ng gawaing ito. Sa kasalukuyan ay naglalaman ng isang object na may base color map.
Name
base_color
Type
string
Description
Mada-download na URL papunta sa base color map image.