API Berbilang Imej ke 3D

API Berbilang Imej ke 3D ialah ciri yang membolehkan anda mengintegrasikan keupayaan Berbilang Imej ke 3D Meshy ke dalam aplikasi anda sendiri. Dalam bahagian ini, anda akan menemui semua maklumat yang anda perlukan untuk bermula dengan API ini.

POST/openapi/v1/multi-image-to-3d

Cipta Tugas Berbilang Imej ke 3D

Endpoint ini membolehkan anda mencipta tugas Berbilang Imej ke 3D yang baharu. Rujuk Objek Tugas Berbilang Imej ke 3D untuk melihat sifat-sifat yang disertakan dengan objek tugas Berbilang Imej ke 3D.

Parameter

Hanya satu daripada input_task_id atau image_urls yang diperlukan. Jika kedua-duanya disediakan, input_task_id akan diberi keutamaan.

Name
input_task_id
Type
string
Diperlukan
Description
ID bagi tugas penjanaan imej yang telah selesai yang outputnya (1-4 imej) harus digunakan sebagai input. Tugas ini mestilah salah satu daripada tugas berikut: Teks ke Imej, Imej ke Imej, Teks ke Imej Berbilang Pandangan, atau Imej ke Imej Berbilang Pandangan. Selain itu, ia mesti telah dijalankan melalui API dan mempunyai status SUCCEEDED.

Name
image_urls
Type
array
Diperlukan
Description
Sediakan 1 hingga 4 imej untuk Meshy gunakan dalam penciptaan model. Kami kini menyokong format .jpg, .jpeg, dan .png. Semua imej harus menggambarkan objek yang sama daripada sudut yang berbeza untuk hasil yang terbaik.
Terdapat dua cara untuk menyediakan setiap imej:
- URL yang boleh diakses secara umum: Satu URL yang boleh diakses daripada internet awam.
- Data URI: Satu data URI imej yang dikodkan base64. Contoh data URI: data:image/jpeg;base64,<data imej anda yang dikodkan base64>.
Untuk meshy-7.1 (atau latest), imej pertama digunakan sebagai pandangan utama (hadapan). Susunan imej yang selebihnya tidak penting.

Name
ai_model
Type
string
lalai latest
Description
ID model yang hendak digunakan.
Nilai yang tersedia:
- meshy-6-lite, meshy-6, meshy-7.1, latest (Meshy 7.1)
- meshy-7 (lapuk): gunakan meshy-7.1 sebagai gantinya.
Name
geometry_resolution
Type
string
lalai standard
Description
Peringkat penjanaan geometri. 2k menjalankan peringkat Ultra pada 2048³. Memerlukan meshy-7.1 atau latest.
Nilai yang tersedia: standard, 2k
Name
ultra_mode
Type
boolean
⚠ lapuk
lalai false
Description
Gunakan geometry_resolution sebagai gantinya. ultra_mode: true bersamaan dengan geometry_resolution: "2k".
Name
should_texture
Type
boolean
lalai true
Description
Menentukan sama ada tekstur dijana. Menetapkannya kepada false melangkau fasa tekstur, menyediakan jejaring tanpa tekstur.

Hanya berlaku apabila should_texture = true

Name
enable_pbr
Type
boolean
lalai false
Description
Jana peta PBR (metallic, roughness, normal) selain warna asas. Peta emisi juga disertakan apabila ai_model ialah meshy-6, kecuali pada texture_resolution: 8k. meshy-6-lite, meshy-7.1 dan latest tidak menghasilkan peta emisi.
Name
texture_resolution
Type
string
lalai 2k
Description
Resolusi tekstur warna asas. Salah satu daripada 2k (2048×2048), 4k (4096×4096), atau 8k (8192×8192). Resolusi yang lebih tinggi menangkap lebih banyak butiran permukaan.
4k dan 8k memerlukan ai_model meshy-6, meshy-7.1 atau latest. Pada 8k, tiada peta emisi dihasilkan.
Name
hd_texture
Type
boolean
⚠ lapuk
lalai false
Description
Gunakan texture_resolution sebagai gantinya — bersamaan dengan texture_resolution: "4k". Apabila kedua-duanya ditetapkan, texture_resolution akan diberi keutamaan.
Name
texture_prompt
Type
string
Description
Sediakan prompt teks untuk membimbing proses tekstur. Maksimum 800 aksara.
Name
texture_image_url
Type
string
Description
Sediakan imej 2d untuk membimbing proses tekstur. Kami kini menyokong format .jpg, .jpeg, dan .png.
Terdapat dua cara untuk menyediakan imej ini:
- URL yang boleh diakses secara umum: Satu URL yang boleh diakses daripada internet awam
- Data URI: Satu data URI imej yang dikodkan base64. Contoh data URI: data:image/jpeg;base64,<data imej anda yang dikodkan base64>
Tekstur imej mungkin tidak berfungsi secara optimum jika terdapat perbezaan geometri yang besar antara aset asal dan imej yang dimuat naik. Hanya satu daripada texture_image_url atau texture_prompt boleh digunakan untuk membimbing proses tekstur. Jika kedua-dua parameter disediakan, texture_prompt akan digunakan secara lalai untuk memberi tekstur kepada model.
Name
texture_image_urls
Type
string[]
Description
Sediakan 1 hingga 4 imej yang menunjukkan objek yang sama daripada pandangan yang berbeza untuk membimbing tekstur. Imej pertama ialah pandangan utama (hadapan); susunan pandangan yang selebihnya (kiri, belakang, kanan) tidak penting.
Setiap elemen menerima format yang sama seperti texture_image_url (URL yang boleh diakses secara umum atau data URI base64, .jpg/.jpeg/.png).
Imej-imej ini hanya membimbing tekstur, dan tidak bergantung kepada image_urls — kedua-dua senarai boleh mengandungi imej yang berbeza dan bilangan imej yang berbeza.
Memerlukan ai_model meshy-7.1 atau latest. Tidak boleh digabungkan dengan texture_image_url atau texture_prompt.

Name
should_remesh
Type
boolean
lalai false (Meshy 6 and Meshy 7 models), true (others)
Description
Mengawal sama ada untuk mengaktifkan fasa remesh. Untuk model berkualiti tertinggi, kami mengesyorkan menetapkan should_remesh kepada false.

Hanya berlaku apabila should_remesh = true

Name
topology
Type
string
lalai triangle
Description
Tentukan topology model yang dijana.
Nilai yang tersedia:
- quad: Jana jejaring yang didominasi quad.
- triangle: Jana jejaring segi tiga yang telah didesimasikan.
Name
target_polycount
Type
integer
lalai 30,000
Description
Tentukan sasaran bilangan poligon dalam model yang dijana. Bilangan poligon sebenar mungkin berbeza daripada sasaran bergantung pada kerumitan geometri.
Julat nilai yang sah berbeza mengikut peringkat pengguna:
- 100 hingga 300,000 (termasuk)
Name
decimation_mode
Type
integer
Description
Aktifkan desimasi adaptif dengan menetapkan tahap bilangan poligon. Apabila ditetapkan, target_polycount akan diabaikan.
Nilai yang tersedia:
- 1: Adaptif — bilangan poligon ultra.
- 2: Adaptif — bilangan poligon tinggi.
- 3: Adaptif — bilangan poligon sederhana.
- 4: Adaptif — bilangan poligon rendah.
Name
save_pre_remeshed_model
Type
boolean
lalai false
Description
Apabila ditetapkan kepada true, Meshy juga menyimpan fail GLB tambahan sebelum fasa remesh selesai.

Name
symmetry_mode
Type
string
⚠ lapuk
lalai auto
Description
Lapuk. Parameter ini tidak lagi menjejaskan output.
Medan symmetry_mode mengawal tingkah laku simetri semasa proses penjanaan model.
Nilai yang sah adalah:
- off: Melumpuhkan simetri.
- auto: Menentukan dan mengaplikasikan simetri secara automatik berdasarkan geometri input.
- on: Menguatkuasakan simetri semasa penjanaan.
Name
pose_mode
Type
string
lalai ""
Description
Tentukan mode pose untuk model yang dijana.
Nilai yang tersedia:
- a-pose: Jana model dalam pose A.
- t-pose: Jana model dalam pose T.
- "" (rentetan kosong): Tiada pose khusus dikenakan.
Name
is_a_t_pose
Type
boolean
⚠ lapuk
lalai false
Description
Gunakan pose_mode sebagai gantinya. Sama ada untuk menjana model dalam pose A/T.
Name
image_enhancement
Type
boolean
lalai true
Description
Mengoptimumkan imej input untuk hasil yang lebih baik. Tetapkan kepada false untuk mengekalkan penampilan tepat imej input tanpa sebarang pemprosesan gaya.
Hanya disokong apabila ai_model ialah meshy-6, meshy-7.1 atau latest.
Name
remove_lighting
Type
boolean
lalai true
Description
Membuang sorotan dan bayang daripada tekstur warna asas, menghasilkan hasil yang lebih bersih yang berfungsi lebih baik dalam persediaan pencahayaan tersuai.
Hanya disokong apabila ai_model ialah meshy-6, meshy-7.1 atau latest.
Name
moderation
Type
boolean
lalai false
Description
Apabila ditetapkan kepada true, kandungan input akan disaring secara automatik untuk kandungan yang berpotensi berbahaya. Jika kandungan berbahaya dikesan, tugas tidak akan diteruskan ke penjanaan.
Setiap imej daripada image_urls dan teks daripada texture_prompt akan disaring.
Name
target_formats
Type
string[]
Description
Menentukan format fail 3D yang hendak disertakan dalam output. Hanya format yang diminta akan dijana dan dikembalikan, yang boleh mengurangkan masa penyelesaian tugas.
Nilai yang tersedia: glb, obj, fbx, stl, usdz, 3mf
Apabila ditinggalkan, semua format kecuali 3mf akan dijana. 3mf hanya disertakan apabila dinyatakan secara jelas.
Name
auto_size
Type
boolean
lalai false
Description
Apabila ditetapkan kepada true, perkhidmatan menggunakan penglihatan AI untuk menganggarkan ketinggian sebenar objek secara automatik dan mengubah saiz model mengikutnya. Titik asal akan lalai kepada bottom melainkan origin_at ditetapkan secara jelas.
Name
alpha_thumbnail
Type
boolean
lalai false
Description
Apabila ditetapkan kepada true, tugas juga akan merender versi pratonton dengan latar belakang lut sinar (RGBA) dan mengembalikannya sebagai alpha_thumbnail_url pada respons GET. Medan thumbnail_url yang sedia ada tidak berubah.
Name
multi_view_thumbnails
Type
boolean
lalai false
Description
Apabila ditetapkan kepada true, tugas juga akan merender empat lakaran kecil pandangan utama (hadapan, kanan, belakang, kiri) dan mengembalikannya di bawah thumbnail_urls pada respons GET. Medan thumbnail_url yang sedia ada tidak berubah dan terus menunjuk kepada pandangan hadapan, jadi klien sedia ada tidak terjejas.
Menambah kira-kira 3 saat kepada kependaman tugas.

Hanya berlaku apabila auto_size = true

Name
origin_at
Type
string
lalai bottom
Description
Kedudukan titik asal apabila auto_size diaktifkan. Nilai yang tersedia: bottom, center.

Pemulangan

Sifat result pada respons mengandungi id tugas bagi tugas Berbilang Imej ke 3D yang baharu dicipta.

Mod Kegagalan

Name
400 - Bad Request
Description
Permintaan tidak dapat diterima. Sebab biasa:
- Parameter hilang: Salah satu daripada image_urls atau input_task_id mesti disediakan.
- Tugas input tidak sah: input_task_id mesti merujuk kepada tugas Teks ke Imej, Imej ke Imej, atau varian berbilang pandangan yang berstatus SUCCEEDED.
- Bilangan imej tidak sah: image_urls mesti mengandungi antara 1 hingga 4 imej, dan texture_image_urls antara 1 hingga 4.
- Format imej tidak sah: Satu atau lebih imej dalam image_urls bukan format yang disokong.
- Input tekstur yang bercanggah: texture_image_urls tidak boleh digabungkan dengan texture_image_url atau texture_prompt, dan memerlukan should_texture: true.
- Model tidak disokong untuk tekstur berbilang pandangan: texture_image_urls memerlukan ai_model meshy-7.1 atau latest.
- URL tidak dapat dicapai: Satu atau lebih elemen image_urls atau texture_image_urls tidak dapat dimuat turun.
- Resolusi tidak disokong untuk input berbilang imej: geometry_resolution: "4k" tidak tersedia pada endpoint ini; gunakan 2k atau standard.
Name
401 - Unauthorized
Description
Pengesahan gagal. Sila semak 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.

Request

POST

/openapi/v1/multi-image-to-3d

# Simple request
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_urls": [
      "<your publicly accessible image url or base64-encoded data URI>",
      "<your second publicly accessible image url or base64-encoded data URI>"
    ]
  }'

# With Ultra 2K geometry, PBR texturing and GLB format
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_urls": [
      "<your publicly accessible image url or base64-encoded data URI>",
      "<your second publicly accessible image url or base64-encoded data URI>"
    ],
    "ai_model": "meshy-7.1",
    "geometry_resolution": "2k",
    "should_texture": true,
    "enable_pbr": true,
    "target_formats": ["glb"]
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

GET/openapi/v1/multi-image-to-3d/:id

Dapatkan Semula Tugas Berbilang Imej ke 3D

Endpoint ini membolehkan anda mendapatkan semula tugas Berbilang Imej ke 3D dengan id tugas yang sah. Rujuk The Multi-Image to 3D Task Object untuk melihat sifat-sifat yang disertakan dalam objek tugas Berbilang Imej ke 3D.

Parameter

Name
id
Type
path
Description
Pengecam unik untuk tugas Berbilang Imej ke 3D yang hendak didapatkan semula.

Pemulangan

Respons mengandungi objek tugas Berbilang Imej ke 3D. Rujuk bahagian The Multi-Image to 3D Task Object untuk maklumat lanjut.

Request

GET

/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl https://api.meshy.ai/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "multi-image-to-3d",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 30
}

DELETE/openapi/v1/multi-image-to-3d/:id

Padam Tugasan Berbilang Imej ke 3D

Endpoint ini memadam secara kekal tugasan Berbilang Imej ke 3D, termasuk semua model dan data yang berkaitan. Tindakan ini tidak boleh diterbalikkan.

Parameter Laluan

Name
id
Type
path
Description
ID tugasan Berbilang Imej ke 3D yang hendak dipadam.

Status Tugasan

Tugasan yang masih PENDING akan dipadam dan kredit yang digunakan semasa penciptaan akan dikembalikan.

Tugasan yang sudah IN_PROGRESS tidak boleh dipadam: permintaan tersebut akan ditolak dengan 409 Conflict dan tugasan itu akan terus berjalan. Kredit bagi tugasan yang telah mula diproses oleh worker tidak boleh dikembalikan, jadi memadamnya semasa ia sedang berjalan akan menyebabkan anda kehilangan kedua-dua kredit dan hasilnya. Tunggu sehingga ia mencapai status SUCCEEDED, FAILED atau CANCELED, kemudian padamkannya.

Tugasan yang berada dalam status akhir (SUCCEEDED, FAILED atau CANCELED) akan dipadam tanpa sebarang bayaran balik.

Pulangan

Mengembalikan 200 OK apabila berjaya, atau 409 Conflict apabila tugasan tersebut IN_PROGRESS.

Request

DELETE

/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS — the task is left running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}

GET/openapi/v1/multi-image-to-3d

Senaraikan Tugas Berbilang Imej ke 3D

Endpoint ini membolehkan anda mendapatkan senarai tugas Berbilang Imej ke 3D.

Parameter

Atribut pilihan

Name
page_num
Type
integer
Description
Nombor halaman untuk penomboran halaman. Bermula dan lalai kepada 1.
Name
page_size
Type
integer
Description
Had saiz halaman. Lalai kepada 10 item. Maksimum yang dibenarkan ialah 100 item.
Name
sort_by
Type
string
Description
Medan untuk diisih. Nilai yang tersedia:
- +created_at: Isih mengikut masa penciptaan secara menaik.
- -created_at: Isih mengikut masa penciptaan secara menurun.

Kembalian

Mengembalikan senarai berhalaman bagi Objek Tugas Berbilang Imej ke 3D.

Request

GET

/openapi/v1/multi-image-to-3d

curl https://api.meshy.ai/openapi/v1/multi-image-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "multi-image-to-3d",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
      "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "thumbnail_urls": {
      "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
      "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
      "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
      "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
    },
    "texture_prompt": "",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "expires_at": 1692771679037,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
        "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
        "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
        "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
        "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {

      "message": ""

    },

    "consumed_credits": 30
  }
]

GET/openapi/v1/multi-image-to-3d/:id/stream

Alirkan Tugas Berbilang Imej ke 3D

Endpoint ini mengalirkan kemas kini masa nyata untuk tugas Berbilang Imej ke 3D menggunakan Server-Sent Events (SSE).

Parameter

Name
id
Type
path
Description
Pengecam unik untuk tugas Berbilang Imej ke 3D yang hendak dialirkan.

Pulangan

Memulangkan aliran Objek Tugas Berbilang Imej ke 3D sebagai Server-Sent Events.

Untuk tugas PENDING atau IN_PROGRESS, aliran respons hanya akan mengandungi medan progress dan status yang diperlukan.

Request

GET

/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example
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": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "multi-image-to-3d",
  "model_urls": {
  "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
  "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
  "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
  "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
  "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
  "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
  "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
  "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
  "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
  "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 30
}

Objek Tugas Berbilang Imej ke 3D

Objek Tugas Berbilang Imej ke 3D adalah unit kerja yang dijejaki oleh Meshy untuk menjana model 3d daripada beberapa imej (antara 1 hingga 4 termasuk). Imej-imej tersebut haruslah objek yang sama, sebaik-baiknya dari pandangan atau sudut yang berbeza. Objek ini mempunyai ciri-ciri berikut:

Ciri-ciri

Name
id
Type
string
Description
Pengenal unik untuk tugas. Walaupun kami menggunakan UUID yang boleh disusun-k untuk id tugas sebagai perincian pelaksanaan, anda tidak seharusnya membuat sebarang andaian tentang format id tersebut.
Name
type
Type
string
Description
Jenis tugas Berbilang Imej ke 3D. Nilainya adalah multi-image-to-3d.
Name
model_urls
Type
object
Description
URL yang boleh dimuat turun untuk fail model 3D bertekstur yang dijana oleh Meshy. Ciri untuk sesuatu format akan diabaikan jika format tersebut tidak dijana, dan bukannya mengembalikan rentetan kosong.
- Name
  glb
  Type
  string
  Description
  URL yang boleh dimuat turun untuk fail GLB.
- Name
  fbx
  Type
  string
  Description
  URL yang boleh dimuat turun untuk fail FBX.
- Name
  obj
  Type
  string
  Description
  URL yang boleh dimuat turun untuk fail OBJ.
- Name
  usdz
  Type
  string
  Description
  URL yang boleh dimuat turun untuk fail USDZ.
- Name
  mtl
  Type
  string
  Description
  URL yang boleh dimuat turun untuk fail MTL, dikembalikan bersama eksport OBJ apabila terdapat tekstur.
- Name
  stl
  Type
  string
  Description
  URL yang boleh dimuat turun untuk fail STL.
- Name
  3mf
  Type
  string
  Description
  URL yang boleh dimuat turun untuk fail 3MF. Hanya wujud apabila 3mf telah diminta melalui target_formats.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  URL yang boleh dimuat turun untuk output GLB asal sebelum remesh.
  Hanya wujud apabila tugas dicipta dengan kedua-dua should_remesh: true dan save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
URL yang boleh dimuat turun untuk imej kecil fail model. Bersamaan dengan thumbnail_urls.front apabila wujud, dikekalkan untuk keserasian ke belakang.
Name
alpha_thumbnail_url
Type
string
Description
URL yang boleh dimuat turun untuk versi latar belakang lut sinar (RGBA) daripada thumbnail_url. Hanya wujud apabila tugas dicipta dengan alpha_thumbnail: true dan pratonton lut sinar berjaya dirender; jika tidak, medan ini akan diabaikan.
Name
thumbnail_urls
Type
object
Description
URL yang boleh dimuat turun untuk empat imej kecil pandangan kardinal bagi model 3D yang dijana. Setiap nilai adalah URL bertandatangan untuk PNG 512×512 yang dirender dengan bahan dan pencahayaan yang sama seperti thumbnail_url. Berguna untuk pratonton model dari pelbagai sudut dalam saluran paip kelompok tanpa perlu memuat turun GLB.
Hanya wujud apabila tugas dicipta dengan multi_view_thumbnails: true dan telah mencapai SUCCEEDED. Tugas lama dan tugas yang dicipta tanpa opt-in ini tidak akan mengandungi medan ini.
- Name
  front
  Type
  string
  Description
  Pandangan hadapan, putaran 0° pada paksi menegak (sepadan dengan thumbnail_url).
- Name
  right
  Type
  string
  Description
  Pandangan kanan, putaran 90°.
- Name
  back
  Type
  string
  Description
  Pandangan belakang, putaran 180°.
- Name
  left
  Type
  string
  Description
  Pandangan kiri, putaran 270°.
Name
texture_prompt
Type
string
Description
Prompt teks yang digunakan untuk membimbing proses pembuatan tekstur.
Name
texture_image_urls
Type
string[]
Description
URL yang boleh dimuat turun untuk imej rujukan tekstur yang digunakan untuk mencipta tugas ini, mengikut susunan ia diberikan. Hanya wujud apabila tugas dicipta dengan texture_image_urls.
Name
ultra_mode
Type
boolean
⚠ lapuk
Description
Lapuk; baca geometry_resolution sebagai gantinya.
Name
geometry_resolution
Type
string
Description
Tahap Ultra yang dijalankan oleh tugas (2k); diabaikan untuk standard.
Name
progress
Type
integer
Description
Progress tugas. Jika tugas belum bermula, ciri ini akan menjadi 0. Setelah tugas berjaya, ini akan menjadi 100.
Name
started_at
Type
timestamp
Description
Cap masa bila tugas dimulakan, dalam milisaat. Jika tugas belum dimulakan, ciri ini akan menjadi 0.
Cap masa mewakili bilangan milisaat yang berlalu sejak 1 Januari 1970 UTC, menurut piawaian RFC 3339. Sebagai contoh, Jumaat, 1 September 2023 12:00:00 PM GMT diwakili sebagai 1693569600000. Ini berlaku untuk semua cap masa dalam Meshy API.
Name
created_at
Type
timestamp
Description
Cap masa bila tugas dicipta, dalam milisaat.
Name
expires_at
Type
timestamp
Description
Cap masa bila keputusan tugas akan luput, dalam milisaat.
Name
finished_at
Type
timestamp
Description
Cap masa bila tugas selesai, dalam milisaat. Jika tugas belum selesai, ciri ini akan menjadi 0.
Name
status
Type
string
Description
Status tugas. Nilai yang mungkin adalah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Satu tatasusunan objek URL tekstur yang dijana daripada tugas. Biasanya ini hanya mengandungi satu objek URL tekstur. Setiap URL tekstur mempunyai ciri-ciri berikut:
- Name
  base_color
  Type
  string
  Description
  URL yang boleh dimuat turun untuk imej peta warna asas.
- Name
  metallic
  Type
  string
  Description
  URL yang boleh dimuat turun untuk imej peta metalik.
  Jika tugas dicipta dengan enable_pbr: false, ciri ini akan diabaikan.
- Name
  normal
  Type
  string
  Description
  URL yang boleh dimuat turun untuk imej peta normal.
  Jika tugas dicipta dengan enable_pbr: false, ciri ini akan diabaikan.
- Name
  roughness
  Type
  string
  Description
  URL yang boleh dimuat turun untuk imej peta kekasaran.
  Jika tugas dicipta dengan enable_pbr: false, ciri ini akan diabaikan.
- Name
  emission
  Type
  string
  Description
  URL yang boleh dimuat turun untuk imej peta pancaran.
  Jika tugas dicipta dengan enable_pbr: false, atau ai_model adalah meshy-6-lite, ciri ini akan diabaikan.
Name
preceding_tasks
Type
integer
Description
Kiraan tugas yang mendahului.
Nilai medan ini hanya bermakna jika status tugas adalah PENDING.
Name
task_error
Type
object
Description
Perincian ralat untuk tugas yang gagal. Lihat Ralat untuk rujukan lengkap objek task_error.
Name
consumed_credits
Type
integer
Description
Bilangan kredit yang digunakan oleh tugas ini. Wujud apabila status tugas adalah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugas FAILED (kredit dikembalikan semula apabila gagal).

Example Multi-Image to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "multi-image-to-3d",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 30,
}