I-transform ang isang source photo sa isang big-head vinyl collectible 3D figure sa dalawang yugto: prototype na bumubuo ng isang styled concept image mula sa iyong input na larawan, pagkatapos ang build ay nagiging concept image na iyon sa isang textured 3D model. Ang dalawang yugto ay konektado sa pamamagitan ng input_task_id.
POST /openapi/creative-lab/vinyl-figure/v1/prototype
Bumuo ng isang konsepto ng imahe na may istilong vinyl-figure mula sa pinagmulan na larawan. Ang ibinalik na task ID ay ang ipapasa mo bilang input_task_id sa build endpoint. Sumangguni sa
The Vinyl Figure Prototype Task Object
para sa anyo ng tugon.
Mga Parameter
Name
image_url
Type
string
Kinakailangan
Description
Pinagmulan na larawan para sa Meshy upang i-stylize bilang isang big-head vinyl figure. Kasalukuyan naming sinusuportahan ang mga format na .jpg, .jpeg, .png, at .webp.
May dalawang paraan upang ibigay ang larawan:
Publicly accessible URL: Isang URL na naa-access mula sa pampublikong internet.
Data URI: Isang base64-encoded na data URI ng larawan. 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 pagpapakita. Maximum na 100 karakter.
Name
remove_background
Type
boolean
default false
Description
Kapag nakatakda sa true, ang prototype na imahe ay ibinabalik bilang isang transparent na RGBA PNG na may tinanggal na background, upang maaari mong i-composite ang paksa sa anumang background.
Mga Ibinabalik
Ang result na property ng tugon ay naglalaman ng task id ng bagong nilikhang vinyl figure prototype task. I-poll ang Get a Task endpoint o mag-subscribe sa stream hanggang ang task ay umabot sa SUCCEEDED, pagkatapos ay ipasa ang ID na iyon sa build endpoint bilang input_task_id.
Mga Mode ng Pagkabigo
Name
400 - Bad Request
Description
Ang kahilingan ay hindi katanggap-tanggap. Karaniwang mga 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 larawan ay masyadong maliit, lumampas sa maximum na laki ng file, o lumampas sa maximum na bilang ng pixel.
Unreachable URL: Ang image_url ay hindi ma-download (404 o timeout).
Invalid Data URI: Ang base64 string ay hindi tama ang pagkakabuo.
Content flagged: 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 ang credits upang isagawa ang task na ito.
Name
429 - Too Many Requests
Description
Lumampas ka sa 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"}
Halimbawa ng Prototype
Magsimula sa isang pinagmulan na larawan, pagkatapos ay bumuo ng prototype na imahe na ginagamit sa build stage.
Bumuo ng huling textured 3D vinyl figure mula sa isang nagtagumpay na prototype task. Ang build ay nagpapatakbo ng parehong image-to-3D pipeline gaya ng Image to 3D, kaya't ang format ng response object at ang listahan ng output URLs ay eksaktong tumutugma. Sumangguni sa The Vinyl 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 ginawa sa pamamagitan ng parehong OpenAPI endpoint na ito. Ang prototype ay dapat na nilikha gamit ang parehong API key, dapat ay umabot sa SUCCEEDED, at dapat ay nakagawa 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 ginawa ng POST /openapi/creative-lab/vinyl-figure/v1/prototype at tinatanggihan ang anumang ibang pinagmulan gamit ang 404.
Name
name
Type
string
Description
Opsyonal na pangalan ng task para sa layunin ng pagpapakita. Maximum na 100 karakter.
Mga Ibinabalik
Ang result na property ng tugon ay naglalaman ng task id ng bagong likhang vinyl figure build task. I-poll ang Get a Task endpoint o mag-subscribe sa stream hanggang sa umabot ang task sa SUCCEEDED, pagkatapos ay i-download ang textured GLB mula sa model_urls.glb (o ang OBJ + MTL na pares mula sa model_urls.obj at model_urls.mtl kung mas gusto ng iyong downstream pipeline ang OBJ).
Mga Mode ng Pagkabigo
Name
400 - Bad Request
Description
Ang kahilingan ay hindi katanggap-tanggap. Karaniwang mga sanhi:
Nawawalang parameter: Kinakailangan ang input_task_id.
Hindi wastong UUID: Ang input_task_id ay hindi wastong UUID.
Hindi nagtagumpay ang magulang: Ang tinutukoy na prototype task ay hindi pa umabot sa SUCCEEDED.
Walang kandidato: Ang prototype task ay nagtagumpay 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 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 API-mode prototype tasks lamang ang maaaring mag-chain sa build).
Name
429 - Too Many Requests
Description
Naabot 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 ng task — ang isang build task na kinuha sa pamamagitan ng
/prototype/:id ay magbabalik ng 404, at kabaligtaran.
Kanselahin ang isang vinyl figure task. Kung ang task ay nasa PENDING pa, ang credits
na nagamit sa oras ng paglikha ay ibabalik. Ang mga task na nasa
IN_PROGRESS ay kinansela nang walang refund (maaaring gumagamit na ang worker ng resources). Ang mga task na umabot na sa terminal state
(SUCCEEDED, FAILED, CANCELED) ay hindi na maaaring kanselahin.
Ang URL path ay dapat tumugma sa stage ng task — DELETE sa
/prototype/:buildId ay magbabalik ng 404.
Path Parameters
Name
id
Type
path
Description
Natatanging identifier para sa vinyl figure task na kakanselahin.
Returns
Nagbabalik ng 204 No Content sa tagumpay na may walang laman na katawan.
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, pagmamay-ari ng ibang user, o ang stage nito ay hindi tumutugma sa URL path.
I-stream ang mga real-time na update para sa isang vinyl figure task sa pamamagitan ng Server-Sent Events (SSE). Ang URL path ay dapat tumugma sa yugto ng task — ang pagbubukas 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
Natatanging pagkakakilanlan para sa vinyl figure task na i-stream.
Mga Ibinabalik
Nagbabalik ng stream ng mga object ng Vinyl Figure Prototype o Vinyl Figure Build bilang Server-Sent Events. Para sa mga PENDING o IN_PROGRESS na mga task, ang response stream ay maglalaman lamang ng kinakailangang mga field na progress at status.
Kunin ang isang listahan na may pagination ng iyong mga gawain sa vinyl figure para sa isang yugto. Ang URL path ay pumipili ng yugto — ang /prototype ay nagbabalik ng mga gawain sa prototype; ang /build ay nagbabalik ng mga gawain sa build. Ang mga gawain mula sa ibang yugto ay hindi kasama sa alinmang tugon.
Mga Parameter ng Path
Name
stage
Type
path
Kinakailangan
Description
Alinman sa prototype o build. Ang koleksyon ay nagbabalik lamang ng mga gawain na ang yugto ay tumutugma sa URL — ang pagkuha ng /prototype ay hindi kailanman nagbabalik ng mga gawain sa build at kabaligtaran.
Mga Parameter ng Query
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. Ang maximum na pinapayagan ay 50 na item.
Name
sort_by
Type
string
default -created_at
Description
Patlang na gagamitin sa pag-uuri. Mga magagamit na halaga:
+created_at: Ayusin ayon sa oras ng paglikha sa pataas na pagkakasunod-sunod.
-created_at: Ayusin ayon sa oras ng paglikha sa pababang pagkakasunod-sunod.
Ang Vinyl Figure Prototype Task object ay isang yunit ng trabaho na sinusubaybayan ng Meshy upang makabuo ng isang vinyl-figure-style na konsepto ng imahe mula sa isang source na larawan. Ang output ng yugtong ito ay konektado sa yugtong 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 mga task id 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-vinyl-figure-prototype.
Name
name
Type
string
Description
Ang pangalan ng gawain na ibinigay noong nilikha ang gawain. Walang laman na string kung walang pangalan na ibinigay.
Name
status
Type
string
Description
Katayuan 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 ang gawain ay hindi pa nasisimulan, ang katangiang ito ay magiging 0. Kapag ang gawain ay nagtagumpay, ito ay magiging 100.
Name
created_at
Type
timestamp
Description
Timestamp kung kailan nilikha ang gawain, sa milliseconds.
Ang timestamp ay kumakatawan sa bilang ng milliseconds na lumipas mula Enero 1, 1970 UTC, alinsunod sa
RFC 3339 na pamantayan.
Halimbawa, Biyernes, Setyembre 1, 2023 12:00:00 PM GMT ay kinakatawan bilang 1693569600000. Ito ay naaangkop
sa lahat ng mga timestamp sa Meshy API.
Name
started_at
Type
timestamp
Description
Timestamp kung kailan sinimulan ang gawain, sa milliseconds. Kung ang gawain ay hindi pa nasisimulan, ang katangiang ito ay magiging 0.
Name
finished_at
Type
timestamp
Description
Timestamp kung kailan natapos ang gawain, sa milliseconds. Kung ang gawain ay hindi pa natatapos, ang katangiang ito ay magiging 0.
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 field na ito ay makabuluhan lamang kung ang katayuan 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 na object na sanggunian.
Name
consumed_credits
Type
integer
Description
Ang bilang ng credits na nagamit ng gawain na ito. Kasalukuyan kapag ang katayuan ng gawain ay PENDING, IN_PROGRESS, o SUCCEEDED. Nagbabalik ng 0 para sa mga FAILED na gawain (ang credits ay ibinabalik kapag nabigo).
Name
image_urls
Type
array of strings
Description
Mga maida-download na URL para sa mga kandidato ng konsepto ng imahe na nabuo ng prototype task na ito. Sa kasalukuyan, ang API ay palaging nagbabalik ng eksaktong isang kandidato; ang field ay isang array upang ang mga susunod na bersyon ay makapagpakita ng maraming kandidato nang walang pagbabago sa sistema.
Ang Vinyl Figure Build Task object ay isang yunit ng trabaho na sinusubaybayan ng Meshy upang makabuo ng isang textured na 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't ang mga output fields ay sumasalamin sa endpoint ng task object.
Mga Katangian
Name
id
Type
string
Description
Natatanging pagkakakilanlan para sa task.
Name
type
Type
string
Description
Uri ng task. Ang halaga ay creative-lab-vinyl-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
Katayuan ng task. Ang mga posibleng halaga ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Pag-unlad ng task. Kung ang task ay hindi pa nasisimulan, ang property na ito ay magiging 0. Kapag ang task ay nagtagumpay, 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 naunang task. Makabuluhan 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 task_error object reference.
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 (ang mga credits ay ibinabalik kapag nabigo).
Name
prompt
Type
string
Description
Palaging walang laman 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 walang laman para sa vinyl figure build. Naroroon para sa cross-endpoint compatibility.
Name
texture_prompt
Type
string
Description
Palaging walang laman para sa vinyl figure build. Naroroon para sa cross-endpoint compatibility.
Name
texture_image_url
Type
string
Description
Palaging walang laman para sa vinyl figure build. Naroroon para sa cross-endpoint compatibility.
Name
model_urls
Type
object
Description
Mga downloadable URL para sa nabuo na 3D model. Ang vinyl figure build ay naglalabas ng isang textured na 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 object kaya't ang mga karagdagang format sa hinaharap ay maaaring idagdag nang walang breaking change.
Name
glb
Type
string
Description
Downloadable URL sa textured na 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 task na ito. Sa kasalukuyan ay naglalaman ng isang object na may base color map.