Creative Lab Vinyl Figure API

Gawing isang malaking-ulo na vinyl collectible 3D figure ang isang larawan sa dalawang yugto. Ang isang prototype task ay bumubuo ng concept image mula sa larawan. Ang isang build task ay ginagawang textured 3D model ang imaheng iyon, at kinukuha ang ID ng prototype task bilang input_task_id.

POST /openapi/creative-lab/vinyl-figure/v1/prototype
POST /openapi/creative-lab/vinyl-figure/v1/build

POST/openapi/creative-lab/vinyl-figure/v1/prototype

Lumikha ng Vinyl Figure prototype task

Gumagawa ng isang vinyl-figure-style na concept image mula sa isang larawan. Upang buuin ang 3D model, ipasa ang ID ng task na ito sa build endpoint bilang input_task_id. Para sa mga field ng task, tingnan ang The Vinyl Figure prototype task object.

Request

POST

/openapi/creative-lab/vinyl-figure/v1/prototype

# Stage 1: generate a vinyl-figure-style concept image
curl 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 photo, then generate the prototype image used by the build stage.

Source photo used as the Creative Lab Vinyl Figure input — Prototype input

Big-head vinyl figure prototype image generated from the source photo — Prototype output

Mga Parameter

Name
image_url
Type
string
Kinakailangan
Description
Ang larawang gagawing malaking-ulo na vinyl figure, bilang public URL o data URI (data:image/jpeg;base64,<your base64-encoded image data>).
Ang larawan ay dapat JPG, JPEG, PNG, o WebP file na hindi hihigit sa 20 MB.
Name
name
Type
string
Description
Isang pangalan para sa task, hanggang 100 character. Makikita ito sa name field ng task. Nagbabalik ng 400 kung mas mahaba ang pangalan.
Name
remove_background
Type
boolean
default false
Description
Kung aalisin ang background mula sa prototype image. Ang true ay nagbabalik ng transparent RGBA PNG, para mailagay mo ang subject sa kahit anong background. Ang build ay magsisimula rin mula sa larawang walang background nito. Kung hindi maalis ni Meshy ang background, ibabalik nito ang larawan kasama ang background nito, at matagumpay pa ring matatapos ang task.

Mga Ibinabalik

Ang result field ay naglalaman ng ID ng bagong prototype task. Kunin ang task o i-stream ito hanggang maging SUCCEEDED ang status. Pagkatapos, ipasa ang ID sa build endpoint bilang input_task_id.

Mga Mode ng Kabiguan

Name
400 - Bad Request
Description
Hindi maipapatakbo ang request. Halimbawa:
- Nawawala ang image_url.
- Ang larawan ay hindi isang JPG, JPEG, PNG, o WebP file.
- Masyadong maliit ang larawan, lumampas sa 20 MB, o lumampas sa maximum na pixel count.
- Hindi ma-download ni Meshy ang larawan, halimbawa dahil nagbalik ng 404 ang URL o nag-timeout.
- Ang data URI ay hindi valid na base64.
- Na-flag ang larawan bilang NSFW.
Sinasabi ng error message kung aling problema ang nakita nito. Ayusin ang request, pagkatapos ay ipadala muli.
Name
401 - Unauthorized
Description
Nawawala o invalid ang API key. Suriin ang Authorization header.
Name
402 - Payment Required
Description
Isa sa mga sumusunod ang nangyari:
- Hindi sapat ang credits ng account.
- Naabot ng API key, workspace, o miyembro ang limitasyon ng credits nito.
- Nasa free plan ang account.
Suriin ang iyong credits at plan, pagkatapos ay subukan muli.
Name
403 - Forbidden
Description
Naka-on ang IP Filtering ng iyong team, at na-flag ni Meshy ang larawan dahil sa intellectual property ng ibang partido. Magpadala ng larawan na may karapatan kang gamitin.
Name
429 - Too Many Requests
Description
Isa sa mga limitasyong ito ang naabot:
- Nagpadala ka ng mas maraming request kaysa sa pinapayagan ng iyong rate limit. Maghintay ng ilang segundo, pagkatapos ay subukan muli. Tingnan ang Rate limits.
- Masyadong maraming task mo ang naka-queue o tumatakbo. Maghintay hanggang matapos ang ilan, pagkatapos ay subukan muli.
- Sa isang unlimited plan na walang natitirang credits, naabot mo na ang bilang ng mga task na maaaring tumakbo nang walang credits. Maghintay hanggang matapos ang isang task, o magdagdag ng credits.
Name
500 - Internal Server Error
Description
Nagkaroon ng server error si Meshy, halimbawa dahil hindi nito napatakbo ang intellectual property check sa larawan. Hindi lumikha ng task si Meshy, at irerefund ang anumang credits na siningil nito. Subukan muli ang request.

POST/openapi/creative-lab/vinyl-figure/v1/build

Gumawa ng Vinyl Figure build task

Bumubuo ng textured 3D vinyl figure mula sa isang matagumpay na prototype task. Para sa mga field nito, tingnan ang The Vinyl Figure build task object.

Request

POST

/openapi/creative-lab/vinyl-figure/v1/build

# Stage 2: chain build off a succeeded prototype task
curl 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"
  }'

Response

{
  "result": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef"
}

Mga Parameter

Name
input_task_id
Type
string
Kinakailangan
Description
Ang ID ng prototype task na bubuuin. Dapat itong isang task na ginawa ng iyong account gamit ang POST /openapi/creative-lab/vinyl-figure/v1/prototype, na may status na SUCCEEDED.
Ang ID na hindi isa sa iyong mga Vinyl Figure prototype task mula sa API ay magbabalik ng 404, kasama na ang prototype na ginawa sa web app.
Name
name
Type
string
Description
Isang pangalan para sa task, hanggang 100 karakter. Ito ay babalik sa name field ng task. Ang mas mahabang pangalan ay magbabalik ng 400.

Mga Ibinabalik

Ang field na result ay naglalaman ng ID ng bagong build task. Kunin ang task o i-stream ito hanggang ang status ay SUCCEEDED. Pagkatapos, i-download ang textured GLB mula sa model_urls.glb. Para sa OBJ naman, i-download ang model_urls.obj kasama ang material file nito mula sa model_urls.mtl.

Mga mode ng pagkabigo

Name
400 - Bad Request
Description
Hindi maaaring patakbuhin ang request. Halimbawa:
- Nawawala ang input_task_id o hindi ito valid na task ID.
- Ang status ng prototype task ay hindi SUCCEEDED. Kung tumatakbo pa ito, maghintay at subukan muli. Kung nabigo ito o na-cancel, gumawa ng bagong prototype task.
- Matagumpay ang prototype task ngunit walang imahe. Gumawa ng bagong prototype task.
Sinasabi ng error message kung aling problema ang natagpuan nito.
Name
401 - Unauthorized
Description
Nawawala o hindi valid ang API key. Suriin ang Authorization header.
Name
402 - Payment Required
Description
Isa sa mga sumusunod ang naaangkop:
- Hindi sapat ang credits ng account.
- Naabot ng API key, workspace, o miyembro ang limitasyon ng credit nito.
- Nasa free plan ang account.
Suriin ang iyong credits at plan, pagkatapos ay subukan muli.
Name
404 - Not Found
Description
Ang input_task_id ay hindi tumutugma sa anumang Vinyl Figure prototype task na ginawa ng iyong account gamit ang API. Ang prototype na ginawa sa web app ay nagbabalik din ng 404. Ipadala ang result ID mula sa tugon ng paggawa ng prototype.
Name
429 - Too Many Requests
Description
Isa sa mga sumusunod na limitasyon ang naabot:
- Nagpadala ka ng mas maraming request kaysa sa pinapayagan ng iyong rate limit. Maghintay ng ilang segundo, pagkatapos ay subukan muli. Tingnan ang Rate limits.
- Masyadong maraming task mo ang naka-queue o tumatakbo. Maghintay hanggang matapos ang ilan, pagkatapos ay subukan muli.
- Sa unlimited plan na walang natitirang credits, naabot mo ang bilang ng mga task na maaaring tumakbo nang walang credits. Maghintay hanggang matapos ang isang task, o magdagdag ng credits.

GET/openapi/creative-lab/vinyl-figure/v1/(prototype|build)/:id

Kunin ang gawain ng Vinyl Figure

Nagbabalik ng prototype o build na gawain. Dapat tumugma ang path sa yugto ng gawain. Ang build na gawain na hiniling sa pamamagitan ng /prototype/:id ay nagbabalik ng 404, at ganoon din ang prototype na gawain na hiniling sa pamamagitan ng /build/:id.

Para sa mga field, tingnan ang Ang Vinyl Figure prototype task object at Ang Vinyl Figure build task object.

Request

GET

/openapi/creative-lab/vinyl-figure/v1/prototype/019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de

# Prototype
curl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/prototype/019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de",
  "type": "creative-lab-vinyl-figure-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1752969600000,
  "started_at": 1752969604000,
  "finished_at": 1752969630000,
  "expires_at": 1753228830000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef",
  "type": "creative-lab-vinyl-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1752969700000,
  "started_at": 1752969710000,
  "finished_at": 1752969735000,
  "expires_at": 1753228935000,
  "preceding_tasks": 0,
  "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=***"
    }
  ]
}

Mga Parameter

Name
id
Type
path
Description
Ang task ID mula sa sagot ng paggawa (create response).

Ibinabalik

Ang prototype task object o ang build task object, ayon sa yugtong tinutukoy sa path.

Mga mode ng kabiguan

Name
400 - Bad Request
Description
Hindi valid na task ID ang id. Ipadala ang result ID mula sa sagot ng paggawa (create response).
Name
403 - Forbidden
Description
Naka-on ang IP Filtering ng iyong team, at na-flag ng Meshy ang larawan ng gawain dahil sa intellectual property ng ibang partido. Hindi nakukuha ng mga team sa Enterprise plan ang error na ito. Gumawa ng prototype na gawain mula sa larawang may karapatan kang gamitin.
Name
404 - Not Found
Description
Walang Vinyl Figure na gawain na may ID na ito na nauukol sa iyong account, o hindi tumutugma ang yugto ng gawain sa path. Suriin ang ID, at gamitin ang /prototype o /build upang itugma ito sa gawain.
Name
500 - Internal Server Error
Description
Hindi na-run ng Meshy ang pagsusuri sa intellectual property. Subukan muli ang kahilingan.

DELETE/openapi/creative-lab/vinyl-figure/v1/(prototype|build)/:id

Burahin ang isang Vinyl Figure task

Kinakansela ang isang Vinyl Figure task. Ang pagkansela sa isang PENDING na task ay nagre-refund ng mga credits nito. Ang isang IN_PROGRESS na task ay kinakansela nang walang refund, dahil may worker na nagsimula na dito. Ang isang task na may final status (SUCCEEDED, FAILED, o CANCELED) ay hindi na puwedeng kanselahin.

Dapat tumugma ang path sa stage ng task. Halimbawa, ang DELETE sa /prototype/:id gamit ang ID ng isang build task ay nagbabalik ng 404.

Request

DELETE

/openapi/creative-lab/vinyl-figure/v1/prototype/019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/prototype/019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 204 No Content on success (empty body).

Mga parameter ng path

Name
id
Type
path
Description
Ang ID ng task na kakanselahin.

Ibinabalik

204 No Content na may walang laman na body.

Mga mode ng pagkabigo

Name
400 - Bad Request
Description
Isa sa mga sumusunod ang naaangkop:
- Hindi valid na task ID ang id. Ipadala ang result ID mula sa create response.
- Mayroon nang final status ang task (SUCCEEDED, FAILED, o CANCELED), kaya hindi na ito puwedeng kanselahin.
Name
404 - Not Found
Description
Walang Vinyl Figure task na may ID na ito na kabilang sa account mo, o hindi tumutugma ang stage ng task sa path. Tingnan ang ID, at gamitin ang /prototype o /build para tumugma sa task.

GET/openapi/creative-lab/vinyl-figure/v1/(prototype|build)/:id/stream

Mag-stream ng Vinyl Figure task

Nagsa-stream ng mga update ng isang Vinyl Figure task bilang Server-Sent Events (SSE). Dapat tumugma ang path sa stage ng task. Kung hindi, halimbawa ang ID ng isang build task sa /prototype/:id/stream, magpapadala ang stream ng isang error event na may status_code: 404 at magsasara.

Request

GET

/openapi/creative-lab/vinyl-figure/v1/build/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/stream

curl -N https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example (wrong stage or task not found)
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// Every frame is the full task object; fields not yet populated are null / empty.
// The following PENDING frame is shortened to the fields that change.
event: message
data: {
  "id": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "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=***"
    }
  ]
}

Mga Parameter

Name
id
Type
path
Description
Ang task ID mula sa sagot ng paglikha (create response).

Ibinabalik

Isang stream ng prototype o build na mga task object. Bawat event ay naglalaman ng buong task object, tulad ng ibinabalik ng Kumuha ng Vinyl Figure task. Habang PENDING o IN_PROGRESS ang task, walang laman pa rin ang mga output field nito (null, [], o {}), at null ang finished_at.

Kung na-block ng IP Filtering ang resulta ng task, magpapadala ang stream ng isang error event sa halip nito, na may status_code na ibabalik sana ng isang get request.

GET/openapi/creative-lab/vinyl-figure/v1/(prototype|build)

I-list ang mga Vinyl Figure Task

Ibinabalik ang iyong mga Vinyl Figure task para sa isang stage, isang page sa bawat pagkakataon. Ang path ang pumipili ng stage. Ibinabalik ng /prototype ang mga prototype task lamang, at ibinabalik ng /build ang mga build task lamang.

Request

GET

/openapi/creative-lab/vinyl-figure/v1/prototype

# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/prototype?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response (List Prototype Tasks)

[
  {
    "id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de",
    "type": "creative-lab-vinyl-figure-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1752969600000,
    "started_at": 1752969604000,
    "finished_at": 1752969630000,
    "expires_at": 1753228830000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "image_urls": [
      "https://assets.meshy.ai/***/concept.png?Expires=***"
    ]
  }
]

Mga path parameter

Name
stage
Type
path
Kinakailangan
Description
Ang stage na ililista, prototype o build.

Mga query parameter

Name
page_num
Type
integer
default 1
Description
Ang page na ibabalik, mula 1 hanggang 255. Ang 0 ay nagbabalik ng unang page. Ang value na wala sa 0 hanggang 255 ay nagbabalik ng 400.
Name
page_size
Type
integer
default 10
Description
Bilang ng mga task kada page, hanggang 100. Ang value mula 101 hanggang 255 ay nagbabalik ng 100 task, at ang 0 ay gumagamit ng default. Ang value na wala sa 0 hanggang 255 ay nagbabalik ng 400.
Name
sort_by
Type
string
default -created_at
Description
Ang pagkakaayos ng pagsasaayos.
Mga magagamit na value:
- -created_at: pinakabago muna
- +created_at: pinakaluma muna

Ibinabalik

Isang array ng prototype task object o build task object, na tumutugma sa stage na nasa path.

Ang Vinyl Figure prototype task object

Ang isang prototype task ay gumagawa ng vinyl-figure-style na concept image mula sa isang larawan. Upang gawing 3D model ang larawan, ipasa ang ID ng task sa build endpoint bilang input_task_id.

Mga Property

Example Vinyl Figure Prototype Task Object

{
  "id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de",
  "type": "creative-lab-vinyl-figure-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1752969600000,
  "started_at": 1752969604000,
  "finished_at": 1752969630000,
  "expires_at": 1753228830000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Name
id
Type
string
Description
Ang task ID. Huwag umasa sa format nito.
Name
type
Type
string
Description
Ang uri ng task, palaging creative-lab-vinyl-figure-prototype.
Name
name
Type
string
Description
Ang name na ipinadala mo nang ginawa mo ang task, o "" kung wala kang ipinadala.
Name
status
Type
string
Description
Ang status ng task.
Mga magagamit na value:
- PENDING: naghihintay sa queue
- IN_PROGRESS: ginagawa ang resulta
- SUCCEEDED: pinal, may kasamang resulta
- FAILED: pinal, nasa task_error ang dahilan
- CANCELED: pinal, walang resulta
Name
progress
Type
integer
Description
Porsyento ng natapos na gawain, mula 0 hanggang 100. Ito ay 0 hangga't hindi pa nagsisimula ang task at 100 kapag ito ay nagtagumpay.
Name
created_at
Type
timestamp
Description
Oras na ginawa ang task, sa Unix milliseconds.
Name
started_at
Type
timestamp
Description
Oras na sinimulan ng isang worker ang task, sa Unix milliseconds. null hanggang sa mangyari ito.
Name
finished_at
Type
timestamp
Description
Oras na nakarating ang task sa pinal na status, sa Unix milliseconds. null hanggang sa mangyari ito.
Name
expires_at
Type
timestamp
Description
Oras na mag-e-expire ang resulta ng task, sa Unix milliseconds. Ito ay 3 araw pagkatapos ng finished_at, o 3 araw pagkatapos ng created_at hangga't hindi pa natatapos ang task. Para sa mga Enterprise account, na walang hanggang nagpapanatili ng mga resulta ng API, ito ay humigit-kumulang 100 taon mamaya. Tingnan ang Asset retention.
Name
preceding_tasks
Type
integer
Description
Ang posisyon ng task sa queue habang ito ay PENDING. Ang 1 ay nangangahulugang ito ang susunod na magsisimula. 0 kapag umalis na ang task sa queue, at palaging 0 sa mga resulta ng listahan.
Name
task_error
Type
object
Description
Kung bakit nabigo ang task. null maliban kung ang status ay FAILED. Tingnan ang Errors.
Name
consumed_credits
Type
integer
Description
Bilang ng mga credit na sinisingil para sa task, matapos ang anumang refund. Ang isang request na nagbabalik ng error ay hindi sinisingil. Ang isang nabigong task ay 0, dahil ini-refund ito ni Meshy. Ang pagkansela ay nagre-refund lamang ng isang task habang ito ay PENDING. Kung hindi mabasa ni Meshy ang singil, aalisin sa response ng get o stream ang field na ito, at ang list request ay magbabalik ng 500. Sa kasong iyon, subukan muli ang request.
Name
image_urls
Type
array of strings
Description
Mga download URL para sa concept image. May isang URL ang array matapos magtagumpay ang task, at walang laman hanggang sa mangyari ito.

Ang Vinyl Figure build task object

Ang build task ay bumubuo ng isang textured 3D vinyl figure mula sa isang matagumpay na prototype task. Ang mga field nitong model_urls, thumbnail_url, at texture_urls ay may parehong format tulad ng nasa Image to 3D task object.

Mga Property

Example Vinyl Figure Build Task Object

{
  "id": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef",
  "type": "creative-lab-vinyl-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1752969700000,
  "started_at": 1752969710000,
  "finished_at": 1752969735000,
  "expires_at": 1753228935000,
  "preceding_tasks": 0,
  "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=***"
    }
  ]
}

Name
id
Type
string
Description
Ang task ID. Huwag umasa sa format nito.
Name
type
Type
string
Description
Ang uri ng task, palaging creative-lab-vinyl-figure-build.
Name
name
Type
string
Description
Ang name na ipinadala mo nang ginawa mo ang task, o "" kung wala kang ipinadala.
Name
status
Type
string
Description
Ang status ng task.
Mga available na value:
- PENDING: naghihintay sa queue
- IN_PROGRESS: bumubuo ng resulta
- SUCCEEDED: final, may resulta
- FAILED: final, may dahilan sa task_error
- CANCELED: final, walang resulta
Name
progress
Type
integer
Description
Porsyento ng natapos na gawain, mula 0 hanggang 100. Ito ay 0 hanggang magsimula ang task at 100 kapag ito ay nagtagumpay.
Name
created_at
Type
timestamp
Description
Oras nang nagawa ang task, sa Unix milliseconds.
Name
started_at
Type
timestamp
Description
Oras nang sinimulan ng isang worker ang task, sa Unix milliseconds. null hanggang mangyari iyon.
Name
finished_at
Type
timestamp
Description
Oras nang narating ng task ang isang final status, sa Unix milliseconds. null hanggang mangyari iyon.
Name
expires_at
Type
timestamp
Description
Oras nang mag-eexpire ang resulta ng task, sa Unix milliseconds. Ito ay 3 araw pagkatapos ng finished_at, o 3 araw pagkatapos ng created_at hanggang matapos ang task. Para sa mga Enterprise account, na nagpapanatili ng mga resulta ng API nang walang hanggan, ito ay humigit-kumulang 100 taon mamaya. Tingnan ang Asset retention.
Name
preceding_tasks
Type
integer
Description
Ang posisyon ng task sa queue habang ito ay PENDING. Ang 1 ay nangangahulugang ito ang susunod na magsisimula. 0 kapag umalis na ang task sa queue, at palaging 0 sa mga list result.
Name
task_error
Type
object
Description
Kung bakit nabigo ang task. null maliban kung ang status ay FAILED. Tingnan ang Errors.
Name
consumed_credits
Type
integer
Description
Bilang ng mga credit na sinisingil para sa task, matapos ang anumang refund. Ang isang request na nagbabalik ng error ay hindi sinisingil. Ang isang nabigong task ay 0, dahil ire-refund ito ni Meshy. Ang pagkansela ay nagre-refund lamang ng task habang ito ay PENDING. Kung hindi mabasa ni Meshy ang singil, aalisin sa isang get o stream response ang field, at ang isang list request ay magbabalik ng 500. Sa kasong iyon, subukan muli ang request.
Name
prompt
Type
string
Description
Palaging "" para sa isang Vinyl Figure build task.
Name
negative_prompt
Type
string
Description
Palaging "" para sa isang Vinyl Figure build task, tulad ng prompt.
Name
texture_prompt
Type
string
Description
Palaging "" para sa isang Vinyl Figure build task, tulad ng prompt.
Name
texture_image_url
Type
string
Description
Palaging "" para sa isang Vinyl Figure build task, tulad ng prompt.
Name
model_urls
Type
object
Description
Mga download URL para sa 3D model, bilang isang textured GLB at bilang isang OBJ file na kasama ang MTL file nito.
- Name
  glb
  Type
  string
  Description
  Download URL para sa textured GLB file.
- Name
  obj
  Type
  string
  Description
  Download URL para sa OBJ file, kasama ang heometriya at mga UV.
- Name
  mtl
  Type
  string
  Description
  Download URL para sa MTL material file na kasabay ng obj. Gamitin ito kasama ang obj at ang texture sa texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
Download URL para sa preview image ng model.
Name
texture_urls
Type
array
Description
Ang mga texture map, bilang isang array na may isang object na naglalaman ng base color map.
- Name
  base_color
  Type
  string
  Description
  Download URL para sa base color map.