Tukar foto sumber menjadi medalion rantai kunci yang boleh dicetak 3D — relief
kedalaman berwarna berbentuk lencana — dalam dua peringkat: prototaip menjana imej konsep
berwarna daripada foto input anda, kemudian binaan menukar imej konsep tersebut
menjadi model 3D relief. Kedua-dua peringkat dipautkan melalui input_task_id.
Jana satu imej konsep berwarna daripada foto sumber. ID tugasan yang
dikembalikan ialah apa yang anda hantar sebagai input_task_id kepada endpoint
binaan. Rujuk
Objek Tugasan Prototaip Rantai Kunci
untuk bentuk respons.
Parameter
Name
image_url
Type
string
Diperlukan
Description
Foto sumber untuk Meshy warnakan menjadi imej konsep yang sedia untuk rantai kunci. Pada masa ini kami menyokong format .jpg, .jpeg, .png, dan .webp.
Terdapat dua cara untuk menyediakan imej:
URL yang boleh diakses secara awam: URL yang boleh diakses daripada internet awam.
Data URI: Data URI imej yang dikodkan base64. Contoh Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
Nama tugasan pilihan untuk tujuan paparan. Maksimum 100 aksara.
Mengembalikan
Sifat result bagi respons mengandungi id tugasan bagi tugasan prototaip rantai kunci yang baru dicipta. Tinjau endpoint Dapatkan Tugasan atau langgan strim sehingga tugasan mencapai SUCCEEDED, kemudian hantar ID tersebut kepada endpoint binaan sebagai input_task_id.
Mod Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak boleh diterima. Punca biasa:
Parameter hilang: image_url diperlukan.
Format imej tidak sah: image_url yang diberikan bukan format yang disokong (.jpg, .jpeg, .png, .webp).
Dimensi imej di luar julat: Imej terlalu kecil, melebihi saiz fail maksimum, atau melebihi kiraan piksel maksimum.
URL tidak dapat dicapai: image_url tidak dapat dimuat turun (404 atau timeout).
Data URI tidak sah: Rentetan base64 tidak terbentuk dengan betul.
Kandungan ditandakan: Imej input telah ditandakan oleh moderation NSFW atau harta intelek.
Name
401 - Unauthorized
Description
Pengesahan gagal. Sila semak kunci API anda.
Name
402 - Payment Required
Description
Kredit tidak mencukupi untuk melaksanakan tugasan ini.
Name
429 - Too Many Requests
Description
Anda telah melebihi had kadar anda.
Request
POST
/openapi/creative-lab/keychain/v1/prototype
# Stage 1: generate a colorized keychain concept imagecurl https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "image_url": "<your publicly accessible image url or base64-encoded data URI>" }'
Response
{"result":"018a210d-8ba4-705c-b111-1f1776f7f578"}
Prototype example
Start with a source photo, then generate the prototype image used by the keychain build stage.
Jana medalion rantai kunci akhir yang boleh dicetak 3D daripada tugas
prototaip yang berjaya. Binaan menjalankan saluran paip relief peta kedalaman pada
imej konsep berwarna prototaip dan menghantar satu artifak jejaring dalam
format yang anda minta. Rujuk
Objek Tugas Binaan Rantai Kunci untuk
bentuk respons.
Parameter
Name
input_task_id
Type
string
Diperlukan
Description
ID tugas bagi tugas prototaip yang dicipta melalui endpoint OpenAPI yang sama ini. Prototaip mesti telah dicipta dengan kunci API yang sama, mesti telah mencapai SUCCEEDED, dan mesti telah menghasilkan tepat satu imej calon.
Tugas prototaip yang dicipta melalui aplikasi web tidak diterima — endpoint binaan hanya menerima tugas prototaip yang dihasilkan oleh POST /openapi/creative-lab/keychain/v1/prototype dan menolak sebarang sumber lain dengan 404.
Name
name
Type
string
Description
Nama tugas pilihan untuk tujuan paparan. Maksimum 100 aksara.
options
Parameter penalaan pilihan untuk geometri relief. Setiap medan mempunyai lalai yang munasabah — hantar hanya medan yang ingin anda ganti.
Name
badge_shape
Type
string
lalai circle
Description
Siluet garis luar medalion rantai kunci. Nilai tersedia:
circle (lalai)
rounded-rect
hexagon
shield
star
Name
size_mm
Type
number
lalai 40
Description
Panjang sisi segi empat sama pembatas rantai kunci, dalam milimeter. Julat: (0, 400].
Name
relief_height_mm
Type
number
lalai 2.2
Description
Ketinggian relief maksimum di atas tapak, dalam milimeter. Julat: [0, 20].
Name
relief_offset_mm
Type
number
lalai 0
Description
Ofset menegak yang digunakan pada relief sebelum penyemperitan, dalam milimeter. Julat: [0, 20].
Name
base_thickness_mm
Type
number
lalai 0.1
Description
Ketebalan plat tapak rata di belakang relief, dalam milimeter. Julat: [0, 20].
Name
has_closed_back
Type
boolean
lalai true
Description
Sama ada bahagian belakang medalion dimeterai sebagai permukaan tertutup. Tetapkan kepada false untuk cangkerang terbuka.
Name
relief_curve
Type
string
lalai linear
Description
Lengkung pemindahan yang memetakan nilai peta kedalaman kepada ketinggian relief. Nilai tersedia:
linear (lalai)
gamma
s-curve
Name
curve_param
Type
number
lalai 1.0
Description
Parameter bentuk untuk lengkung pemindahan (hanya bermakna apabila relief_curve ialah gamma). Julat: (0, 10].
Name
invert_depth
Type
boolean
lalai false
Description
Songsangkan tafsiran peta kedalaman supaya kawasan yang lebih gelap menjadi relief yang lebih tinggi.
Name
smoothing
Type
number
lalai 0.24
Description
Kekuatan pelicinan yang digunakan pada peta kedalaman sebelum pengekstrakan relief. Julat: [0, 10].
Name
relief_scale
Type
number
lalai 1.0
Description
Pengganda skala menegak yang digunakan di atas relief_height_mm. Julat: (0, 10].
Name
depth_threshold
Type
number
lalai 0.1
Description
Ambang laluan rendah untuk nilai peta kedalaman; apa-apa di bawah nilai ini dikepit kepada sifar. Julat: [0, 1].
Name
remove_background
Type
boolean
lalai true
Description
Alih keluar latar belakang imej konsep prototaip secara automatik sebelum membuat relief.
Name
export_resolution
Type
integer
lalai 512
Description
Resolusi jejaring yang digunakan untuk eksport. Julat: [64, 2048].
output
Pemilih format wayar pilihan. Lalai kepada glb.
Name
format
Type
string
lalai glb
Description
Berkas artifak yang dikembalikan oleh binaan. Nilai tersedia:
glb (lalai) — mengembalikan satu model.glb di bawah model_urls.glb.
obj — memampatkan model.obj + model.mtl + texture.png dan mengembalikan berkas di bawah model_urls.obj.
zip — memampatkan setiap artifak yang dipancarkan oleh penjana dan mengembalikan berkas di bawah model_urls.bundle_zip.
Pulangan
Sifat result bagi respons mengandungi id tugas bagi tugas binaan rantai kunci yang baru dicipta. Tinjau endpoint Dapatkan Tugas atau langgan strim sehingga tugas mencapai SUCCEEDED, kemudian muat turun artifak daripada entri tunggal dalam model_urls.
Mode Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak boleh diterima. Punca lazim:
Parameter hilang: input_task_id diperlukan.
UUID tidak sah: input_task_id bukan UUID yang sah.
Induk belum berjaya: Tugas prototaip yang dirujuk belum mencapai SUCCEEDED.
Tiada calon: Tugas prototaip berjaya tetapi tidak menghasilkan imej calon.
Pilihan di luar julat: Salah satu medan options berada di luar julat yang dibenarkan atau set enum.
Name
401 - Unauthorized
Description
Pengesahan gagal. Sila semak kunci API anda.
Name
402 - Payment Required
Description
Kredit tidak mencukupi untuk melaksanakan tugas ini.
Name
404 - Not Found
Description
Tugas prototaip yang dirujuk tidak wujud, dimiliki oleh pengguna lain, atau dicipta melalui aplikasi web (hanya tugas prototaip mode API boleh dirantaikan ke binaan).
Dapatkan semula tugas prototaip atau binaan dengan id tugas yang sah. Laluan URL
mesti sepadan dengan peringkat tugas — tugas binaan yang diambil melalui
/prototype/:id mengembalikan 404, dan begitu juga sebaliknya.
Batalkan tugas rantai kunci. Jika tugas masih PENDING, kredit
yang digunakan semasa penciptaan akan dikembalikan. Tugas yang sudah
IN_PROGRESS dibatalkan tanpa bayaran balik (pekerja mungkin sudah
menggunakan Sumber). Tugas yang telah mencapai keadaan terminal
(SUCCEEDED, FAILED, CANCELED) tidak boleh dibatalkan.
Laluan URL mesti sepadan dengan peringkat tugas — DELETE pada
/prototype/:buildId mengembalikan 404.
Parameter Laluan
Name
id
Type
path
Description
Pengecam unik untuk tugas rantai kunci yang hendak dibatalkan.
Pulangan
Mengembalikan 204 No Content apabila berjaya dengan badan kosong.
Mod Kegagalan
Name
400 - Bad Request
Description
Tugas sudah berada dalam keadaan terminal dan tidak boleh dibatalkan.
Name
404 - Not Found
Description
Tugas tidak wujud, milik pengguna lain, atau peringkatnya tidak sepadan dengan laluan URL.
Strim kemas kini masa nyata untuk tugasan rantai kunci melalui Server-Sent Events (SSE).
Laluan URL mesti sepadan dengan peringkat tugasan — membuka strim pada
/prototype/:buildId/stream memancarkan satu payload event: error dengan
status_code: 404 dan menutup strim.
Parameter
Name
id
Type
path
Description
Pengecam unik untuk tugasan rantai kunci yang hendak distrim.
Mengembalikan
Mengembalikan strim objek tugasan Prototaip rantai kunci
atau Binaan rantai kunci sebagai
Server-Sent Events. Untuk tugasan PENDING atau IN_PROGRESS, strim respons
hanya akan menyertakan medan progress dan status yang diperlukan.
// Error event example (wrong stage or task not found)event: errordata: {"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: messagedata: {"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb","progress": 0,"status": "PENDING"}event: messagedata: {"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": 20,"model_urls": {"glb":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***" }}
Dapatkan senarai tugas rantai kunci anda yang bernombor halaman untuk satu peringkat. Laluan
URL memilih peringkat — /prototype mengembalikan tugas prototaip; /build
mengembalikan tugas binaan. Tugas daripada peringkat lain tidak disertakan dalam mana-mana
respons.
Parameter Laluan
Name
stage
Type
path
Diperlukan
Description
Sama ada prototype atau build. Koleksi hanya mengembalikan tugas
yang peringkatnya sepadan dengan URL — mengambil /prototype tidak sekali-kali mengembalikan
tugas binaan dan begitu juga sebaliknya.
Parameter Pertanyaan
Name
page_num
Type
integer
lalai 1
Description
Nombor halaman untuk penomboran halaman.
Name
page_size
Type
integer
lalai 10
Description
Had saiz halaman. Maksimum yang dibenarkan ialah 50 item.
Name
sort_by
Type
string
lalai -created_at
Description
Medan untuk diisih mengikut. Nilai yang tersedia:
+created_at: Isih mengikut masa penciptaan dalam tertib menaik.
-created_at: Isih mengikut masa penciptaan dalam tertib menurun.
Objek Tugasan Prototaip rantai kunci ialah unit kerja yang dijejaki oleh Meshy untuk
menjana imej konsep berwarna daripada foto sumber. Output daripada
peringkat ini dirangkaikan ke dalam peringkat binaan
melalui input_task_id.
Sifat
Name
id
Type
string
Description
Pengecam unik untuk tugas. Walaupun kami menggunakan UUID yang boleh diisih k untuk id tugas sebagai perincian pelaksanaan, anda tidak patut membuat sebarang andaian tentang format id tersebut.
Name
type
Type
string
Description
Jenis tugas. Nilainya ialah creative-lab-keychain-prototype.
Name
name
Type
string
Description
Nama tugas yang dibekalkan apabila tugas dicipta. Rentetan kosong jika tiada nama diberikan.
Name
status
Type
string
Description
Status tugas. Nilai yang mungkin ialah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress tugas. Jika tugas belum dimulakan, sifat ini akan menjadi 0. Setelah tugas berjaya, ini akan menjadi 100.
Name
created_at
Type
timestamp
Description
Cap masa apabila tugas dicipta, dalam milisaat.
Cap masa mewakili bilangan milisaat yang berlalu sejak 1 Januari 1970 UTC, mengikut
piawaian RFC 3339.
Contohnya, Jumaat, 1 September 2023 12:00:00 PM GMT diwakili sebagai 1693569600000. Ini terpakai
kepada semua cap masa dalam Meshy API.
Name
started_at
Type
timestamp
Description
Cap masa apabila tugas dimulakan, dalam milisaat. Jika tugas belum dimulakan, sifat ini akan menjadi 0.
Name
finished_at
Type
timestamp
Description
Cap masa apabila tugas selesai, dalam milisaat. Jika tugas belum selesai, sifat ini akan menjadi 0.
Name
expires_at
Type
timestamp
Description
Cap masa apabila hasil tugas tamat tempoh, dalam milisaat.
Name
preceding_tasks
Type
integer
Description
Bilangan tugas terdahulu.
Nilai medan ini hanya bermakna jika status tugas ialah PENDING.
Name
task_error
Type
object
Description
Butiran ralat untuk tugas yang gagal. Lihat Ralat untuk rujukan objek task_error yang lengkap.
Name
consumed_credits
Type
integer
Description
Bilangan kredit yang digunakan oleh tugas ini. Hadir apabila status tugas ialah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugas FAILED (kredit dipulangkan semula apabila gagal).
Name
image_urls
Type
array of strings
Description
URL boleh dimuat turun untuk calon imej konsep yang dijana oleh tugas prototaip ini. Pada masa ini API sentiasa mengembalikan tepat satu calon; medan ini ialah array supaya semakan masa hadapan boleh memaparkan berbilang calon tanpa perubahan yang memecahkan keserasian.
Objek Tugas Binaan Rantai Kunci ialah unit kerja yang Meshy jejaki untuk
menjana jejaring rantai kunci 3D akhir daripada tugas prototaip yang berjaya. Proses
binaan menjalankan saluran relief peta kedalaman pada imej konsep prototaip dan
menerbitkan satu artifak jejaring dalam format yang diminta oleh pemanggil.
Sifat
Name
id
Type
string
Description
Pengecam unik untuk tugas.
Name
type
Type
string
Description
Jenis tugas. Nilainya ialah creative-lab-keychain-build.
Name
name
Type
string
Description
Nama tugas yang diberikan apabila tugas dicipta. Rentetan kosong jika tiada nama diberikan.
Name
status
Type
string
Description
Status tugas. Nilai yang mungkin ialah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress tugas. Jika tugas belum bermula, sifat ini akan menjadi 0. Setelah tugas berjaya, ini akan menjadi 100.
Name
created_at
Type
timestamp
Description
Cap masa bagi waktu tugas dicipta, dalam milisaat.
Name
started_at
Type
timestamp
Description
Cap masa bagi waktu tugas dimulakan, dalam milisaat.
Name
finished_at
Type
timestamp
Description
Cap masa bagi waktu tugas diselesaikan, dalam milisaat.
Name
expires_at
Type
timestamp
Description
Cap masa bagi waktu hasil tugas tamat tempoh, dalam milisaat.
Name
preceding_tasks
Type
integer
Description
Bilangan tugas terdahulu. Bermakna hanya apabila status ialah PENDING.
Name
task_error
Type
object
Description
Butiran ralat untuk tugas yang gagal. Lihat Ralat untuk rujukan objek task_error yang lengkap.
Name
consumed_credits
Type
integer
Description
Bilangan kredit yang digunakan oleh tugas ini. Mengembalikan 0 untuk tugas FAILED (kredit dipulangkan semula apabila gagal).
Name
model_urls
Type
object
Description
URL yang boleh dimuat turun untuk artifak yang dijana, diindekskan mengikut nama artifak. Sentiasa mengandungi tepat satu entri — format yang diminta melalui output.format permintaan binaan. Kunci sepadan dengan format yang diminta:
Name
glb
Type
string
Description
URL yang boleh dimuat turun ke fail GLB. Hadir apabila output.format ialah glb (lalai).
Name
obj
Type
string
Description
URL yang boleh dimuat turun ke berkas zip yang mengandungi model.obj, model.mtl, dan texture.png. Hadir apabila output.format ialah obj.
Name
bundle_zip
Type
string
Description
URL yang boleh dimuat turun ke berkas zip bagi setiap artifak yang dikeluarkan oleh penjana. Hadir apabila output.format ialah zip.