Gawing malaking ulo na kolektibleng 3D figure ang isang picture sa dalawang
yugto: ang prototype ay bumubuo ng styled na konseptong larawan mula sa iyong input
photo, pagkatapos ay ang build ay nagiging konseptong larawan na ito sa isang malaking ulo na 3D model na may texture.
Ang dalawang yugto ay konektado sa pamamagitan ng input_task_id.
POST /openapi/creative-lab/vinyl-figure/v1/prototype
Mag-generate ng isang konsepto ng imahen na may istilong vinyl-figure mula sa pinagmulan na larawan. Ang ibinalik na task ID ang ipapasa mo bilang input_task_id sa build endpoint. Sumangguni sa
Ang 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. Sinusuportahan namin sa kasalukuyan ang mga format na .jpg, .jpeg, .png, at .webp.
Mayroong dalawang paraan upang ibigay ang imahe:
Publicly accessible URL: Isang URL na maaring ma-access mula sa pampublikong internet.
Data URI: Isang base64-encoded na 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 pagpapakita. Maximum 100 characters.
Mga Ibinabalik
Ang result na property ng tugon ay naglalaman ng task id ng bagong-gawa na vinyl figure prototype task. I-poll ang Kunin ang isang 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 Paraan ng Pagkabigo
Name
400 - Bad Request
Description
Ang kahilingan ay hindi katanggap-tanggap. Karaniwang sanhi:
Missing parameter: Ang image_url ay kinakailangan.
Invalid image format: Ang ibinigay na image_url ay hindi isang suportadong format (.jpg, .jpeg, .png, .webp).
Image dimensions out of range: Ang imahe ay masyadong maliit, lumampas sa maximum file size, o lumampas sa maximum pixel count.
Unreachable URL: Ang image_url ay hindi ma-download (404 o timeout).
Invalid Data URI: Ang base64 string ay mali ang pagkakaayos.
Content flagged: Ang input na imahe ay na-flag ng NSFW o intellectual property moderation.
Name
401 - Unauthorized
Description
Nabigo ang authentication. Paki-check ang iyong API key.
Name
402 - Payment Required
Description
Walang sapat na credits para gawin ang task na ito.
Name
429 - Too Many Requests
Description
Lampas ka na sa iyong rate limit.
Request
POST
/openapi/creative-lab/vinyl-figure/v1/prototype
# Stage 1: mag-generate ng isang vinyl-figure-style na konsepto ng imahecurl https://api.meshy.ai/openapi/creative-lab/vinyl-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":"019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de"}
Prototype example
Start with a source portrait, then generate the prototype image used by the build stage.
Bumuo ng pinal na textured na 3D vinyl figure mula sa isang natapos na prototype task. Ang build ay gumagamit ng parehong image-to-3D pipeline tulad ng Image to 3D, kaya ang response object format at ang listahan ng mga output URL ay pareho. Tingnan ang The Vinyl Figure Build Task Object para sa response na hugis.
Mga Parameter
Name
input_task_id
Type
string
Kinakailangan
Description
Ang ID ng task para sa 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 na umabot sa SUCCEEDED, at dapat nakalikha 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 sa pamamagitan ng POST /openapi/creative-lab/vinyl-figure/v1/prototype at tinatanggihan ang anumang iba pang pinagmulan na may 404.
Name
name
Type
string
Description
Opsyonal na pangalan ng task para sa display purposes. Maximum na 100 na karakter.
Mga Ibinabalik
Ang result na property ng sagot ay naglalaman ng task id ng bagong likha na vinyl figure build task. Mag-poll sa Get a Task endpoint o mag-subscribe sa stream hanggang sa maabot ng task ang 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 ang iyong downstream pipeline ay mas gusto ang OBJ).
Mga Mode ng Pagkabigo
Name
400 - Bad Request
Description
Ang kahilingan ay hindi katanggap-tanggap. Karaniwang mga sanhi:
Nawawalang parameter: Ang input_task_id ay kinakailangan.
Invalid UUID: Ang input_task_id ay hindi wasto na UUID.
Hindi umabot sa tagumpay ang magulang: Ang tinukoy na prototype task ay hindi pa umaabot sa SUCCEEDED.
Walang kandidato: Ang prototype task ay nagtagumpay ngunit walang nilikhang candidate image.
Name
401 - Unauthorized
Description
Nabigo ang authentication. Pakisuri ang iyong API key.
Name
402 - Payment Required
Description
Kulang ang mga kredito 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 build ay tumatanggap lamang ng mga API-mode prototype task).
Name
429 - Too Many Requests
Description
Naabot mo na ang iyong rate limit.
Request
POST
/openapi/creative-lab/vinyl-figure/v1/build
# Yugto 2: bumuo mula sa isang natapos na prototype taskcurl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build \ -X POST \ -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 bumuo ng gawain gamit ang isang valid na id ng gawain. Ang URL path ay dapat tumugma sa stage ng gawain — isang build task na kinuha sa pamamagitan ng /prototype/:id ay babalik ng 404, at kabaliktaran.
Kanselahin ang isang task ng vinyl figure. Kung ang task ay nasa PENDING pa, ang credits
na kinonsumo noong oras ng paglikha ay ibinabalik. Ang mga task na nasa
IN_PROGRESS ay kinansela nang walang refund (ang manggagawa ay maaaring gumagamit na ng
resources). Ang mga task na nakaabot na sa terminal na estado
(SUCCEEDED, FAILED, CANCELED) ay hindi na maaaring ikansela.
Dapat magkatugma ang URL path sa yugto ng task — DELETE sa
/prototype/:buildId ay nagbabalik ng 404.
Path Parameters
Name
id
Type
path
Description
Natatanging identifier para sa vinyl figure task na kakanselahin.
Ibinabalik
Nagbabalik ng 204 No Content sa matagumpay na aksyon na may walang laman na katawan.
Mga Mode ng Pagkabigo
Name
400 - Bad Request
Description
Ang task ay nasa terminal na estado at hindi na maaaring ikansela.
Name
404 - Not Found
Description
Ang task ay hindi umiiral, pagmamay-ari ng ibang user, o ang yugto nito ay hindi tugma sa URL path.
I-stream ang real-time na updates para sa isang vinyl figure task sa pamamagitan ng Server-Sent Events
(SSE). Ang URL na landas ay dapat tumugma 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 pagkakakilanlan para sa vinyl figure task upang i-stream.
Mga Ibinabalik
Ibinabalik ang isang stream ng mga bagay ng Vinyl Figure Prototype
o Vinyl Figure Build task bilang Server-Sent Events. Para sa mga PENDING o IN_PROGRESS na mga task, ang stream ng tugon ay magsasama lamang ng kinakailangang mga field na progress at status.
// Hinagap na halimbawa ng error event (mali ang yugto o hindi nahanap ang task)event: errordata: {"status_code": 404,"message": "Task not found"}// Mga halimbawa ng event na mensahe na naglalarawan ng progreso ng task.// Para sa mga PENDING o IN_PROGRESS na mga task, hindi kasama ang lahat ng mga field sa response stream.event: messagedata: {"id": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef","progress": 0,"status": "PENDING"}event: messagedata: {"id": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef","type": "creative-lab-vinyl-figure-build","status": "SUCCEEDED","progress": 100,"created_at": 1752969700000,"started_at": 1752969710000,"finished_at": 1752969735000,"expires_at": 1753228935000,"task_error": null,"consumed_credits": 30,"prompt": "","negative_prompt": "","texture_prompt": "","texture_image_url": "","model_urls": {"glb":"https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.glb?Expires=***","obj":"https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.obj?Expires=***","mtl":"https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.mtl?Expires=***" },"thumbnail_url": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/preview.png?Expires=***","texture_urls": [ {"base_color":"https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/texture_0.png?Expires=***" } ]}
Kunin ang isang listahang may pagination ng iyong vinyl figure tasks para sa isang single stage.
Ang landas ng URL ay pumipili ng yugto — /prototype ay nagbabalik ng mga prototype na gawain;
/build ay nagbabalik ng mga build na gawain. Ang mga gawain mula sa iba pang yugto ay hindi kabilang
sa alinman sa mga tugon.
Path Parameters
Name
stage
Type
path
Kinakailangan
Description
Alinman sa prototype o build. Ang koleksyon ay nagbabalik lamang ng mga gawain
kung saan ang yugto ay tumutugma sa URL — ang pagkuha ng /prototype ay hindi kailanman nagbabalik
ng mga build na gawain at vice versa.
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 50 na mga item.
Name
sort_by
Type
string
default -created_at
Description
Patlang na gagamitin sa pag-aayos. Mga magagamit na halaga:
+created_at: Ayusin ayon sa oras ng paglikha nang pataas.
-created_at: Ayusin ayon sa oras ng paglikha nang pababa.
# Listahan ng mga prototype na gawaincurl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/prototype?page_size=10 \ -H "Authorization: Bearer ${YOUR_API_KEY}"# Listahan ng mga build na gawaincurl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build?page_size=10 \ -H "Authorization: Bearer ${YOUR_API_KEY}"
Ang Prototype Task Object ng Vinyl Figure ay isang yunit ng trabaho na sinusubaybayan ng Meshy
upang makabuo ng isang konseptong imahe na may istilong vinyl figure mula sa isang source na larawan.
Ang output ng yugtong ito ay naka-chain sa
yugtong pagbuo sa pamamagitan ng input_task_id.
Mga Katangian
Name
id
Type
string
Description
Natatanging identifier para sa gawain. Habang gumagamit kami ng k-sortable UUID para sa mga task id bilang bahagi ng implementasyon, hindi ka dapat gumawa ng anumang 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
Pangalan ng gawain na ibinigay nang likhain 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 hindi pa nasisimulan ang gawain, ang katangiang ito ay magiging 0. Kapag ang gawain ay naging matagumpay, ito ay magiging 100.
Name
created_at
Type
timestamp
Description
Timestamp ng kung kailan nilikha ang gawain, sa milliseconds.
Ang timestamp ay kumakatawan sa bilang ng milliseconds na lumipas mula Enero 1, 1970 UTC, kasunod ng
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 ng kung kailan nagsimula ang gawain, sa milliseconds. Kung hindi pa nagsisimula ang gawain, ang katangiang ito ay magiging 0.
Name
finished_at
Type
timestamp
Description
Timestamp ng kung kailan natapos ang gawain, sa milliseconds. Kung hindi pa natatapos ang gawain, ang katangiang ito ay magiging 0.
Name
expires_at
Type
timestamp
Description
Timestamp ng kung kailan nag-e-expire ang resulta ng gawain, sa milliseconds.
Name
preceding_tasks
Type
integer
Description
Bilang ng mga nauunang gawain.
Ang halaga ng field na ito ay may saysay 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 reference ng task_error na object.
Name
consumed_credits
Type
integer
Description
Ang bilang ng mga credits na nagamit ng gawain na ito. Naroon kapag ang katayuan ng gawain ay PENDING, IN_PROGRESS, o SUCCEEDED. Nagbabalik ng 0 para sa mga FAILED na gawain (ang mga credits ay ibinabalik sa pagkabigo).
Name
image_urls
Type
array of strings
Description
Mga downloadable URLs para sa mga concept image candidates na nabuo ng prototype na gawain na ito. Sa kasalukuyan, ang API ay palaging nagbabalik ng eksaktong isang kandidato; ang field ay isang array kaya ang mga susunod na rebisyon ay maaaring magpakita ng maraming kandidato nang hindi nagkakaroon ng breaking change.
Ang Vinyl Figure Build Task object ay isang unit ng trabaho na sinusubaybayan ng Meshy
upang makabuo ng isang may tekstura na 3D vinyl figure mula sa isang succeeded na prototype task.
Gumagamit ito ng parehong image-to-3D pipeline na ginagamit ng Image to 3D,
kaya ang output fields ay katulad ng endpoint na task object.
Properties
Name
id
Type
string
Description
Natatanging pagkakakilanlan para sa gawain.
Name
type
Type
string
Description
Uri ng gawain. Ang halaga ay creative-lab-vinyl-figure-build.
Name
name
Type
string
Description
Ang pangalan ng gawain na ibinigay noong nilikha ang gawain. Walang laman kung walang pangalan ang ibinigay.
Name
status
Type
string
Description
Katayuan ng gawain. Ang posibleng mga halaga ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Pag-unlad ng gawain. Kung hindi pa nasisimulan ang gawain, ang property na ito ay magiging 0. Kapag ang gawain ay nagtagumpay na, ito ay magiging 100.
Name
created_at
Type
timestamp
Description
Timestamp kung kailan nilikha ang gawain, sa milliseconds.
Name
started_at
Type
timestamp
Description
Timestamp kung kailan sinimulan ang gawain, sa milliseconds.
Name
finished_at
Type
timestamp
Description
Timestamp kung kailan natapos ang gawain, sa milliseconds.
Name
expires_at
Type
timestamp
Description
Timestamp kung kailan mawawalan ng bisa ang resulta ng gawain, sa milliseconds.
Name
preceding_tasks
Type
integer
Description
Bilang ng mga nauunang gawain. Makabuluhan 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 sanggunian ng task_error object.
Name
consumed_credits
Type
integer
Description
Ang bilang ng credits na nagamit ng gawain na ito. Nagbabalik ng 0 para sa mga FAILED na gawain (ibinabalik ang credits kapag may pagkabigo).
Name
prompt
Type
string
Description
Palaging walang laman para sa vinyl figure build. Naka-presente para sa cross-endpoint na kakayahan ng V2ImageTo3DTaskResponse na ginagamit ng Image to 3D.
Name
negative_prompt
Type
string
Description
Palaging walang laman para sa vinyl figure build. Naka-presente para sa cross-endpoint na kakayahan.
Name
texture_prompt
Type
string
Description
Palaging walang laman para sa vinyl figure build. Naka-presente para sa cross-endpoint na kakayahan.
Name
texture_image_url
Type
string
Description
Palaging walang laman para sa vinyl figure build. Naka-presente para sa cross-endpoint na kakayahan.
Name
model_urls
Type
object
Description
Mga maidadownload na URL para sa nabuo na 3D model. Naglalabas ang vinyl figure build ng isang textured na GLB kasama ang pares na OBJ + MTL para sa mga pipeline na mas gusto ang Wavefront OBJ. Ang hugis ng larangan ay katugma ng Image to 3D model_urls object kaya't ang mga karagdagan sa hinaharap na format ay nakahanda nang walang pagbabago na nakakagulo.
Name
glb
Type
string
Description
Maidadownload na URL sa textured na GLB file.
Name
obj
Type
string
Description
Maidadownload na URL sa Wavefront OBJ file (heometriya + UV).
Name
mtl
Type
string
Description
Maidadownload na URL sa kasamang MTL material file ng OBJ. Ipares sa obj at sa entry mula sa texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
Maidadownload na URL sa thumbnail na imahe ng model file.
Name
texture_urls
Type
array
Description
Isang array ng mga texture URL object na nabuo ng gawain na ito. Sa kasalukuyan ay naglalaman ng isang solong object na may base color map.