Tukar foto sumber kepada medallion rantai kunci yang boleh dicetak 3D — relief kedalaman berwarna berbentuk lencana — dalam dua peringkat: prototaip menjana imej konsep berwarna daripada foto input anda, kemudian bina menukar imej konsep itu kepada model 3D relief. Kedua-dua peringkat dihubungkan melalui input_task_id.
Hasilkan satu imej konsep berwarna dari foto sumber. ID tugas yang dikembalikan adalah apa yang anda serahkan sebagai input_task_id kepada endpoint binaan. Rujuk kepada Objek Tugas Prototaip Rantai Kunci untuk bentuk respons.
Parameter
Name
image_url
Type
string
Diperlukan
Description
Foto sumber untuk Meshy mewarnakan menjadi imej konsep sedia rantai kunci. Kami kini menyokong format .jpg, .jpeg, .png, dan .webp.
Terdapat dua cara untuk menyediakan imej:
URL boleh diakses secara awam: URL yang boleh diakses dari internet awam.
Data URI: Data URI yang dikodkan base64 bagi imej. Contoh Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
Nama tugas pilihan untuk tujuan paparan. Maksimum 100 aksara.
Name
remove_background
Type
boolean
lalai false
Description
Apabila ditetapkan kepada true, imej prototaip dikembalikan sebagai PNG RGBA telus dengan latar belakang dibuang, jadi anda boleh menggabungkan subjek ke atas mana-mana latar belakang.
Ini hanya mengawal imej yang dikembalikan oleh endpoint ini. Ia berasingan dari pilihan binaan dengan nama yang sama (lalai true), yang mengawal penghapusan latar belakang sebelum pelepasan.
Pemulangan
Harta result dalam respons mengandungi id tugas prototaip rantai kunci yang baru dicipta. Poll endpoint Dapatkan Tugas atau langgan aliran sehingga tugas mencapai SUCCEEDED, kemudian serahkan ID itu kepada endpoint binaan sebagai input_task_id.
Mod Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak dapat diterima. Punca biasa:
Parameter hilang: image_url diperlukan.
Format imej tidak sah: image_url yang disediakan bukan format yang disokong (.jpg, .jpeg, .png, .webp).
Dimensi imej di luar julat: Imej terlalu kecil, melebihi saiz fail maksimum, atau melebihi jumlah piksel maksimum.
URL tidak dapat dicapai: image_url tidak dapat dimuat turun (404 atau timeout).
Data URI tidak sah: Rentetan base64 rosak.
Kandungan ditandakan: Imej input ditandakan oleh moderation NSFW atau harta intelek.
Name
401 - Unauthorized
Description
Pengesahan gagal. Sila periksa kunci API anda.
Name
402 - Payment Required
Description
Kredit tidak mencukupi untuk melaksanakan tugas ini.
Name
429 - Too Many Requests
Description
Anda telah melebihi had kadar anda.
Permintaan
POST
/openapi/creative-lab/keychain/v1/prototype
# Stage 1: generate a colorized keychain concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_url": "<your publicly accessible image url or base64-encoded data URI>" }'
Respons
{"result":"018a210d-8ba4-705c-b111-1f1776f7f578"}
Contoh prototaip
Mulakan dengan foto sumber, kemudian hasilkan imej prototaip yang digunakan oleh peringkat binaan rantai kunci.
Hasilkan medali rantai kunci 3D yang boleh dicetak daripada tugas prototaip yang berjaya. Pembinaan menjalankan saluran paip relief peta kedalaman pada imej konsep berwarna prototaip dan menghantar satu artifak jejaring dalam format yang anda minta. Rujuk kepada 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 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 mana-mana 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 nilai lalai yang munasabah — hantar hanya yang anda ingin ubah.
Name
badge_shape
Type
string
lalai circle
Description
Siluet garis besar medali rantai kunci. Nilai yang tersedia:
circle (lalai)
rounded-rect
hexagon
shield
star
Name
size_mm
Type
number
lalai 40
Description
Panjang tepi segi empat sama rantai kunci, dalam milimeter. Julat: (0, 400].
Name
relief_height_mm
Type
number
lalai 2.2
Description
Ketinggian relief maksimum di atas asas, 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 asas rata di belakang relief, dalam milimeter. Julat: [0, 20].
Name
has_closed_back
Type
boolean
lalai true
Description
Sama ada belakang medali disegel 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 yang 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 adalah gamma). Julat: (0, 10].
Name
invert_depth
Type
boolean
lalai false
Description
Balikkan tafsiran peta kedalaman supaya kawasan yang lebih gelap menjadi relief yang lebih tinggi.
Name
smoothing
Type
number
lalai 0.24
Description
Kekuatan penghalusan 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 ini dikapit kepada sifar. Julat: [0, 1].
Name
remove_background
Type
boolean
lalai true
Description
Secara automatik mengeluarkan latar belakang imej konsep prototaip sebelum membuat relief.
Berasingan daripada parameter prototaip dengan nama yang sama (lalai false), yang mengawal sama ada imej prototaip itu sendiri dikembalikan dengan ketelusan.
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
Bundel artifak yang dikembalikan oleh binaan. Nilai yang tersedia:
glb (lalai) — mengembalikan satu model.glb di bawah model_urls.glb.
obj — memampatkan model.obj + model.mtl + texture.png dan mengembalikan bundel di bawah model_urls.obj.
zip — memampatkan setiap artifak yang dihasilkan oleh penjana dan mengembalikan bundel di bawah model_urls.bundle_zip.
Pulangan
Harta result dalam respons mengandungi id tugas bagi tugas binaan rantai kunci yang baru dicipta. Poll endpoint Dapatkan Tugas atau langgan kepada aliran sehingga tugas mencapai SUCCEEDED, kemudian muat turun artifak dari satu entri dalam model_urls.
Mod Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak boleh diterima. Punca biasa:
Parameter hilang: input_task_id diperlukan.
UUID tidak sah: input_task_id bukan UUID yang sah.
Induk tidak 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 jatuh di luar julat atau set enum yang dibenarkan.
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, milik pengguna lain, atau dicipta melalui aplikasi web (hanya tugas prototaip mod API yang berantai ke binaan).
Dapatkan tugas prototaip atau binaan dengan memberikan id tugas yang sah. Laluan URL
mesti sepadan dengan peringkat tugas — tugas binaan yang diambil melalui
/prototype/:id akan mengembalikan 404, dan sebaliknya.
Batalkan tugas rantai kunci. Jika tugas masih PENDING, kredit yang digunakan semasa penciptaan akan dikembalikan. Tugas yang sudah IN_PROGRESS dibatalkan tanpa pengembalian (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
Pengenal pasti unik untuk tugas rantai kunci yang hendak dibatalkan.
Pemulangan
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 tugas rantai kunci melalui Server-Sent Events (SSE).
Laluan URL mesti sepadan dengan peringkat tugas — membuka strim di
/prototype/:buildId/stream akan mengeluarkan satu event: error payload dengan
status_code: 404 dan menutup strim.
Parameter
Name
id
Type
path
Description
Pengenal pasti unik untuk tugas rantai kunci yang hendak distrim.
Pulangan
Mengembalikan strim objek tugas Rantai Kunci Prototip
atau Rantai Kunci Bina sebagai
Server-Sent Events. Untuk tugas 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 berpenomboran halaman bagi tugas rantai kunci anda untuk satu peringkat. Laluan URL
memilih peringkat — /prototype mengembalikan tugas prototaip; /build
mengembalikan tugas binaan. Tugas dari peringkat lain tidak termasuk 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 — mendapatkan /prototype tidak akan mengembalikan
tugas binaan dan 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. Nilai yang tersedia:
+created_at: Isih mengikut masa penciptaan dalam susunan menaik.
-created_at: Isih mengikut masa penciptaan dalam susunan menurun.
Objek Tugas Prototip Rantai Kunci adalah unit kerja yang Meshy jejak untuk menghasilkan imej konsep berwarna daripada foto sumber. Hasil daripada peringkat ini dirantai ke peringkat binaan melalui input_task_id.
Sifat
Name
id
Type
string
Description
Pengenal pasti unik untuk tugas. Walaupun kami menggunakan UUID k-sortable untuk id tugas sebagai butiran pelaksanaan, anda tidak seharusnya membuat sebarang andaian tentang format id.
Name
type
Type
string
Description
Jenis tugas. Nilainya adalah creative-lab-keychain-prototype.
Name
name
Type
string
Description
Nama tugas yang dibekalkan apabila tugas dicipta. Rentetan kosong jika tiada nama yang diberikan.
Name
status
Type
string
Description
Status tugas. Nilai yang mungkin adalah 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.
Sebagai contoh, 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
Kiraan tugas terdahulu.
Nilai medan ini bermakna hanya jika status tugas adalah PENDING.
Name
task_error
Type
object
Description
Butiran ralat untuk tugas yang gagal. Lihat Ralat untuk rujukan penuh objek task_error.
Name
consumed_credits
Type
integer
Description
Bilangan kredit yang digunakan oleh tugas ini. Hadir apabila status tugas adalah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugas FAILED (kredit dikembalikan semula jika gagal).
Name
image_urls
Type
array of strings
Description
URL yang boleh dimuat turun untuk calon imej konsep yang dihasilkan oleh tugas prototip ini. Pada masa ini API sentiasa mengembalikan tepat satu calon; medan ini adalah tatasusunan supaya semakan masa depan boleh menampilkan pelbagai calon tanpa perubahan yang memecahkan.
Objek Tugasan Bina Rantai Kunci adalah unit kerja yang Meshy jejak untuk menjana jejaring rantai kunci 3D akhir daripada tugasan prototaip yang berjaya. Pembinaan ini menjalankan saluran paip relief peta kedalaman pada imej konsep prototaip dan menerbitkan satu artifak jejaring dalam format yang diminta oleh pemanggil.
Sifat
Name
id
Type
string
Description
Pengenal pasti unik untuk tugasan.
Name
type
Type
string
Description
Jenis tugasan. Nilainya adalah creative-lab-keychain-build.
Name
name
Type
string
Description
Nama tugasan yang dibekalkan apabila tugasan dicipta. Rentetan kosong jika tiada nama diberikan.
Name
status
Type
string
Description
Status tugasan. Nilai yang mungkin adalah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress tugasan. Jika tugasan belum dimulakan, sifat ini akan menjadi 0. Setelah tugasan berjaya, ini akan menjadi 100.
Name
created_at
Type
timestamp
Description
Cap masa apabila tugasan dicipta, dalam milisaat.
Name
started_at
Type
timestamp
Description
Cap masa apabila tugasan dimulakan, dalam milisaat.
Name
finished_at
Type
timestamp
Description
Cap masa apabila tugasan selesai, dalam milisaat.
Name
expires_at
Type
timestamp
Description
Cap masa apabila hasil tugasan tamat tempoh, dalam milisaat.
Name
preceding_tasks
Type
integer
Description
Bilangan tugasan terdahulu. Bermakna hanya apabila status adalah PENDING.
Name
task_error
Type
object
Description
Butiran ralat untuk tugasan yang gagal. Lihat Ralat untuk rujukan objek task_error penuh.
Name
consumed_credits
Type
integer
Description
Bilangan kredit yang digunakan oleh tugasan ini. Mengembalikan 0 untuk tugasan FAILED (kredit dikembalikan jika gagal).
Name
model_urls
Type
object
Description
URL yang boleh dimuat turun untuk artifak yang dihasilkan, dikunci dengan nama artifak. Sentiasa mengandungi tepat satu entri — format yang diminta melalui permintaan binaan output.format. Kunci sepadan dengan format yang diminta:
Name
glb
Type
string
Description
URL yang boleh dimuat turun untuk fail GLB. Hadir apabila output.format adalah glb (lalai).
Name
obj
Type
string
Description
URL yang boleh dimuat turun untuk pakej zip yang mengandungi model.obj, model.mtl, dan texture.png. Hadir apabila output.format adalah obj.
Name
bundle_zip
Type
string
Description
URL yang boleh dimuat turun untuk pakej zip setiap artifak yang dihasilkan oleh penjana. Hadir apabila output.format adalah zip.