Creative Lab Figure API

Gawing chibi-style na 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 naman ay ginagawang 3D model na may texture ang imaheng iyon, at kinukuha ang ID ng prototype task bilang input_task_id.

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

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

Create a Figure prototype task

Bumubuo ng isang chibi-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 Figure prototype task object.

Request

POST

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

# Stage 1: generate a chibi-style concept image
curl 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.

Source portrait used as the Creative Lab Figure input — Prototype input

Chibi-style figurine prototype image generated from the source photo — Prototype output

Mga Parameter

Name
image_url
Type
string
Kinakailangan
Description
Ang larawang gagawing chibi figure, bilang isang pampublikong URL o isang data URI (data:image/jpeg;base64,<your base64-encoded image data>).
Ang larawan ay dapat na isang 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. Ito ay ibabalik sa name field ng task. Ang mas mahabang pangalan ay magbabalik ng 400.
Name
remove_background
Type
boolean
default false
Description
Kung aalisin ang background mula sa prototype image. Ang true ay nagbabalik ng transparent na RGBA PNG, para maipwesto mo ang subject sa anumang background. Ang build ay nagsisimula rin mula sa larawan nang walang background nito. Kung hindi maalis ni Meshy ang background, ibabalik nito ang larawan kasama ang background nito, at magtatagumpay pa rin ang task.

Mga Ibabalik

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

Mga mode ng pagkabigo

Name
400 - Bad Request
Description
Hindi maaaring patakbuhin ang request. Halimbawa:
- Nawawala ang image_url.
- Ang larawan ay hindi isang JPG, JPEG, PNG, o WebP file.
- Ang larawan ay masyadong maliit, lampas 20 MB, o lampas sa pinakamataas na bilang ng pixel.
- Hindi ma-download ni Meshy ang larawan, halimbawa dahil ang URL ay nagbabalik ng 404 o nag-time out.
- Ang data URI ay hindi valid na base64.
- Na-flag ang larawan bilang NSFW.
Sinasabi ng mensahe ng error kung aling problema ang natagpuan nito. Ayusin ang request, pagkatapos ay ipadala itong muli.
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 nangyari:
- Walang sapat na credits ang account.
- Naabot na 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
403 - Forbidden
Description
Naka-on ang IP Filtering ng iyong team, at nag-flag si Meshy sa larawan dahil sa intellectual property ng third-party. Magpadala ng larawan na may karapatan kang gamitin.
Name
429 - Too Many Requests
Description
Naabot ang isa sa mga limitasyong ito:
- 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
Nakaranas si Meshy ng server error, halimbawa dahil hindi nito napatakbo ang intellectual property check sa larawan. Hindi gumagawa si Meshy ng task, at ibinabalik ang anumang credits na sinisingil nito. Subukan muli ang request.

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

Gumawa ng Figure build task

Gumagawa ng may-texture na 3D figure mula sa isang matagumpay na prototype task. Para sa mga field nito, tingnan ang The Figure build task object.

Request

POST

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

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

Ginagawa ng build task ang napiling prototype image upang maging isang ma-do-download na may-texture na 3D model.

Creative Lab Figure build model preview — Build model preview

Mga Parameter

Name
input_task_id
Type
string
Kinakailangan
Description
Ang ID ng prototype task na gagawing build. Kailangang isa itong task na nilikha ng iyong account gamit ang POST /openapi/creative-lab/figure/v1/prototype, na may status na SUCCEEDED.
Ang isang ID na hindi kabilang sa iyong mga Figure prototype task mula sa API ay magbabalik ng 404, kasama na ang isang 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 result field ay naglalaman ng ID ng bagong build task. Kunin ang task o i-stream ito hanggang ang status ay SUCCEEDED. Pagkatapos, i-download ang may-texture na 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 matatakbo 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.
- Nagtagumpay 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 nangyari:
- Hindi sapat ang credits ng account.
- Naabot ng API key, workspace, o miyembro ang limitasyon nito sa credit.
- Ang account ay nasa free plan.
Suriin ang iyong credits at plan, pagkatapos ay subukan muli.
Name
404 - Not Found
Description
Ang input_task_id ay hindi tumutugma sa anumang Figure prototype task na nilikha ng iyong account gamit ang API. Ang isang prototype na ginawa sa web app ay magbabalik din ng 404. Ipadala ang result ID mula sa isang prototype create response.
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 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.

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

Kunin ang gawain ng Figure

Nagbabalik ng prototype o build na gawain. Dapat tumugma ang path sa stage 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 object ng Figure prototype task at Ang object ng Figure build task.

Request

GET

/openapi/creative-lab/figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578

# Prototype
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-figure-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "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/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ],
  "remove_lighting": true
}

Mga Parameter

Name
id
Type
path
Description
Ang task ID mula sa create response.

Ibinabalik

Ang prototype task object o ang build task object, na tumutugma sa stage na nasa path.

Mga paraan ng pagkabigo

Name
400 - Bad Request
Description
Hindi valid na task ID ang id. Ipadala ang result ID mula sa create response.
Name
403 - Forbidden
Description
Naka-on ang IP Filtering sa iyong team, at na-flag ng Meshy ang larawan ng gawain dahil sa intellectual property ng third-party. Hindi nakukuha ng mga team na nasa Enterprise plan ang error na ito. Gumawa ng prototype task mula sa larawang may karapatan kang gamitin.
Name
404 - Not Found
Description
Walang Figure task na may ID na ito na kabilang sa iyong account, o hindi tumutugma ang stage ng gawain sa path. Suriin ang ID, at gamitin ang /prototype o /build para tumugma sa gawain.
Name
500 - Internal Server Error
Description
Hindi nagawa ng Meshy na patakbuhin ang pagsusuri ng intellectual property. Subukan muli ang request.

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

I-delete ang isang Figure task

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

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/figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

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

Mga path parameter

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

Ibinabalik

204 No Content na may walang laman na body.

Mga failure mode

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 makakansela.
Name
404 - Not Found
Description
Walang Figure task na may ID na ito na kabilang sa iyong account, o hindi tumutugma ang stage ng task sa path. Suriin ang ID, at gamitin ang /prototype o /build upang itugma sa task.

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

Mag-stream ng Figure task

Nagsa-stream ng mga update ng Figure task bilang Server-Sent Events (SSE). Dapat tumugma ang path sa stage ng task. Kung hindi ito tumugma, 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/figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream

curl -N https://api.meshy.ai/openapi/creative-lab/figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/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": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-figure-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ],
  "remove_lighting": true
}

Mga Parameter

Name
id
Type
path
Description
Ang task ID mula sa create response.

Ibinabalik

Isang stream ng prototype o build task objects. Bawat event ay may kumpletong task object, gaya ng ibinabalik ito ng Get a Figure task. Habang ang task ay PENDING o IN_PROGRESS, ang mga output field nito ay walang laman pa (null, [], o {}), at ang finished_at ay null.

Kung hinaharang 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/figure/v1/(prototype|build)

List Figure tasks

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

Request

GET

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

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

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

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-figure-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729123456000,
    "started_at": 1729123460000,
    "finished_at": 1729123486000,
    "expires_at": 1729382686000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "image_urls": [
      "https://assets.meshy.ai/***/concept.png?Expires=***"
    ]
  }
]

Path parameters

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

Query parameters

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

Ibinabalik

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

Ang Figure prototype task object

Ang isang prototype task ay gumagawa ng chibi-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 Katangian

Example Figure Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-figure-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "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-figure-prototype.
Name
name
Type
string
Description
Ang name na ipinadala mo noong ginawa mo ang task, o "" kung hindi ka nagpadala ng isa.
Name
status
Type
string
Description
Ang status ng task.
Mga available na value:
- PENDING: naghihintay sa queue
- IN_PROGRESS: ginagawa ang resulta
- SUCCEEDED: huli na, mayroon nang resulta
- FAILED: huli na, nakalagay ang dahilan sa task_error
- CANCELED: huli na, walang resulta
Name
progress
Type
integer
Description
Porsyento ng natapos na trabaho, mula 0 hanggang 100. Ito ay 0 hangga't hindi pa nagsisimula ang task at 100 kapag matagumpay ito.
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 oras na iyon.
Name
finished_at
Type
timestamp
Description
Oras na narating ng task ang huling status, sa Unix milliseconds. null hanggang sa oras na iyon.
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 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 pagkatapos. Tingnan ang Asset retention.
Name
preceding_tasks
Type
integer
Description
Ang posisyon ng task sa queue habang ito ay PENDING. Ang 1 ay nangangahulugang susunod na itong magsisimula. 0 pagkatapos umalis ng 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 FAILED ang status. Tingnan ang Errors.
Name
consumed_credits
Type
integer
Description
Bilang ng mga credits na sinisingil para sa task, pagkatapos ng anumang refund. Ang isang request na nagbabalik ng error ay hindi sinisingil. Ang isang nabigong task ay 0, dahil ini-refund ito ng Meshy. Ang pagkansela ay nagre-refund ng task lamang habang ito ay PENDING. Kung hindi mabasa ng Meshy ang singil, aalisin ng get o stream response ang field, at ang isang list request ay magbabalik ng 500. Sa kasong iyon, ulitin ang request.
Name
image_urls
Type
array of strings
Description
Mga download URL para sa concept image. May isang URL ang array pagkatapos magtagumpay ang task, at walang laman hanggang sa oras na iyon.

Ang Figure build task object

Ang isang build task ay bumubuo ng textured 3D 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 Figure Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "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/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ],
  "remove_lighting": true
}

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-figure-build.
Name
name
Type
string
Description
Ang name na ipinadala mo nang nilikha 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: ginagawa ang resulta
- SUCCEEDED: pinal, may 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 nagtagumpay ito.
Name
created_at
Type
timestamp
Description
Oras na nilikha ang task, sa Unix milliseconds.
Name
started_at
Type
timestamp
Description
Oras na sinimulan ng isang worker ang task, sa Unix milliseconds. null hanggang tuluyan itong magsimula.
Name
finished_at
Type
timestamp
Description
Oras na umabot ang task sa pinal na status, sa Unix milliseconds. null hanggang tuluyan itong matapos.
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 nagpapanatili ng mga resulta ng API nang walang hanggan, ito ay humigit-kumulang 100 taon pa mula ngayon. Tingnan ang Asset retention.
Name
preceding_tasks
Type
integer
Description
Ang posisyon ng task sa queue habang ito ay PENDING. Ang 1 ay nangangahulugang susunod na itong magsisimula. 0 kapag umalis na ang task sa queue, at palaging 0 sa mga resulta ng list.
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 credits na siningil para sa task, pagkatapos ng 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 ng task lamang 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 ito, subukang muli ang request.
Name
prompt
Type
string
Description
Palaging "" para sa isang Figure build task.
Name
negative_prompt
Type
string
Description
Palaging "" para sa isang Figure build task, tulad ng prompt.
Name
texture_prompt
Type
string
Description
Palaging "" para sa isang Figure build task, tulad ng prompt.
Name
texture_image_url
Type
string
Description
Palaging "" para sa isang Figure build task, tulad ng prompt.
Name
model_urls
Type
object
Description
Mga URL ng download para sa 3D model, bilang textured GLB at bilang OBJ file kasama ang MTL file nito.
- Name
  glb
  Type
  string
  Description
  URL ng download para sa textured na GLB file.
- Name
  obj
  Type
  string
  Description
  URL ng download para sa OBJ file, kasama ang heometriya at mga UV.
- Name
  mtl
  Type
  string
  Description
  URL ng download para sa MTL material file na kasama ng obj. Gamitin ito kasama ng obj at ng texture sa texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
URL ng download 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
  URL ng download para sa base color map.
Name
remove_lighting
Type
boolean
Description
Kung inalis ni Meshy ang mga highlight at anino mula sa base color texture.