API Rantai Kunci Creative Lab

Tukarkan foto kepada rantai kunci boleh cetak 3D dengan relief berwarna dalam dua peringkat. Tugas prototaip menjana imej konsep berwarna daripada foto tersebut. Tugas binaan menukarkan imej tersebut kepada model 3D relief, dan mengambil ID tugas prototaip sebagai input_task_id.

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

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

Cipta tugas prototaip Keychain

Menjana satu imej konsep berwarna daripada foto. Untuk membina model 3D, hantarkan ID tugas ini ke endpoint build sebagai input_task_id. Untuk medan tugas, lihat Objek tugas prototaip Keychain.

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"
}

Contoh prototaip

Mulakan dengan foto sumber, kemudian jana imej prototaip yang digunakan oleh peringkat pembinaan keychain.

Foto sumber yang digunakan sebagai input Creative Lab Keychain — Input prototaip

Output prototaip Creative Lab Keychain yang dijana daripada foto sumber — Output prototaip

Parameter

Name
image_url
Type
string
Diperlukan
Description
Foto untuk dijadikan imej konsep keychain, sebagai URL awam atau data URI (data:image/jpeg;base64,<data imej anda yang dikodkan base64>).
Imej mestilah fail JPG, JPEG, PNG, atau WebP bersaiz maksimum 20 MB.
Name
name
Type
string
Description
Nama untuk tugas, sehingga 100 aksara. Ia dikembalikan dalam medan name tugas tersebut. Nama yang lebih panjang mengembalikan 400.
Ia melabelkan tugas dalam papan pemuka dan senarai tugas anda, dan tidak muncul pada keychain. Untuk meletakkan nama pada keychain, gunakan name_text.
Name
name_text
Type
string
Description
Nama untuk ditambah pada keychain, seperti nama haiwan peliharaan atau nama seseorang, sehingga 10 aksara. Meshy mengira aksara, bukan bait, jadi nama Cina, Jepun, atau Korea sepanjang 10 aksara boleh digunakan. Nama yang lebih panjang mengembalikan 400. Biarkan kosong untuk keychain tanpa nama.
Nama muncul pada permukaan keychain sebagai perincian berwarna rata, bukan sebagai teks timbul atau terpotong.
Meshy memotong ruang kosong di sekeliling dan membuang aksara pemformatan tidak kelihatan. Objek tugas prototaip mengembalikan hasilnya sebagai name_text, jadi anda boleh menyemak teks sebelum membayar untuk pembinaan.
Meshy menambah nama pada peringkat prototaip. Build mengekalkannya, dan mengabaikan name_text yang dihantar ke endpoint build.
Apabila teks bukan ASCII biasa, hantar isi kandungan permintaan sebagai UTF-8 dengan Content-Type: application/json; charset=utf-8. Sesetengah klien HTTP, seperti Invoke-RestMethod Windows PowerShell, mengekod isi kandungan sebagai ISO-8859-1 secara lalai. Itu menukarkan setiap aksara bukan Latin kepada ? sebelum permintaan sampai ke Meshy, dan Meshy tidak dapat membezakannya daripada nama yang anda maksudkan untuk dihantar.
Name
remove_background
Type
boolean
lalai false
Description
Sama ada untuk membuang latar belakang daripada imej prototaip. true mengembalikan PNG RGBA telus yang mengekalkan keseluruhan medalion, supaya anda boleh meletakkannya pada mana-mana latar belakang. Build juga bermula daripada imej tanpa latar belakangnya. Jika Meshy tidak dapat membuang latar belakang, ia mengembalikan imej dengan latar belakangnya, dan tugas masih berjaya.
Pilihan remove_background bagi build adalah berasingan.

Pulangan

Medan result menyimpan ID tugas prototaip baharu. Dapatkan tugas atau alirkannya sehingga status adalah SUCCEEDED. Kemudian hantarkan ID tersebut ke endpoint build sebagai input_task_id.

Mod kegagalan

Name
400 - Bad Request
Description
Permintaan tidak dapat dijalankan. Contohnya:
- image_url tiada.
- Imej bukan fail JPG, JPEG, PNG, atau WebP.
- Imej terlalu kecil, melebihi 20 MB, atau melebihi bilangan piksel maksimum.
- Meshy tidak dapat memuat turun imej, contohnya kerana URL mengembalikan 404 atau tamat masa.
- Data URI bukan base64 yang sah.
- name_text lebih panjang daripada 10 aksara. Meshy menolaknya dan bukannya memendekkannya, dan tidak mengenakan caj untuk permintaan tersebut.
- Imej atau name_text ditandakan sebagai NSFW.
Mesej ralat menyatakan masalah yang ditemuinya. Betulkan permintaan, kemudian hantar semula.
Name
401 - Unauthorized
Description
Kunci API tiada atau tidak sah. Semak header Authorization.
Name
402 - Payment Required
Description
Salah satu daripada perkara berikut berlaku:
- Akaun tidak mempunyai kredit yang mencukupi.
- Kunci API, ruang kerja, atau ahli telah mencapai had kredit.
- Akaun berada pada pelan percuma.
Semak kredit dan pelan anda, kemudian cuba semula.
Name
403 - Forbidden
Description
Pasukan anda telah menghidupkan IP Filtering, dan Meshy menandakan imej tersebut untuk harta intelek pihak ketiga. Hantar imej yang anda mempunyai hak untuk digunakan. Meshy hanya menyemak imej untuk harta intelek, bukan name_text.
Name
429 - Too Many Requests
Description
Salah satu had berikut telah dicapai:
- Anda menghantar lebih banyak permintaan daripada yang dibenarkan oleh had kadar anda. Tunggu beberapa saat, kemudian cuba semula. Lihat Had kadar.
- Terlalu banyak tugas anda berada dalam baris gilir atau sedang berjalan. Tunggu sehingga sebahagiannya selesai, kemudian cuba semula.
- Pada pelan tanpa had tanpa baki kredit, anda telah mencapai bilangan tugas yang boleh berjalan tanpa kredit. Tunggu sehingga satu tugas selesai, atau tambah kredit.
Name
500 - Internal Server Error
Description
Meshy mengalami ralat pelayan, contohnya kerana ia tidak dapat menjalankan semakan harta intelek pada imej tersebut. Meshy tidak mencipta tugas tersebut, dan memulangkan semula sebarang kredit yang telah dikenakan caj. Cuba semula permintaan tersebut.

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

Cipta tugas pembinaan Keychain

Menjana keychain yang boleh dicetak dalam 3D daripada tugas prototaip yang berjaya. Meshy menukar imej konsep prototaip kepada relief peta kedalaman, dan mengembalikan satu fail model dalam format yang anda pilih. Untuk medan-medan tugas ini, lihat Objek tugas pembinaan Keychain.

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"
}

Contoh pembinaan

Tugas pembinaan menukar imej prototaip yang dipilih kepada model keychain yang boleh dicetak dalam 3D.

Pratonton model pembinaan Creative Lab Keychain — Pratonton model pembinaan

Parameter

Name
input_task_id
Type
string
Diperlukan
Description
ID tugas prototaip untuk dibina. Ia mestilah tugas yang dicipta oleh akaun anda dengan POST /openapi/creative-lab/keychain/v1/prototype, dengan status SUCCEEDED.
ID yang bukan salah satu tugas prototaip Keychain anda daripada API akan mengembalikan 404, termasuk prototaip yang dibuat dalam aplikasi web.
Name
name
Type
string
Description
Nama untuk tugas, sehingga 100 aksara. Ia akan dikembalikan dalam medan name tugas tersebut. Nama yang lebih panjang mengembalikan 400.

`options`

Tetapan pilihan untuk bentuk relief. Setiap medan mempunyai nilai lalai, jadi hantar hanya medan yang anda mahu ubah. Nilai di luar julat sesuatu medan mengembalikan 400.

Name
badge_shape
Type
string
lalai circle
Description
Garis luar keychain apabila Meshy tidak menjejakinya daripada subjek. Meshy menggunakannya apabila remove_background adalah false, atau apabila ia tidak dapat mencari garis luar subjek.
Nilai yang tersedia:
- circle
- rounded-rect
- hexagon
- shield
- star
Name
size_mm
Type
number
lalai 40
Description
Panjang sisi segi empat sama bersempadan keychain, dalam milimeter, sehingga 400. 0 menggunakan nilai lalai.
Name
relief_height_mm
Type
number
lalai 2.2
Description
Ketinggian maksimum relief di atas asas, dalam milimeter, dari 0 hingga 20.
Name
relief_offset_mm
Type
number
lalai 0
Description
Sejauh mana untuk merendahkan relief, dalam milimeter, dari 0 hingga 20. Meshy menolaknya daripada ketinggian relief di semua tempat, sehingga ke asas.
Name
base_thickness_mm
Type
number
lalai 0.1
Description
Ketebalan plat asas rata di belakang relief, dalam milimeter, dari 0 hingga 20.
Name
has_closed_back
Type
boolean
lalai true
Description
Sama ada untuk menutup bahagian belakang keychain. false membiarkan bahagian belakang terbuka, seperti cengkerang.
Name
relief_curve
Type
string
lalai linear
Description
Lengkung yang memetakan nilai peta kedalaman kepada ketinggian relief.
Nilai yang tersedia:
- linear
- gamma
- s-curve
Name
curve_param
Type
number
lalai 1.0
Description
Kekuatan lengkung, sehingga 10. Lengkung gamma dan s-curve menggunakannya, dan linear mengabaikannya. 0 menggunakan nilai lalai.
Name
invert_depth
Type
boolean
lalai false
Description
Sama ada untuk menyongsangkan peta kedalaman, supaya kawasan yang lebih gelap menjadi relief yang lebih tinggi.
Name
smoothing
Type
number
lalai 0.24
Description
Berapa banyak untuk melicinkan peta kedalaman sebelum Meshy membina relief, dari 0 hingga 10.
Name
relief_scale
Type
number
lalai 1.0
Description
Berapa banyak untuk membesarkan relief dan teksturnya di dalam garis luar, mengelilingi pusat, sehingga 10. Nilai melebihi 1 membesarkan subjek, dan nilai di bawah 1 mengecilkannya. Ia tidak mengubah ketinggian relief. 0 menggunakan nilai lalai.
Name
depth_threshold
Type
number
lalai 0.1
Description
Nilai peta kedalaman di bawah mana Meshy menetapkan kedalaman kepada sifar, dari 0 hingga 1.
Name
remove_background
Type
boolean
lalai true
Description
Sama ada untuk menjejaki garis luar keychain daripada subjek, supaya keychain mengikut bentuk subjek. false menggunakan garis luar badge_shape sebagai gantinya. Meshy juga menggunakan badge_shape apabila ia tidak dapat mencari garis luar subjek.
Ini berasingan daripada parameter remove_background prototaip, yang menetapkan sama ada imej prototaip mempunyai latar belakang lutsinar.
Name
export_resolution
Type
integer
lalai 512
Description
Resolusi jejaring model yang dieksport, dari 64 hingga 512. Meshy membina geometri daripada peta kedalaman 512-piksel, jadi jejaring yang lebih halus akan menambah muka tanpa menambah perincian. 0 menggunakan nilai lalai.

`output`

Pilihan. Menetapkan format fail yang dikembalikan oleh pembinaan.

Name
format
Type
string
lalai glb
Description
Format fail yang dikembalikan oleh pembinaan.
Nilai yang tersedia:
- glb: satu fail model.glb, dalam model_urls.glb
- obj: fail zip dengan model.obj, model.mtl, dan texture.png, dalam model_urls.obj
- zip: fail zip dengan setiap fail yang dijana oleh Meshy, dalam model_urls.bundle_zip

Nilai yang dikembalikan

Medan result menyimpan ID tugas pembinaan yang baharu. Dapatkan tugas atau strim tugas itu sehingga status adalah SUCCEEDED. Kemudian muat turun fail daripada satu-satunya entri dalam model_urls.

Mod kegagalan

Name
400 - Bad Request
Description
Permintaan tidak dapat dijalankan. Sebagai contoh:
- input_task_id tiada atau bukan ID tugas yang sah.
- Status tugas prototaip bukan SUCCEEDED. Jika ia masih berjalan, tunggu dan cuba semula. Jika ia gagal atau dibatalkan, cipta tugas prototaip baharu.
- Tugas prototaip berjaya tetapi tiada imej. Cipta tugas prototaip baharu.
- Medan options di luar julatnya atau bukan nilai yang tersedia.
Mesej ralat menyatakan masalah yang ditemuinya.
Name
401 - Unauthorized
Description
Kunci API tiada atau tidak sah. Semak header Authorization.
Name
402 - Payment Required
Description
Salah satu daripada ini berlaku:
- Akaun tidak mempunyai kredit yang mencukupi.
- Kunci API, ruang kerja, atau ahli telah mencapai had kreditnya.
- Akaun berada pada pelan percuma.
Semak kredit dan pelan anda, kemudian cuba semula.
Name
404 - Not Found
Description
input_task_id tidak sepadan dengan mana-mana tugas prototaip Keychain yang dicipta oleh akaun anda dengan API. Prototaip yang dibuat dalam aplikasi web juga mengembalikan 404. Hantar ID result daripada respons penciptaan prototaip.
Name
429 - Too Many Requests
Description
Salah satu had ini telah dicapai:
- Anda menghantar lebih banyak permintaan daripada yang dibenarkan oleh had kadar anda. Tunggu beberapa saat, kemudian cuba semula. Lihat Had kadar.
- Terlalu banyak tugas anda sedang beratur atau berjalan. Tunggu sehingga sebahagiannya selesai, kemudian cuba semula.
- Pada pelan tanpa had tanpa baki kredit, anda telah mencapai bilangan tugas yang boleh berjalan tanpa kredit. Tunggu sehingga satu tugas selesai, atau tambah kredit.

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

Dapatkan tugas rantai kunci

Mengembalikan tugas prototaip atau build. Laluan mesti sepadan dengan peringkat tugas tersebut. Tugas build yang diminta melalui /prototype/:id mengembalikan 404, begitu juga tugas prototaip yang diminta melalui /build/:id.

Untuk medan-medan, lihat The Keychain prototype task object dan 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=***"
  }
}

Parameter

Name
id
Type
path
Description
ID tugas daripada respons create.

Nilai yang dikembalikan

Objek tugas prototaip atau objek tugas build, sepadan dengan peringkat dalam laluan.

Mod kegagalan

Name
400 - Bad Request
Description
id bukan ID tugas yang sah. Hantar ID result daripada respons create.
Name
403 - Forbidden
Description
Pasukan anda telah menghidupkan IP Filtering, dan Meshy menandakan imej tugas prototaip tersebut kerana hak milik intelektual pihak ketiga. Tugas build dan pasukan pada pelan Enterprise tidak akan menerima ralat ini. Cipta tugas prototaip daripada imej yang anda mempunyai hak untuk menggunakannya.
Name
404 - Not Found
Description
Tiada tugas Keychain dengan ID ini yang dimiliki oleh akaun anda, atau peringkat tugas tidak sepadan dengan laluan. Semak ID tersebut, dan gunakan /prototype atau /build untuk memadankan tugas.
Name
500 - Internal Server Error
Description
Meshy tidak dapat menjalankan pemeriksaan hak milik intelektual. Cuba semula permintaan tersebut.

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

Padam tugas Keychain

Membatalkan tugas Keychain. Membatalkan tugas PENDING akan memulangkan kreditnya. Tugas IN_PROGRESS dibatalkan tanpa bayaran balik, kerana pekerja telah pun memulakannya. Tugas yang mempunyai status akhir (SUCCEEDED, FAILED, atau CANCELED) tidak boleh dibatalkan.

Laluan mestilah sepadan dengan peringkat tugas tersebut. Sebagai contoh, DELETE pada /prototype/:id dengan ID tugas build akan memulangkan 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).

Parameter laluan

Name
id
Type
path
Description
ID tugas yang hendak dibatalkan.

Pulangan

204 No Content dengan badan kosong.

Mod kegagalan

Name
400 - Bad Request
Description
Salah satu daripada perkara berikut berlaku:
- id bukan ID tugas yang sah. Hantar ID result daripada respons penciptaan.
- Tugas tersebut sudah mempunyai status akhir (SUCCEEDED, FAILED, atau CANCELED), jadi ia tidak boleh dibatalkan.
Name
404 - Not Found
Description
Tiada tugas Keychain dengan ID ini yang dimiliki oleh akaun anda, atau peringkat tugas tersebut tidak sepadan dengan laluan. Semak ID, dan gunakan /prototype atau /build untuk memadankan tugas tersebut.

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

Stream a Keychain task

Menstrim kemas kini tugas rantai kunci sebagai Server-Sent Events (SSE). Laluan tersebut mesti sepadan dengan peringkat tugas. Jika tidak, contohnya ID tugas build pada /prototype/:id/stream, strim tersebut menghantar satu peristiwa error dengan status_code: 404 dan kemudian ditutup.

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=***"
  }
}

Parameter

Name
id
Type
path
Description
ID tugas daripada respons create.

Return

Satu strim objek tugas prototype atau build. Setiap peristiwa mengandungi objek tugas yang lengkap, sepertimana yang dikembalikan oleh Get a Keychain task. Semasa tugas berstatus PENDING atau IN_PROGRESS, medan outputnya masih kosong (null, [], atau {}), dan finished_at adalah null.

Jika IP Filtering menyekat hasil tugas tersebut, strim akan menghantar satu peristiwa error sebagai gantinya, dengan status_code yang sama seperti yang akan dikembalikan oleh permintaan get.

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

Senaraikan tugas Keychain

Mengembalikan tugas rantai kunci anda bagi satu peringkat, satu halaman pada satu masa. Laluan (path) menentukan peringkat tersebut. /prototype hanya mengembalikan tugas prototaip, dan /build hanya mengembalikan tugas build.

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=***"
    ]
  }
]

Parameter laluan

Name
stage
Type
path
Diperlukan
Description
Peringkat yang hendak disenaraikan, prototype atau build.

Parameter pertanyaan

Name
page_num
Type
integer
lalai 1
Description
Halaman yang hendak dikembalikan, dari 1 hingga 255. 0 mengembalikan halaman pertama. Nilai di luar 0 hingga 255 akan mengembalikan 400.
Name
page_size
Type
integer
lalai 10
Description
Bilangan tugas setiap halaman, sehingga 100. Nilai dari 101 hingga 255 akan mengembalikan 100 tugas, dan 0 menggunakan nilai lalai. Nilai di luar 0 hingga 255 akan mengembalikan 400.
Name
sort_by
Type
string
lalai -created_at
Description
Susunan isihan.
Nilai yang tersedia:
- -created_at: terbaharu dahulu
- +created_at: terlama dahulu

Kembalian

Satu tatasusunan objek tugas prototaip atau objek tugas build, mengikut peringkat yang dinyatakan dalam laluan.

Objek tugasan prototaip Keychain

Tugasan prototaip menjana imej konsep berwarna daripada sebuah foto. Untuk menukar imej itu menjadi model 3D, hantar ID tugasan tersebut ke build endpoint sebagai input_task_id.

Sifat

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
ID tugasan. Jangan bergantung pada formatnya.
Name
type
Type
string
Description
Jenis tugasan, sentiasa creative-lab-keychain-prototype.
Name
name
Type
string
Description
name yang anda hantar semasa mencipta tugasan, atau "" jika anda tidak menghantarnya.
Name
name_text
Type
string
Description
Nama yang ditambah oleh Meshy pada keychain, selepas memangkas ruang kosong dan membuang aksara pemformatan yang tidak kelihatan. Tidak disertakan jika anda tidak menghantar name_text. Untuk menyemak bahawa klien HTTP anda mengekod teks tersebut dengan betul, bandingkannya dengan apa yang anda hantar.
Name
status
Type
string
Description
Status tugasan.
Nilai yang tersedia:
- PENDING: menunggu dalam baris gilir
- IN_PROGRESS: sedang menjana hasil
- SUCCEEDED: muktamad, dengan hasil
- FAILED: muktamad, dengan sebab dalam task_error
- CANCELED: muktamad, tanpa hasil
Name
progress
Type
integer
Description
Peratusan kerja yang selesai, dari 0 hingga 100. Ia bernilai 0 sehingga tugasan bermula dan 100 apabila ia berjaya.
Name
created_at
Type
timestamp
Description
Masa tugasan dicipta, dalam milisaat Unix.
Name
started_at
Type
timestamp
Description
Masa seorang pekerja memulakan tugasan, dalam milisaat Unix. null sehingga ketika itu.
Name
finished_at
Type
timestamp
Description
Masa tugasan mencapai status muktamad, dalam milisaat Unix. null sehingga ketika itu.
Name
expires_at
Type
timestamp
Description
Masa hasil tugasan tamat tempoh, dalam milisaat Unix. Ia adalah 3 hari selepas finished_at, atau 3 hari selepas created_at sehingga tugasan selesai. Untuk akaun Enterprise, yang mengekalkan hasil API secara tidak terhad, ia adalah kira-kira 100 tahun kemudian. Lihat Pengekalan aset.
Name
preceding_tasks
Type
integer
Description
Kedudukan tugasan dalam baris gilir semasa ia PENDING. 1 bermaksud ia bermula seterusnya. 0 selepas tugasan meninggalkan baris gilir, dan sentiasa 0 dalam hasil senarai.
Name
task_error
Type
object
Description
Sebab tugasan gagal. null kecuali status adalah FAILED. Lihat Ralat.
Name
consumed_credits
Type
integer
Description
Bilangan kredit yang dikenakan bagi tugasan tersebut, selepas sebarang bayaran balik. Permintaan yang mengembalikan ralat tidak dikenakan caj. Tugasan yang gagal bernilai 0, kerana Meshy membayar baliknya. Membatalkan hanya membayar balik tugasan semasa ia masih PENDING. Jika Meshy tidak dapat membaca caj tersebut, respons get atau stream akan mengetepikan medan ini, dan permintaan senarai akan mengembalikan 500. Dalam kes itu, cuba semula permintaan tersebut.
Name
image_urls
Type
array of strings
Description
URL muat turun untuk imej konsep. Tatasusunan ini mempunyai satu URL selepas tugasan berjaya, dan kosong sehingga ketika itu.

Objek tugas binaan Keychain

Tugas binaan menjana rantai kunci 3D daripada tugas prototaip yang berjaya. Ia memulangkan satu fail model dalam format yang anda minta.

Ciri-ciri

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
ID tugas. Jangan bergantung pada formatnya.
Name
type
Type
string
Description
Jenis tugas, sentiasa creative-lab-keychain-build.
Name
name
Type
string
Description
name yang anda hantar semasa mencipta tugas, atau "" jika anda tidak menghantarnya.
Name
status
Type
string
Description
Status tugas.
Nilai yang tersedia:
- PENDING: menunggu dalam baris gilir
- IN_PROGRESS: menjana hasil
- SUCCEEDED: muktamad, dengan hasil
- FAILED: muktamad, dengan sebab dalam task_error
- CANCELED: muktamad, tanpa hasil
Name
progress
Type
integer
Description
Peratusan kerja yang selesai, dari 0 hingga 100. Ia adalah 0 sehingga tugas bermula dan 100 apabila ia berjaya.
Name
created_at
Type
timestamp
Description
Masa tugas dicipta, dalam milisaat Unix.
Name
started_at
Type
timestamp
Description
Masa pekerja memulakan tugas, dalam milisaat Unix. null sehingga itu.
Name
finished_at
Type
timestamp
Description
Masa tugas mencapai status muktamad, dalam milisaat Unix. null sehingga itu.
Name
expires_at
Type
timestamp
Description
Masa hasil tugas tamat tempoh, dalam milisaat Unix. Ia adalah 3 hari selepas finished_at, atau 3 hari selepas created_at sehingga tugas selesai. Untuk akaun Enterprise, yang menyimpan hasil API secara berterusan, ia adalah kira-kira 100 tahun kemudian. Lihat Pengekalan aset.
Name
preceding_tasks
Type
integer
Description
Kedudukan tugas dalam baris gilir semasa ia PENDING. 1 bermakna ia bermula seterusnya. 0 selepas tugas meninggalkan baris gilir, dan sentiasa 0 dalam hasil senarai.
Name
task_error
Type
object
Description
Sebab tugas gagal. null kecuali status adalah FAILED. Lihat Ralat.
Name
consumed_credits
Type
integer
Description
Bilangan kredit yang dicaj untuk tugas, selepas sebarang bayaran balik. Permintaan yang memulangkan ralat tidak dicaj. Tugas yang gagal adalah 0, kerana Meshy membayar balik. Membatalkan hanya membayar balik tugas semasa ia PENDING. Jika Meshy tidak dapat membaca caj tersebut, respons get atau stream akan meninggalkan medan tersebut, dan permintaan senarai akan memulangkan 500. Dalam kes itu, cuba semula permintaan tersebut.
Name
model_urls
Type
object
Description
URL muat turun untuk fail model, dengan satu entri untuk output.format yang anda minta. {} sehingga tugas berjaya.
- Name
  glb
  Type
  string
  Description
  URL muat turun untuk fail GLB. Hadir apabila output.format adalah glb.
- Name
  obj
  Type
  string
  Description
  URL muat turun untuk fail zip dengan model.obj, model.mtl, dan texture.png. Hadir apabila output.format adalah obj.
- Name
  bundle_zip
  Type
  string
  Description
  URL muat turun untuk fail zip dengan setiap fail yang Meshy jana. Hadir apabila output.format adalah zip.