Creative Lab — Brick Figure API

Gawing isang brick-style collectible 3D minifigure ang isang source photo sa pamamagitan ng dalawang yugto: prototype na bumubuo ng isang styled concept image mula sa iyong input photo, pagkatapos ay build na nagiging isang textured 3D model ang concept image na iyon. Ang dalawang yugto ay konektado sa pamamagitan ng input_task_id.

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

Gumawa ng Brick Figure Prototype Task

Bumuo ng isang brick-style na konsepto ng imahe mula sa source na larawan. Ang ibinalik na task ID ay ang ipapasa mo bilang input_task_id sa build endpoint. Sumangguni sa The Brick Figure Prototype Task Object para sa hugis ng tugon.

Mga Parameter

  • Name
    image_url
    Type
    string
    Kinakailangan
    Description

    Source na larawan para sa Meshy upang gawing istilong brick minifigure. Kasalukuyan naming sinusuportahan ang mga format na .jpg, .jpeg, .png, at .webp.

    May dalawang paraan upang ibigay ang imahe:

    • Publicly accessible URL: Isang URL na naa-access mula sa pampublikong internet.
    • Data URI: Isang base64-encoded na data URI ng imahe. Halimbawa ng isang data URI: data:image/jpeg;base64,<your base64-encoded image data>.
  • Name
    name
    Type
    string
    Description

    Opsyonal na pangalan ng task para sa pagpapakita. Maximum na 100 karakter.

  • Name
    remove_background
    Type
    boolean
    default false
    Description

    Kapag nakatakda sa true, ang prototype na imahe ay ibinabalik bilang isang transparent na RGBA PNG na may tinanggal na background, upang maaari mong i-composite ang paksa sa anumang background.

Mga Ibinabalik

Ang result na property ng tugon ay naglalaman ng task id ng bagong likhang brick figure prototype task. I-poll ang Get a Task endpoint o mag-subscribe sa stream hanggang ang task ay umabot sa SUCCEEDED, pagkatapos ay ipasa ang ID na iyon sa build endpoint bilang input_task_id.

Mga Paraan ng Pagkabigo

  • Name
    400 - Bad Request
    Description

    Ang kahilingan ay hindi katanggap-tanggap. Karaniwang mga sanhi:

    • Missing parameter: Kinakailangan ang image_url.
    • Invalid image format: Ang ibinigay na image_url ay hindi suportadong format (.jpg, .jpeg, .png, .webp).
    • Image dimensions out of range: Ang imahe ay masyadong maliit, lumampas sa maximum na laki ng file, o lumampas sa maximum na bilang ng pixel.
    • Unreachable URL: Ang image_url ay hindi ma-download (404 o timeout).
    • Invalid Data URI: Ang base64 string ay hindi tama ang pagkakabuo.
    • Content flagged: Ang input na imahe ay na-flag ng NSFW moderation.
  • Name
    401 - Unauthorized
    Description

    Nabigo ang authentication. Pakisuri ang iyong API key.

  • Name
    402 - Payment Required
    Description

    Hindi sapat ang credits upang isagawa ang task na ito.

  • Name
    403 - Forbidden
    Description

    Ang input na imahe ay na-flag para sa paglabag sa karapatang-ari.

  • Name
    429 - Too Many Requests
    Description

    Naabot mo na ang iyong rate limit.

Request

POST
/openapi/creative-lab/brick-figure/v1/prototype
# Stage 1: generate a brick-style concept image
curl https://api.meshy.ai/openapi/creative-lab/brick-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"
}
POST/openapi/creative-lab/brick-figure/v1/build

Gumawa ng Brick Figure Build Task

Bumuo ng huling 3D brick figure na may texture mula sa isang matagumpay na prototype task. Ang build ay gumagamit ng parehong image-to-3D pipeline gaya ng Image to 3D, kaya't ang format ng response object at ang listahan ng output URLs ay eksaktong magkatugma. Sumangguni sa The Brick Figure Build Task Object para sa hugis ng tugon.

Mga Parameter

  • Name
    input_task_id
    Type
    string
    Kinakailangan
    Description

    Ang task ID ng isang prototype task na ginawa sa pamamagitan ng parehong OpenAPI endpoint na ito. Ang prototype ay dapat na nalikha gamit ang parehong API key, dapat na umabot sa SUCCEEDED, at dapat na nakagawa ng eksaktong isang candidate image.

    Ang mga prototype task na ginawa sa pamamagitan ng webapp ay hindi tinatanggap — ang build endpoint ay tumatanggap lamang ng mga prototype task na ginawa ng POST /openapi/creative-lab/brick-figure/v1/prototype at tinatanggihan ang anumang ibang pinagmulan gamit ang 404.

  • Name
    name
    Type
    string
    Description

    Opsyonal na pangalan ng task para sa layuning pagpapakita. Maximum na 100 karakter.

Mga Ibinabalik

Ang result na property ng tugon ay naglalaman ng task id ng bagong likhang brick figure build task. I-poll ang Get a Task endpoint o mag-subscribe sa stream hanggang sa maabot ng task ang SUCCEEDED, pagkatapos ay i-download ang textured GLB mula sa model_urls.glb (o ang OBJ + MTL na pares mula sa model_urls.obj at model_urls.mtl kung mas gusto ng iyong downstream pipeline ang OBJ).

Mga Mode ng Pagkabigo

  • Name
    400 - Bad Request
    Description

    Ang kahilingan ay hindi katanggap-tanggap. Karaniwang mga sanhi:

    • Nawawalang parameter: Kinakailangan ang input_task_id.
    • Hindi wastong UUID: Ang input_task_id ay hindi wastong UUID.
    • Hindi pa matagumpay ang magulang: Ang tinutukoy na prototype task ay hindi pa umabot sa SUCCEEDED.
    • Walang kandidato: Ang prototype task ay nagtagumpay ngunit walang nagawang candidate image.
  • Name
    401 - Unauthorized
    Description

    Nabigo ang authentication. Pakisuri ang iyong API key.

  • Name
    402 - Payment Required
    Description

    Kulang ang credits upang maisagawa ang task na ito.

  • Name
    404 - Not Found
    Description

    Ang tinutukoy na prototype task ay hindi umiiral, pag-aari ng ibang user, o ginawa sa pamamagitan ng webapp (tanging mga API-mode prototype task lamang ang nagcha-chain sa build).

  • Name
    429 - Too Many Requests
    Description

    Naabot mo na ang iyong rate limit.

Request

POST
/openapi/creative-lab/brick-figure/v1/build
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/brick-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"
}
GET/openapi/creative-lab/brick-figure/v1/(prototype|build)/:id

Kunin ang Isang Brick Figure Task

Kunin ang isang prototype o build task gamit ang isang wastong task id. Ang URL path ay dapat tumugma sa yugto ng task — ang isang build task na kinuha sa pamamagitan ng /prototype/:id ay magbabalik ng 404, at kabaligtaran.

Sumangguni sa The Brick Figure Prototype Task Object at The Brick Figure Build Task Object para sa mga hugis ng tugon.

Mga Parameter

  • Name
    id
    Type
    path
    Description

    Natatanging tagatukoy para sa brick figure task na kukunin.

Mga Ibinabalik

Ang tugon ay naglalaman ng brick figure task object. Ang hugis ay nakadepende sa kung aling yugto ang hiniling.

Request

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

# Build
curl https://api.meshy.ai/openapi/creative-lab/brick-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-brick-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-brick-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=***"
    }
  ]
}
DELETE/openapi/creative-lab/brick-figure/v1/(prototype|build)/:id

Tanggalin ang Brick Figure Task

Kanselahin ang isang brick figure task. Kung ang task ay nasa PENDING pa, ang credits na nagamit sa oras ng paglikha ay ibabalik. Ang mga task na nasa IN_PROGRESS ay kinansela nang walang refund (maaaring gumagamit na ang worker ng resources). Ang mga task na nakarating na sa terminal state (SUCCEEDED, FAILED, CANCELED) ay hindi na maaaring kanselahin.

Ang URL path ay dapat tumugma sa yugto ng task — ang DELETE sa /prototype/:buildId ay nagbabalik ng 404.

Mga Parameter ng Path

  • Name
    id
    Type
    path
    Description

    Natatanging identifier para sa brick figure task na kakanselahin.

Mga Ibinabalik

Nagbabalik ng 204 No Content sa tagumpay na may walang laman na katawan.

Mga Mode ng Pagkabigo

  • Name
    400 - Bad Request
    Description

    Ang task ay nasa terminal state na at hindi na maaaring kanselahin.

  • Name
    404 - Not Found
    Description

    Ang task ay hindi umiiral, pag-aari ng ibang user, o ang yugto nito ay hindi tumutugma sa URL path.

Request

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

Response

// Returns 204 No Content on success (empty body).
GET/openapi/creative-lab/brick-figure/v1/(prototype|build)/:id/stream

I-stream ang Gawain ng Brick Figure

I-stream ang mga real-time na update para sa isang gawain ng brick figure sa pamamagitan ng Server-Sent Events (SSE). Ang URL path ay dapat tumugma sa yugto ng gawain — ang pagbubukas ng stream sa /prototype/:buildId/stream ay maglalabas ng isang event: error payload na may status_code: 404 at isasara ang stream.

Mga Parameter

  • Name
    id
    Type
    path
    Description

    Natatanging pagkakakilanlan para sa gawain ng brick figure na i-stream.

Mga Ibinabalik

Nagbabalik ng stream ng mga bagay ng Brick Figure Prototype o Brick Figure Build na gawain bilang Server-Sent Events. Para sa mga PENDING o IN_PROGRESS na gawain, ang tugon na stream ay maglalaman lamang ng kinakailangang mga field na progress at status.

Request

GET
/openapi/creative-lab/brick-figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream
curl -N https://api.meshy.ai/openapi/creative-lab/brick-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.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
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-brick-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=***"
    }
  ]
}
GET/openapi/creative-lab/brick-figure/v1/(prototype|build)

Listahan ng mga Gawain ng Brick Figure

Kumuha ng isang listahan na may pagination ng iyong mga gawain sa brick figure para sa isang yugto. Ang URL path ay pumipili ng yugto — /prototype ay nagbabalik ng mga gawain sa prototype; /build ay nagbabalik ng mga gawain sa build. Ang mga gawain mula sa ibang yugto ay hindi kasama sa alinmang tugon.

Mga Parameter ng Path

  • Name
    stage
    Type
    path
    Kinakailangan
    Description

    Alinman sa prototype o build. Ang koleksyon ay nagbabalik lamang ng mga gawain na ang yugto ay tumutugma sa URL — ang pagkuha ng /prototype ay hindi kailanman nagbabalik ng mga gawain sa build at kabaligtaran.

Mga Parameter ng Query

  • Name
    page_num
    Type
    integer
    default 1
    Description

    Numero ng pahina para sa pagination.

  • Name
    page_size
    Type
    integer
    default 10
    Description

    Limitasyon ng laki ng pahina. Ang pinakamataas na pinapayagan ay 100 na item.

  • Name
    sort_by
    Type
    string
    default -created_at
    Description

    Patlang na pagbabatayan ng pagkakasunod-sunod. Mga magagamit na halaga:

    • +created_at: Pagbukud-bukurin ayon sa oras ng paglikha sa pataas na pagkakasunod-sunod.
    • -created_at: Pagbukud-bukurin ayon sa oras ng paglikha sa pababang pagkakasunod-sunod.

Mga Ibinabalik

Nagbabalik ng isang listahan na may pagination ng bawat-yugtong task object — alinman ang brick figure prototype task object kapag naglilista ng /prototype o ang brick figure build task object kapag naglilista ng /build.

Request

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

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

Response (Listahan ng Mga Gawain sa Prototype)

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

Ang Brick Figure Prototype Task Object

Ang Brick Figure Prototype Task object ay isang yunit ng trabaho na sinusubaybayan ng Meshy upang makabuo ng isang brick-style na konsepto ng imahe mula sa isang source na larawan. Ang output ng yugtong ito ay nakakadena sa yugto ng pagbuo sa pamamagitan ng input_task_id.

Mga Katangian

  • Name
    id
    Type
    string
    Description

    Natatanging pagkakakilanlan para sa gawain. Habang gumagamit kami ng k-sortable UUID para sa mga task id bilang detalye ng pagpapatupad, hindi ka dapat gumawa ng anumang mga pagpapalagay tungkol sa format ng id.

  • Name
    type
    Type
    string
    Description

    Uri ng gawain. Ang halaga ay creative-lab-brick-figure-prototype.

  • Name
    name
    Type
    string
    Description

    Ang pangalan ng gawain na ibinigay noong nilikha ang gawain. Walang laman na string kung walang ibinigay na pangalan.

  • Name
    status
    Type
    string
    Description

    Katayuan ng gawain. Ang mga posibleng halaga ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    progress
    Type
    integer
    Description

    Pag-unlad ng gawain. Kung ang gawain ay hindi pa nasisimulan, ang katangiang ito ay magiging 0. Kapag ang gawain ay nagtagumpay, ito ay magiging 100.

  • Name
    created_at
    Type
    timestamp
    Description

    Timestamp kung kailan nilikha ang gawain, sa milliseconds.

    Ang timestamp ay kumakatawan sa bilang ng milliseconds na lumipas mula Enero 1, 1970 UTC, alinsunod sa RFC 3339 na pamantayan. Halimbawa, Biyernes, Setyembre 1, 2023 12:00:00 PM GMT ay kinakatawan bilang 1693569600000. Ito ay naaangkop sa lahat ng mga timestamp sa Meshy API.

  • Name
    started_at
    Type
    timestamp
    Description

    Timestamp kung kailan sinimulan ang gawain, sa milliseconds. Kung ang gawain ay hindi pa nasisimulan, ang katangiang ito ay magiging null.

  • Name
    finished_at
    Type
    timestamp
    Description

    Timestamp kung kailan natapos ang gawain, sa milliseconds. Kung ang gawain ay hindi pa natatapos, ang katangiang ito ay magiging null.

  • Name
    expires_at
    Type
    timestamp
    Description

    Timestamp kung kailan mag-e-expire ang resulta ng gawain, sa milliseconds.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Ang bilang ng mga naunang gawain.

    Ang halaga ng field na ito ay makabuluhan lamang kung ang katayuan ng gawain ay PENDING.

  • Name
    task_error
    Type
    object
    Description

    Mga detalye ng error para sa mga nabigong gawain. Tingnan ang Errors para sa buong task_error na object na sanggunian.

  • Name
    consumed_credits
    Type
    integer
    Description

    Ang bilang ng credits na nagamit ng gawain na ito. Kasalukuyan kapag ang katayuan ng gawain ay PENDING, IN_PROGRESS, o SUCCEEDED. Nagbabalik ng 0 para sa mga FAILED na gawain (ang credits ay naibabalik kapag nabigo).

  • Name
    image_urls
    Type
    array of strings
    Description

    Mga maida-download na URL para sa mga kandidato ng konsepto ng imahe na nabuo ng prototype na gawain na ito. Sa kasalukuyan, ang API ay palaging nagbabalik ng eksaktong isang kandidato; ang field ay isang array kaya ang mga susunod na bersyon ay maaaring magpakita ng maraming kandidato nang hindi nagkakaroon ng breaking change.

Example Brick Figure Prototype Task Object

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

Ang Objek ng Tungkulin sa Pagbuo ng Brick Figure

Ang objek ng Tungkulin sa Pagbuo ng Brick Figure ay isang yunit ng trabaho na sinusubaybayan ng Meshy upang makabuo ng isang may texture na 3D brick figure mula sa isang matagumpay na prototype na tungkulin. Ito ay nagpapatakbo ng parehong image-to-3D pipeline na ginagamit ng Image to 3D, kaya't ang mga output na field ay sumasalamin sa endpoint ng task object.

Mga Katangian

  • Name
    id
    Type
    string
    Description

    Natatanging pagkakakilanlan para sa tungkulin.

  • Name
    type
    Type
    string
    Description

    Uri ng tungkulin. Ang halaga ay creative-lab-brick-figure-build.

  • Name
    name
    Type
    string
    Description

    Ang pangalan ng tungkulin na ibinigay noong nilikha ang tungkulin. Walang laman na string kung walang ibinigay na pangalan.

  • Name
    status
    Type
    string
    Description

    Katayuan ng tungkulin. Ang mga posibleng halaga ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    progress
    Type
    integer
    Description

    Pag-unlad ng tungkulin. Kung ang tungkulin ay hindi pa nasisimulan, ang property na ito ay magiging 0. Kapag ang tungkulin ay nagtagumpay, ito ay magiging 100.

  • Name
    created_at
    Type
    timestamp
    Description

    Timestamp kung kailan nilikha ang tungkulin, sa milliseconds.

  • Name
    started_at
    Type
    timestamp
    Description

    Timestamp kung kailan sinimulan ang tungkulin, sa milliseconds.

  • Name
    finished_at
    Type
    timestamp
    Description

    Timestamp kung kailan natapos ang tungkulin, sa milliseconds.

  • Name
    expires_at
    Type
    timestamp
    Description

    Timestamp kung kailan mag-e-expire ang resulta ng tungkulin, sa milliseconds.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Ang bilang ng mga naunang tungkulin. Makabuluhan lamang kapag ang status ay PENDING.

  • Name
    task_error
    Type
    object
    Description

    Mga detalye ng error para sa mga nabigong tungkulin. Tingnan ang Errors para sa buong sanggunian ng task_error object.

  • Name
    consumed_credits
    Type
    integer
    Description

    Ang bilang ng mga credits na nagamit ng tungkuling ito. Nagbabalik ng 0 para sa mga FAILED na tungkulin (ang mga credits ay ibinabalik kapag nabigo).

  • Name
    prompt
    Type
    string
    Description

    Palaging walang laman para sa pagbuo ng brick figure. Naroroon para sa cross-endpoint compatibility sa shared na V2ImageTo3DTaskResponse na hugis na ginagamit ng Image to 3D.

  • Name
    negative_prompt
    Type
    string
    Description

    Palaging walang laman para sa pagbuo ng brick figure. Naroroon para sa cross-endpoint compatibility.

  • Name
    texture_prompt
    Type
    string
    Description

    Palaging walang laman para sa pagbuo ng brick figure. Naroroon para sa cross-endpoint compatibility.

  • Name
    texture_image_url
    Type
    string
    Description

    Palaging walang laman para sa pagbuo ng brick figure. Naroroon para sa cross-endpoint compatibility.

  • Name
    model_urls
    Type
    object
    Description

    Mga downloadable na URL para sa nabuo na 3D model. Ang pagbuo ng brick figure ay naglalabas ng isang may texture na GLB kasama ang OBJ + MTL na pares para sa mga pipeline na mas gusto ang Wavefront OBJ. Ang hugis ng field ay tumutugma sa Image to 3D model_urls object kaya't ang mga karagdagang format sa hinaharap ay maidaragdag nang walang pagbabago.

    • Name
      glb
      Type
      string
      Description

      Downloadable na URL sa may texture na GLB file.

    • Name
      obj
      Type
      string
      Description

      Downloadable na URL sa Wavefront OBJ file (heometriya + UV).

    • Name
      mtl
      Type
      string
      Description

      Downloadable na URL sa OBJ companion MTL material file. Ipares sa obj at ang entry mula sa texture_urls[0].base_color.

  • Name
    thumbnail_url
    Type
    string
    Description

    Downloadable na URL sa thumbnail na imahe ng model file.

  • Name
    texture_urls
    Type
    array
    Description

    Isang array ng mga texture URL object na nabuo ng tungkuling ito. Sa kasalukuyan ay naglalaman ng isang object na may base color map.

    • Name
      base_color
      Type
      string
      Description

      Downloadable na URL sa base color map image.

Example Brick Figure Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-brick-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=***"
    }
  ]
}