Creative Lab Collapsible Fidget API

Gawing print-in-place na collapsible fidget toy ang isang larawan sa isang task lamang. Ang silhouette ng subject ay nagiging nested na concentric rings na kumukupos nang patag at muling umuunat. Ini-print ang laruan nang isang piraso, nang walang pangangailangang i-assemble.

POST /openapi/creative-lab/fidget-collapsible/v1

Hindi tulad ng ibang Creative Lab endpoints, wala itong hiwalay na prototype at build stages. Walang mga candidate image na pagpipilian, kaya iisang task lang ang kumukumbert sa larawan patungo sa 3D model.

Wala ring mga heometriya settings ang request. Sa web app, maaari mong itakda ang laki, bilang ng layer, lapad ng gap, kapal ng dingding, lalim ng extrusion, at bulge. Ginagamit ng bawat API task ang parehong default na mga value para sa mga ito.

POST/openapi/creative-lab/fidget-collapsible/v1

Gumawa ng Collapsible Fidget task

Gumagawa ng collapsible fidget model mula sa isang larawan. Para sa mga field ng task, tingnan ang The Collapsible Fidget task object.

Ang bawat task ay nagkakahalaga ng 6 credits at nangangailangan ng paid plan.

Request

POST

/openapi/creative-lab/fidget-collapsible/v1

curl https://api.meshy.ai/openapi/creative-lab/fidget-collapsible/v1 \
  -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"
}

Mga Parameter

Name
image_url
Type
string
Kinakailangan
Description
Ang larawang gagawing collapsible fidget, 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.
Ang silweta ng subject ay nagiging mga singsing, kaya't ang isang subject na may isang malinaw, saradong outline ang pinakamainam. Ang isang abalang background, ilang magkakahiwalay na subject, o napakanipis na hugis ay maaaring mag-iwan ng masyadong kaunting espasyo para sa mga nested wall. Sa ganitong pagkakataon, nabibigo ang task.
Name
name
Type
string
Description
Isang pangalan para sa task, hanggang 100 karakter. Ito ay ibinabalik sa name field ng task, at hindi ito inuukit ni Meshy sa model. Ang isang mas mahabang pangalan ay nagbabalik ng 400.

Mga Ibinabalik

Ang result field ay naghahawak ng ID ng bagong task. Kunin ang task o i-stream ito hanggang ang status ay maging SUCCEEDED. Pagkatapos, i-download ang printable STL file mula sa model_urls.stl. Upang unang mapreview ang model, i-download ang GLB file mula sa model_urls.glb kapag ito ay naroroon.

Mga mode ng kabiguan

Name
400 - Bad Request
Description
Hindi matatakbo ang request. Halimbawa:
- Nawawala ang image_url.
- Ang larawan ay hindi isang JPG, JPEG, PNG, o WebP file.
- Ang larawan ay masyadong maliit, lampas sa 20 MB, o lampas sa maximum 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 wastong base64.
- Ang larawan ay na-flag bilang NSFW.
Sinasabi ng mensahe ng error kung aling problema ang nakita nito. Ayusin ang request, pagkatapos ay ipadala itong muli.
Name
401 - Unauthorized
Description
Nawawala o hindi wasto ang API key. Suriin ang Authorization header.
Name
402 - Payment Required
Description
Isa sa mga sumusunod ang nangyayari:
- Ang account ay walang sapat na credits.
- Naabot ng API key, workspace, o member ang limitasyon nito sa credits.
- 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 nai-flag ni Meshy ang larawan dahil sa third-party intellectual property. Magpadala ng larawan na may karapatan kang gamitin.
Name
429 - Too Many Requests
Description
Isa sa mga limitasyong ito ang naabot:
- Nagpadala ka ng higit pang mga 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 nasa 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
Nakaranas si Meshy ng server error, halimbawa dahil hindi nito matakbo ang intellectual property check sa larawan. Hindi gumagawa si Meshy ng task, at ibinabalik ang anumang credits na singil nito. Subukan muling ipadala ang request.

GET/openapi/creative-lab/fidget-collapsible/v1/:id

Kunin ang katayuan ng isang Collapsible Fidget task

Nagbabalik ng isang Collapsible Fidget task. Mga task lamang na ginawa gamit ang endpoint na ito ang ibinabalik. Ang isang task mula sa ibang Creative Lab endpoint, o isang nilikha sa web app, ay nagbabalik ng 404.

Para sa mga field, tingnan ang Ang Collapsible Fidget task object.

Request

GET

/openapi/creative-lab/fidget-collapsible/v1/018a210d-8ba4-705c-b111-1f1776f7f578

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-fidget-collapsible",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123512000,
  "expires_at": 1729382712000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  }
}

Mga Parameter

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

Ibinabalik

Ang Collapsible Fidget task object.

Mga mode ng kabiguan

Name
400 - Bad Request
Description
Ang id ay hindi isang wastong task ID. Ipadala ang result ID mula sa sagot ng create.
Name
403 - Forbidden
Description
Naka-on ang IP Filtering ng iyong team, at nilagyan ng flag ng Meshy ang imahe ng task dahil sa intelektwal na ari-arian ng ikatlong partido. Hindi nararanasan ng mga team na nasa Enterprise plan ang error na ito. Gumawa ng task mula sa isang imahe na may karapatan kang gamitin.
Name
404 - Not Found
Description
Walang Collapsible Fidget task na may ID na ito na kabilang sa iyong account, o hindi nilikha ang task gamit ang endpoint na ito. Suriin ang ID.
Name
500 - Internal Server Error
Description
Hindi magawa ng Meshy na patakbuhin ang pagsusuri ng intelektwal na ari-arian. Subukang muli ang request.

DELETE/openapi/creative-lab/fidget-collapsible/v1/:id

Burahin ang isang Collapsible Fidget task

Kinakansela ang isang Collapsible Fidget task. Ang pagkansela ng isang PENDING task ay nagbabalik ng mga credits nito. Ang isang IN_PROGRESS task ay kinakansela nang walang refund, dahil nagsimula na itong iproseso ng isang worker. Ang isang task na may final status (SUCCEEDED, FAILED, o CANCELED) ay hindi na maaaring kanselahin.

Request

DELETE

/openapi/creative-lab/fidget-collapsible/v1/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/fidget-collapsible/v1/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 ikakansela.

Ibinabalik

204 No Content na may walang laman na body.

Mga mode ng kabiguan

Name
400 - Bad Request
Description
Isa sa mga sumusunod ang nangyari:
- Ang id ay hindi isang valid na task ID. Ipadala ang result ID mula sa create response.
- Ang task ay mayroon nang final status (SUCCEEDED, FAILED, o CANCELED), kaya hindi na ito maaaring kanselahin.
Name
404 - Not Found
Description
Walang Collapsible Fidget task na may ID na ito na kabilang sa iyong account, o ang task ay hindi ginawa gamit ang endpoint na ito. Suriin ang ID.

GET/openapi/creative-lab/fidget-collapsible/v1/:id/stream

I-stream ang isang Collapsible Fidget task

Nagsa-stream ng mga update ng isang Collapsible Fidget task bilang Server-Sent Events (SSE). Kung hindi umiiral ang task o hindi ito ginawa gamit ang endpoint na ito, magpapadala ang stream ng isang error event na may status_code: 404 at magsasara.

Request

GET

/openapi/creative-lab/fidget-collapsible/v1/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/creative-lab/fidget-collapsible/v1/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example (task not found, or not created through this endpoint)
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": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-fidget-collapsible",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123512000,
  "expires_at": 1729382712000,
  "task_error": null,
  "consumed_credits": 6,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  }
}

Mga Parameter

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

Ibinabalik

Isang stream ng mga Collapsible Fidget task object. Bawat event ay may kumpletong task object, kung paano ito ibinabalik ng Kunin ang isang Collapsible Fidget task. Habang ang task ay PENDING o IN_PROGRESS, ang mga output field nito ay wala pa rin laman (null, [], o {}), at ang finished_at ay null.

Kung hinarangan ng IP Filtering ang resulta ng task, magpapadala ang stream ng isang error event bilang kapalit, na may status_code na ibabalik ng isang get request.

GET/openapi/creative-lab/fidget-collapsible/v1

Ilista ang mga Collapsible Fidget task

Ibinabalik ang iyong mga Collapsible Fidget task, isang pahina sa bawat pagkakataon. Ang mga task lamang na nilikha gamit ang endpoint na ito ang kasama.

Request

GET

/openapi/creative-lab/fidget-collapsible/v1

curl https://api.meshy.ai/openapi/creative-lab/fidget-collapsible/v1?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-fidget-collapsible",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729123456000,
    "started_at": 1729123460000,
    "finished_at": 1729123512000,
    "expires_at": 1729382712000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
      "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
    }
  }
]

Mga parameter ng query

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 value na 101 hanggang 255 ay magbabalik 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 pagkakasunud-sunod ng pag-uuri.
Mga available na value:
- -created_at: pinakabago muna
- +created_at: pinakaluma muna

Ibinabalik

Isang array ng Collapsible Fidget task objects.

Ang Collapsible Fidget task object

Ang isang Collapsible Fidget task ay nagko-convert ng larawan patungo sa isang print-in-place na collapsible fidget model. Ito ay isang single-stage task, kaya walang prototype task na pagmumulan nito. Hindi kasama sa response ang silhouette na ginagawa ni Meshy sa proseso.

Mga Property

Example Collapsible Fidget Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-fidget-collapsible",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123512000,
  "expires_at": 1729382712000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?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-fidget-collapsible.
Name
name
Type
string
Description
Ang name na ipinadala mo nang likhain 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: final, kasama ang resulta
- FAILED: final, kasama ang dahilan sa task_error
- CANCELED: final, walang resulta
Name
progress
Type
integer
Description
Porsiyento ng natapos na trabaho, mula 0 hanggang 100. Ito ay 0 hanggang magsimula ang task at 100 kapag nagtagumpay.
Name
created_at
Type
timestamp
Description
Oras kung kailan nalikha ang task, sa Unix milliseconds.
Name
started_at
Type
timestamp
Description
Oras kung kailan sinimulan ng isang worker ang task, sa Unix milliseconds. null hanggang sa oras na iyon.
Name
finished_at
Type
timestamp
Description
Oras kung kailan narating ng task ang final status, sa Unix milliseconds. null hanggang sa oras na iyon.
Name
expires_at
Type
timestamp
Description
Oras kung kailan 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 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 ito ang susunod na magsisimula. 0 pagkatapos umalis ng task sa queue, at laging 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 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 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 ng get o stream response ang field na ito, at magbabalik ang isang list request ng 500. Sa ganitong sitwasyon, subukan muli ang request.
Name
model_urls
Type
object
Description
Mga download URL para sa 3D model, walang laman hanggang magtagumpay ang task. Ang isang matagumpay na task ay laging may stl, at may glb lamang kung na-render ni Meshy ang preview.
- Name
  stl
  Type
  string
  Description
  Download URL para sa STL file, na siyang file na ipi-print. Maaari mo itong buksan nang direkta sa isang slicer.
- Name
  glb
  Type
  string
  Description
  Download URL para sa isang GLB file upang i-preview ang model sa isang 3D viewer. Ang mga kulay nito ay para lamang sa preview. Ang STL file ay walang kulay, kaya ang kulay ng naka-print na fidget ay mula sa filament.
  Kung hindi ma-render ni Meshy ang preview, ang model_urls ay walang glb key, kaya suriin muna ang key bago ito basahin. Ang isang SUCCEEDED na task ay laging may stl.