Creative Lab Keychain API

Gawing isang 3D-printable na keychain na may kulay na relief ang isang larawan sa dalawang yugto. Ang isang prototype task ay bumubuo ng isang de-kulay na concept image mula sa larawan. Ang isang build task ay ginagawang relief 3D model ang imaheng iyon, at ginagamit ang ID ng prototype task bilang input_task_id.

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

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

Create a Keychain prototype task

Gumagawa ng isang colorized na concept image mula sa isang larawan. Para 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 Keychain prototype task object.

Request

POST

/openapi/creative-lab/keychain/v1/prototype

# Stage 1: generate a colorized keychain concept image
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json; charset=utf-8' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>",
    "name_text": "Luna"
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

Halimbawa ng prototype

Magsimula sa isang pinagmulang larawan, pagkatapos ay bumuo ng prototype image na ginagamit ng yugto ng keychain build.

Source photo used as the Creative Lab Keychain input — Prototype input

Creative Lab Keychain prototype output generated from the source photo — Prototype output

Mga Parameter

Name
image_url
Type
string
Kinakailangan
Description
Ang larawang gagawing keychain concept image, bilang isang pampublikong URL o isang data URI (data:image/jpeg;base64,<your base64-encoded image data>).
Ang larawan ay dapat 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 babalik sa name field ng task. Ang mas mahabang pangalan ay nagbabalik ng 400.
Ito ay nagla-label sa task sa iyong dashboard at mga listahan ng task, at hindi lumalabas sa keychain. Para maglagay ng pangalan sa keychain, gamitin ang name_text.
Name
name_text
Type
string
Description
Isang pangalang idaragdag sa keychain, tulad ng pangalan ng isang alagang hayop o tao, hanggang 10 character. Binibilang ng Meshy ang mga character, hindi mga byte, kaya kasya ang 10-character na pangalan sa Chinese, Japanese, o Korean. Ang mas mahabang pangalan ay nagbabalik ng 400. Huwag isama ito para sa isang keychain na walang pangalan.
Ang pangalan ay lumalabas sa mukha ng keychain bilang isang patag na detalye na may kulay, hindi bilang nakausli o nakaukit na teksto.
Tinatanggal ng Meshy ang nakapalibot na whitespace at inaalis ang mga hindi nakikitang formatting character. Ang prototype task object ay nagbabalik ng resulta bilang name_text, para masuri mo ang teksto bago ka magbayad para sa build.
Idinaragdag ng Meshy ang pangalan sa yugto ng prototype. Pinananatili ito ng build, at binabalewala ang isang name_text na ipinadala sa build endpoint.
Kapag hindi plain ASCII ang teksto, ipadala ang request body bilang UTF-8 na may Content-Type: application/json; charset=utf-8. Ang ilang HTTP client, tulad ng Invoke-RestMethod ng Windows PowerShell, ay nag-e-encode ng body bilang ISO-8859-1 bilang default. Ginagawa nito ang bawat hindi-Latin na character na ? bago maabot ng request ang Meshy, at hindi maiiba ito ng Meshy sa isang pangalan na talagang gusto mong ipadala.
Name
remove_background
Type
boolean
default false
Description
Kung aalisin ang background mula sa prototype image. Ang true ay nagbabalik ng isang transparent RGBA PNG na pinapanatili ang buong medalyon, para mailagay mo ito sa anumang background. Ang build ay nagsisimula rin mula sa larawan na walang background nito. Kung hindi maalis ng Meshy ang background, ibabalik nito ang larawan kasama ang background nito, at magtatagumpay pa rin ang task.
Ang remove_background na opsyon ng build ay hiwalay.

Mga Ibinabalik

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

Mga Paraan 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 maximum na bilang ng pixel.
- Hindi ma-download ng Meshy ang larawan, halimbawa dahil ang URL ay nagbabalik ng 404 o nag-time out.
- Ang data URI ay hindi valid na base64.
- Ang name_text ay mas mahaba sa 10 character. Tinatanggihan ito ng Meshy sa halip na paikliin ito, at hindi sisingilin para sa request.
- Ang larawan o name_text ay na-flag bilang NSFW.
Ang mensahe ng error ay nagsasabi 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 ito ang nangyari:
- Ang account ay walang sapat na credits.
- Ang API key, workspace, o miyembro ay umabot sa limitasyon ng credit nito.
- Ang account ay nasa free plan.
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 ng Meshy ang larawan para sa third-party intellectual property. Magpadala ng larawan na may karapatan kang gamitin. Sinusuri lamang ng Meshy ang larawan para sa intellectual property, hindi ang name_text.
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 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 ang Meshy, halimbawa dahil hindi nito napatakbo ang pagsusuri ng intellectual property sa larawan. Hindi ginagawa ng Meshy ang task, at ibinabalik ang anumang credits na sinisingil nito. Subukang muli ang request.

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

Gumawa ng Keychain build task

Gumagawa ng 3D-printable na keychain mula sa isang matagumpay na prototype task. Binabago ng Meshy ang concept image ng prototype patungo sa depth-map relief, at nagbabalik ng isang model file sa format na pipiliin mo. Para sa mga field ng task, tingnan ang The Keychain build task object.

Request

POST

/openapi/creative-lab/keychain/v1/build

# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "options": {
      "badge_shape": "circle",
      "size_mm": 40,
      "relief_height_mm": 2.5
    },
    "output": {
      "format": "glb"
    }
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}

Build example

The build task converts the selected prototype image into a 3D-printable keychain model.

Creative Lab Keychain build model preview — Build model preview

Mga Parameter

Name
input_task_id
Type
string
Kinakailangan
Description
Ang ID ng prototype task na ibi-build. Dapat ito ay task na nilikha ng iyong account gamit ang POST /openapi/creative-lab/keychain/v1/prototype, na may status na SUCCEEDED.
Ang ID na hindi isa sa iyong mga Keychain prototype task mula sa API ay magbabalik ng 404, kasama na ang prototype na ginawa sa web app.
Name
name
Type
string
Description
Pangalan para sa task, hanggang 100 character. Babalik ito sa field na name ng task. Ang mas mahabang pangalan ay magbabalik ng 400.

`options`

Opsyonal na mga setting para sa hugis ng relief. Bawat field ay may default, kaya ipadala lamang ang mga gusto mong baguhin. Ang value na lampas sa range ng isang field ay magbabalik ng 400.

Name
badge_shape
Type
string
default circle
Description
Ang outline ng keychain kapag hindi ito tinrace ng Meshy mula sa subject. Ginagamit ito ng Meshy kapag remove_background ay false, o kapag hindi nito mahanap ang outline ng subject.
Mga available na value:
- circle
- rounded-rect
- hexagon
- shield
- star
Name
size_mm
Type
number
default 40
Description
Ang edge length ng bounding square ng keychain, sa millimeters, hanggang 400. Ginagamit ng 0 ang default.
Name
relief_height_mm
Type
number
default 2.2
Description
Ang pinakamataas na taas ng relief mula sa base, sa millimeters, mula 0 hanggang 20.
Name
relief_offset_mm
Type
number
default 0
Description
Kung gaano kalayo ibababa ang relief, sa millimeters, mula 0 hanggang 20. Ibinabawas ito ng Meshy sa taas ng relief sa lahat ng dako, hanggang sa base.
Name
base_thickness_mm
Type
number
default 0.1
Description
Ang kapal ng flat base plate sa likod ng relief, sa millimeters, mula 0 hanggang 20.
Name
has_closed_back
Type
boolean
default true
Description
Kung isasara ang likod ng keychain. Ang false ay nag-iiwan ng bukas na likod, bilang shell.
Name
relief_curve
Type
string
default linear
Description
Ang curve na nagma-map ng mga value ng depth-map sa taas ng relief.
Mga available na value:
- linear
- gamma
- s-curve
Name
curve_param
Type
number
default 1.0
Description
Ang lakas ng curve, hanggang 10. Ginagamit ito ng gamma at s-curve na curve, at hindi ito pinapansin ng linear. Ginagamit ng 0 ang default.
Name
invert_depth
Type
boolean
default false
Description
Kung ii-invert ang depth map, para ang mas madidilim na bahagi ay maging mas mataas na relief.
Name
smoothing
Type
number
default 0.24
Description
Gaano kapino ang depth map bago buuin ng Meshy ang relief, mula 0 hanggang 10.
Name
relief_scale
Type
number
default 1.0
Description
Gaano ka-zoom ang relief at ang texture nito sa loob ng outline, tungkol sa gitna, hanggang 10. Ang value na higit sa 1 ay nagpapalaki sa subject, at ang value na mas mababa sa 1 ay nagpapaliit dito. Hindi nito binabago ang taas ng relief. Ginagamit ng 0 ang default.
Name
depth_threshold
Type
number
default 0.1
Description
Ang value ng depth-map kung saan itinatakda ng Meshy ang depth sa zero, mula 0 hanggang 1.
Name
remove_background
Type
boolean
default true
Description
Kung tra-trace ang outline ng keychain mula sa subject, para ang keychain ay sumunod sa hugis ng subject. Ang false ay gumagamit ng badge_shape na outline sa halip. Ginagamit din ng Meshy ang badge_shape kapag hindi nito mahanap ang outline ng subject.
Hiwalay ito sa remove_background na parameter ng prototype, na nagtatakda kung ang prototype image ay may transparent na background.
Name
export_resolution
Type
integer
default 512
Description
Ang mesh resolution ng na-export na model, mula 64 hanggang 512. Binubuo ng Meshy ang heometriya mula sa 512-pixel na depth map, kaya ang mas pinong mesh ay magdaragdag ng mga face nang walang dagdag na detalye. Ginagamit ng 0 ang default.

`output`

Opsyonal. Itinatakda ang file format na ibabalik ng build.

Name
format
Type
string
default glb
Description
Ang file format na ibabalik ng build.
Mga available na value:
- glb: isang model.glb file, sa model_urls.glb
- obj: isang zip file na may model.obj, model.mtl, at texture.png, sa model_urls.obj
- zip: isang zip file na may bawat file na nililikha ng Meshy, sa model_urls.bundle_zip

Mga Ibabalik

Hawak ng field na result ang ID ng bagong build task. Kunin ang task o i-stream ito hanggang ang status ay SUCCEEDED. Pagkatapos, i-download ang file mula sa nag-iisang entry sa model_urls.

Mga Paraan ng Pagkabigo

Name
400 - Bad Request
Description
Hindi maaaring tumakbo 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.
- Ang isang field ng options ay nasa labas ng saklaw nito o hindi available na value.
Sinasabi ng error message kung aling problema ang nahanap nito.
Name
401 - Unauthorized
Description
Nawawala o hindi valid ang API key. Suriin ang Authorization header.
Name
402 - Payment Required
Description
Isa sa mga ito ang nangyari:
- Walang sapat na credits ang account.
- Umabot na ang API key, workspace, o member sa credit limit 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 Keychain prototype task na nilikha 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 paglikha ng prototype.
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 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/keychain/v1/(prototype|build)/:id

Kumuha ng Keychain task

Ibinabalik nito ang isang prototype o build task. Dapat tumugma ang path sa stage ng task. Ang build task na hiniling sa pamamagitan ng /prototype/:id ay magbabalik ng 404, at ganoon din ang prototype task na hiniling sa pamamagitan ng /build/:id.

Para sa mga field, tingnan ang The Keychain prototype task object at The Keychain build task object.

Request

GET

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

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

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

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-keychain-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-keychain-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,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}

Mga Parameter

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

Ibinabalik

Ang prototype task object o ang build task object, ayon 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 tugon ng paglikha (create response).
Name
403 - Forbidden
Description
Naka-on ang IP Filtering sa iyong team, at ni-flag ng Meshy ang larawan ng prototype task dahil sa intellectual property ng ibang partido. Hindi nakakakuha ng error na ito ang mga build task at mga team na nasa Enterprise plan. Gumawa ng prototype task gamit ang larawan na may karapatan kang gamitin.
Name
404 - Not Found
Description
Walang Keychain 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 para tumugma sa task.
Name
500 - Internal Server Error
Description
Hindi naisagawa ng Meshy ang pagsusuri ng intellectual property. Subukang muli ang request.

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

Tanggalin ang isang Keychain task

Kinakansela ang isang Keychain 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 nang nagsimula rito. Ang isang task na may huling status (SUCCEEDED, FAILED, o CANCELED) ay hindi maaaring kanselahin.

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

Request

DELETE

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

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/keychain/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 mode ng kabiguan

Name
400 - Bad Request
Description
Isa sa mga ito ang nangyayari:
- Ang id ay hindi isang wastong task ID. Ipadala ang result ID mula sa create response.
- Ang task ay mayroon nang huling status (SUCCEEDED, FAILED, o CANCELED), kaya hindi na ito maaaring kanselahin.
Name
404 - Not Found
Description
Walang Keychain 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/keychain/v1/(prototype|build)/:id/stream

I-stream ang isang Keychain task

Ini-stream ang mga update ng isang Keychain 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, nagpapadala ang stream ng isang error event na may status_code: 404 at isinasara ito.

Request

GET

/openapi/creative-lab/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream

curl -N https://api.meshy.ai/openapi/creative-lab/keychain/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-keychain-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}

Mga Parameter

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

Mga Ibinabalik

Isang stream ng mga prototype o build na task object. Bawat event ay may kumpletong task object, tulad ng ibinabalik ng Kumuha ng isang Keychain 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 ang IP Filtering ay humahadlang sa resulta ng task, nagpapadala ang stream ng isang error event sa lugar nito, kasama ang status_code na ibabalik sana ng isang get request.

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

List Keychain tasks

Ibinabalik ang iyong mga Keychain task ng isang yugto, isang pahina sa bawat pagkakataon. Ang path ang pumipili ng yugto. Ang /prototype ay nagbabalik lamang ng mga prototype task, at ang /build ay nagbabalik lamang ng mga build task.

Request

GET

/openapi/creative-lab/keychain/v1/prototype

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

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

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-keychain-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=***"
    ]
  }
]

Mga path parameter

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

Mga query parameter

Name
page_num
Type
integer
default 1
Description
Ang pahinang ibabalik, mula 1 hanggang 255. Ang 0 ay nagbabalik ng unang pahina. 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 kada pahina, hanggang 100. Ang isang value mula 101 hanggang 255 ay magbabalik ng 100 task, at ang 0 ay gagamit 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 pagkakaayos 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 yugto sa path.

Ang Keychain prototype task object

Ang isang prototype task ay bumubuo ng kulay na concept image mula sa isang larawan. Para gawing 3D model ang larawan, ipasa ang ID ng task sa build endpoint bilang input_task_id.

Mga Property

Example Keychain Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-keychain-prototype",
  "name": "",
  "name_text": "Luna",
  "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-keychain-prototype.
Name
name
Type
string
Description
Ang name na ipinadala mo nang ginawa mo ang task, o "" kung wala kang ipinadala.
Name
name_text
Type
string
Description
Ang pangalang idinagdag ni Meshy sa keychain, matapos alisin ang whitespace at ang mga invisible formatting character. Hindi isinasama kapag hindi mo ipinadala ang name_text. Para tiyakin na wasto ang pag-encode ng teksto ng iyong HTTP client, ikumpara ito sa ipinadala mo.
Name
status
Type
string
Description
Ang status ng task.
Mga available na halaga:
- PENDING: naghihintay sa queue
- IN_PROGRESS: ginagawa ang resulta
- SUCCEEDED: huli na, kasama ang resulta
- FAILED: huli na, nasa task_error ang dahilan
- CANCELED: huli na, walang resulta
Name
progress
Type
integer
Description
Porsyento ng natapos na gawain, mula 0 hanggang 100. 0 ito hangga't hindi pa nagsisimula ang task at 100 kapag nagtagumpay ito.
Name
created_at
Type
timestamp
Description
Oras nang gawin ang task, sa Unix milliseconds.
Name
started_at
Type
timestamp
Description
Oras nang simulan ng isang worker ang task, sa Unix milliseconds. null hanggang mangyari ito.
Name
finished_at
Type
timestamp
Description
Oras nang makarating ang task sa huling status, sa Unix milliseconds. null hanggang mangyari ito.
Name
expires_at
Type
timestamp
Description
Oras nang mag-e-expire ang resulta ng task, sa Unix milliseconds. 3 araw ito 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, mga 100 taon ito pagkalipas. 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 na ang susunod na magsisimula. 0 matapos umalis 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 credits 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 nire-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 isang get o stream response ang field, at ang isang list request ay magbabalik ng 500. Sa ganitong kaso, 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 mangyari ito.

Ang object ng keychain build task

Ang isang build task ay gumagawa ng 3D keychain mula sa isang matagumpay na prototype task. Nagbabalik ito ng isang model file sa format na hiniling mo.

Mga Property

Example Keychain Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-keychain-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,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}

Name
id
Type
string
Description
Ang task ID. Huwag umasa sa format nito.
Name
type
Type
string
Description
Ang uri ng task, laging creative-lab-keychain-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 magagamit na value:
- PENDING: naghihintay sa pila
- IN_PROGRESS: ginagawa ang resulta
- SUCCEEDED: huli na, mayroon nang resulta
- FAILED: huli na, nasa task_error ang dahilan
- CANCELED: huli na, walang resulta
Name
progress
Type
integer
Description
Porsyentong natapos sa trabaho, mula 0 hanggang 100. 0 ito hangga't hindi nagsisimula ang task at 100 kapag nagtagumpay ito.
Name
created_at
Type
timestamp
Description
Oras nang ginawa 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 naabot ng task ang huling status, sa Unix milliseconds. null hanggang mangyari iyon.
Name
expires_at
Type
timestamp
Description
Oras na mag-e-expire ang resulta ng task, sa Unix milliseconds. 3 araw ito 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 katapusan, mga 100 taon ito mamaya. Tingnan ang Asset retention.
Name
preceding_tasks
Type
integer
Description
Posisyon ng task sa pila habang PENDING ito. Ibig sabihin ng 1, susunod na itong magsisimula. 0 kapag umalis na ang task sa pila, at laging 0 sa mga resulta ng listahan.
Name
task_error
Type
object
Description
Dahilan 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. Hindi sinisingil ang isang request na nagbabalik ng error. 0 ang isang nabigong task, dahil irerefund ito ni Meshy. Ang pagkansela ay nagre-refund ng task lamang habang ito ay PENDING. Kung hindi mabasa ni Meshy ang singil, aalisin sa isang get o stream response ang field, at magbabalik ng 500 ang isang list request. Sa ganitong sitwasyon, subukan ulit ang request.
Name
model_urls
Type
object
Description
Mga download URL para sa model file, na may isang entry para sa output.format na hiniling mo. {} hanggang magtagumpay ang task.
- Name
  glb
  Type
  string
  Description
  Download URL para sa GLB file. Narito kapag glb ang output.format.
- Name
  obj
  Type
  string
  Description
  Download URL para sa isang zip file na may model.obj, model.mtl, at texture.png. Narito kapag obj ang output.format.
- Name
  bundle_zip
  Type
  string
  Description
  Download URL para sa isang zip file na may bawat file na ginawa ni Meshy. Narito kapag zip ang output.format.