Gawing malaking-ulo na vinyl collectible 3D figure ang isang source photo sa
dalawang yugto: ang prototype ay gumagawa ng styled concept image mula
sa iyong input photo, pagkatapos ang build ay ginagawang textured 3D
model ang concept image na iyon. Ang dalawang yugto ay konektado sa
pamamagitan ng input_task_id.
POST /openapi/creative-lab/vinyl-figure/v1/prototype
Gumawa ng isang vinyl-figure-style na concept image mula sa source
photo. Ang task ID na ibinabalik ang ipapasa mo bilang input_task_id sa build
endpoint. Sumangguni sa
The Vinyl Figure Prototype Task Object
para sa hugis ng response.
Mga Parameter
Name
image_url
Type
string
Kinakailangan
Description
Source photo na gagawin ni Meshy na big-head vinyl figure. Kasalukuyang suportado namin ang mga format na .jpg, .jpeg, .png, at .webp.
May dalawang paraan para maglagay ng imahe:
Publicly accessible URL: Isang URL na maa-access mula sa public 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 tinanggal ang background, para makapag-composite ka ng subject sa kahit anong background.
Mga Ibinabalik
Ang result property ng response ay naglalaman ng task id ng bagong likhang vinyl figure prototype task. I-poll ang Get a Task endpoint o mag-subscribe sa stream hanggang maabot ng task ang SUCCEEDED, pagkatapos ipasa ang ID na iyon sa build endpoint bilang input_task_id.
Mga Mode ng Kabiguan
Name
400 - Bad Request
Description
Hindi tinanggap ang request. Karaniwang mga dahilan:
Nawawalang parameter: Kinakailangan ang image_url.
Di-wastong format ng imahe: Ang binigay na image_url ay hindi suportadong format (.jpg, .jpeg, .png, .webp).
Sukat ng imahe na labas sa saklaw: Masyadong maliit ang imahe, lumampas sa maximum file size, 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: Hindi maayos ang pagkabuo ng base64 string.
Naflag ang nilalaman: Ang input image ay naflag 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 ang credits para maisagawa ang task na ito.
Name
429 - Too Many Requests
Description
Nalampasan mo ang iyong rate limit.
Request
POST
/openapi/creative-lab/vinyl-figure/v1/prototype
# Stage 1: generate a vinyl-figure-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/vinyl-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":"019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de"}
Prototype example
Start with a source photo, then generate the prototype image used by the build stage.
Bumuo ng final textured 3D vinyl 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 eksaktong magkatugma ang format ng response object at ang listahan ng output URLs. Sumangguni sa
The Vinyl 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 nakabuo ito ng eksaktong isang candidate image.
Ang mga prototype task na ginawa sa pamamagitan ng webapp ay hindi tinatanggap — tanging ang mga prototype task na binuo ng POST /openapi/creative-lab/vinyl-figure/v1/prototype lamang ang tinatanggap ng build endpoint, at tinatanggihan nito ang anumang ibang pinagmulan gamit ang 404.
Name
name
Type
string
Description
Opsyonal na pangalan ng task para sa layuning display. Maximum na 100 characters.
Ibinabalik
Ang result property ng response ay naglalaman ng task id ng bagong ginawang vinyl 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 textured GLB mula sa model_urls.glb (o ang pares na OBJ + MTL 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. Karaniwang mga dahilan:
Kulang na parameter: Kinakailangan ang input_task_id.
Di-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 candidate: Nagtagumpay ang prototype task ngunit hindi ito 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 para isagawa 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 ang mga prototype task sa API mode lamang ang maaaring maka-chain sa build).
Name
429 - Too Many Requests
Description
Nalagpasan mo na ang iyong rate limit.
Request
POST
/openapi/creative-lab/vinyl-figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de" }'
Kunin ang isang prototype o build task gamit ang isang wastong task id. Ang URL path
ay dapat tumugma sa yugto (stage) ng task — kung ang isang build task ay kinuha sa pamamagitan ng
/prototype/:id, magbabalik ito ng 404, at ganoon din sa kabaligtaran.
Kanselahin ang isang vinyl figure task. Kung ang task ay PENDING pa,
ang credits na nagamit noong panahon ng paglikha ay irerefund. Ang mga task
na IN_PROGRESS na ay kinakansela nang walang refund (maaaring
gumagamit na ng resources ang worker). Ang mga task na naabot na ang
huling estado (SUCCEEDED, FAILED, CANCELED) ay hindi na maaaring
kanselahin.
Ang URL path ay dapat tumugma sa stage ng task — ang DELETE sa
/prototype/:buildId ay magbabalik ng 404.
Path Parameters
Name
id
Type
path
Description
Natatanging identifier para sa vinyl figure task na ikakansela.
Returns
Nagbabalik ng 204 No Content kung matagumpay, na may walang laman na body.
Failure Modes
Name
400 - Bad Request
Description
Ang task ay nasa huling estado na at hindi na 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.
Mag-stream ng real-time na updates para sa isang vinyl figure task gamit ang Server-Sent Events
(SSE). Ang URL path ay dapat tumugma sa stage ng task — ang pagbukas ng stream sa
/prototype/:buildId/stream ay maglalabas ng isang event: error payload na may
status_code: 404 at isasara ang stream.
Mga Parameter
Name
id
Type
path
Description
Unique identifier para sa vinyl figure task na gustong i-stream.
Mga Ibabalik
Ibinabalik ang isang stream ng Vinyl Figure Prototype
o Vinyl Figure Build na mga task object
bilang Server-Sent Events. Dala ng bawat frame ang buong task object para sa stage na ito — ang parehong hugis na
ibinabalik ng Get endpoint — kaya habang ang task ay PENDING o IN_PROGRESS, ang
mga output field ay hindi pa lang napopulate (null, [] o {}) at
ang finished_at ay null.
Kunin ang isang paginated na listahan ng iyong mga vinyl figure task para sa isang stage.
Ang URL path ang pumipili ng stage — ang /prototype ay nagbabalik ng mga prototype task;
ang /build ay nagbabalik ng mga build task. Ang mga task mula sa kabilang stage ay hindi
kasama sa kahit alin sa dalawang tugon.
Path Parameters
Name
stage
Type
path
Kinakailangan
Description
prototype o build. Ang koleksyon ay nagbabalik lamang ng mga task
kung saan ang stage ay tumutugma sa URL — ang pagkuha sa /prototype ay hindi kailanman
nagbabalik ng mga build task at vice versa.
Query Parameters
Name
page_num
Type
integer
default 1
Description
Numero ng page para sa pagination.
Name
page_size
Type
integer
default 10
Description
Limitasyon sa laki ng page. Ang pinakamataas na pinahihintulutan ay 100 item.
Name
sort_by
Type
string
default -created_at
Description
Field na gagamitin sa pag-sort. Mga available na value:
+created_at: Isaayos ayon sa oras ng paggawa nang pataas (ascending order).
-created_at: Isaayos ayon sa oras ng paggawa nang pababa (descending order).
Ang object ng Vinyl Figure Prototype Task ay isang work unit na binabantayan ng Meshy
upang bumuo ng vinyl-figure-style na concept image mula sa isang pinagmulang larawan.
Ang output ng yugtong ito ay iniuugnay sa
yugto ng pagbuo sa pamamagitan ng input_task_id.
Mga Property
Name
id
Type
string
Description
Natatanging identifier para sa task. Bagaman gumagamit kami ng k-sortable UUID para sa mga task id bilang detalye ng implementasyon, 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-vinyl-figure-prototype.
Name
name
Type
string
Description
Ang pangalan ng task na ibinigay noong nilikha ang task. Walang laman na string kung walang naibigay 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 nilikha ang task, sa milliseconds.
Ang isang timestamp ay kumakatawan sa bilang ng mga millisecond na lumipas mula Enero 1, 1970 UTC, alinsunod sa
pamantayang RFC 3339.
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 nagsimula ang task, sa milliseconds. Kung hindi pa nagsisimula 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.
Ang value ng field na ito ay makabuluhan lamang 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 object na task_error.
Name
consumed_credits
Type
integer
Description
Ang bilang ng mga 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 (ang credits ay ire-refund kapag nabigo).
Name
image_urls
Type
array of strings
Description
Mga URL na madadownload 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 makapagpakita ng maraming kandidato nang hindi nakakasira sa umiiral na functionality.
Ang Vinyl Figure Build Task object ay isang work unit na sinusubaybayan ng Meshy
upang bumuo ng isang textured 3D vinyl 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 kaayon ng 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-vinyl-figure-build.
Name
name
Type
string
Description
Ang pangalan ng task na ibinigay noong ginawa ang task. Blangkong 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 naging matagumpay ang task, magiging 100 ito.
Name
created_at
Type
timestamp
Description
Timestamp kung kailan nagawa ang task, sa milliseconds.
Name
started_at
Type
timestamp
Description
Timestamp kung kailan nagsimula 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 naunang 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 credits na naubos ng task na ito. Nagbabalik ng 0 para sa mga FAILED na task (nire-refund ang credits kapag nabigo).
Name
prompt
Type
string
Description
Palaging blangko para sa vinyl 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 blangko para sa vinyl figure build. Naroroon para sa cross-endpoint compatibility.
Name
texture_prompt
Type
string
Description
Palaging blangko para sa vinyl figure build. Naroroon para sa cross-endpoint compatibility.
Name
texture_image_url
Type
string
Description
Palaging blangko para sa vinyl figure build. Naroroon para sa cross-endpoint compatibility.
Name
model_urls
Type
object
Description
Mga URL na maaaring i-download para sa nabuong 3D model. Ang vinyl 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 na ito ay tumutugma sa Image to 3D model_urls object upang ang mga karagdagang format sa hinaharap ay madagdag nang walang breaking change.
Name
glb
Type
string
Description
URL na maaaring i-download para sa textured GLB file.
Name
obj
Type
string
Description
URL na maaaring i-download para sa Wavefront OBJ file (heometriya + UV).
Name
mtl
Type
string
Description
URL na maaaring i-download para sa companion MTL material file ng OBJ. Ipares sa obj at sa entry mula sa texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
URL na maaaring i-download para sa thumbnail image ng model file.
Name
texture_urls
Type
array
Description
Isang array ng texture URL object na ginawa ng task na ito. Sa kasalukuyan ay naglalaman ito ng iisang object na may base color map.
Name
base_color
Type
string
Description
URL na maaaring i-download para sa base color map image.