API Multi-Gambar ke 3D

API Multi-Gambar ke 3D adalah fitur yang memungkinkan Anda mengintegrasikan kemampuan Multi-Gambar ke 3D dari Meshy ke dalam aplikasi Anda sendiri. Di bagian ini, Anda akan menemukan semua informasi yang Anda butuhkan untuk memulai dengan API ini.

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

Buat Multi-Image to 3D Task

Endpoint ini memungkinkan Anda membuat task Multi-Gambar ke 3D baru. Lihat The Multi-Image to 3D Task Object untuk melihat properti apa saja yang termasuk dalam objek task Multi-Gambar ke 3D.

Task berjalan di latar belakang. Untuk mengetahui berapa lama biasanya proses ini berlangsung, lihat Processing Times.

Parameter

Hanya salah satu dari input_task_id atau image_urls yang wajib diisi. Jika keduanya disediakan, input_task_id akan diprioritaskan.

Name
input_task_id
Type
string
Wajib
Description
ID dari task pembuatan gambar yang telah selesai, yang outputnya (1-4 gambar) akan digunakan sebagai input. Task ini harus merupakan salah satu dari task berikut: Teks ke Gambar, Gambar ke Gambar, Text to Image Multi-View, atau Image to Image Multi-View. Selain itu, task tersebut harus dijalankan melalui API dan memiliki status SUCCEEDED.

Name
image_urls
Type
array
Wajib
Description
Sediakan 1 hingga 4 gambar untuk digunakan Meshy dalam pembuatan model. Kami saat ini mendukung format .jpg, .jpeg, .png, dan .webp. Semua gambar harus menggambarkan objek yang sama dari sudut pandang yang berbeda untuk hasil terbaik.
Ukuran file maksimum: 20 MB per gambar.
Ada dua cara untuk menyediakan setiap gambar:
- URL yang dapat diakses secara publik: URL yang dapat diakses dari internet publik.
- Data URI: Data URI gambar yang dienkode base64. Contoh data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Untuk meshy-7.1 (atau latest), gambar pertama digunakan sebagai tampilan utama (depan). Urutan gambar lainnya tidak berpengaruh.

Name
ai_model
Type
string
default latest
Description
ID model yang akan digunakan.
Nilai yang tersedia:
- meshy-6-lite, meshy-6, meshy-7.1, latest (Meshy 7.1)
- meshy-7 (usang): gunakan meshy-7.1 sebagai gantinya.
Name
geometry_resolution
Type
string
default standard
Description
Tahap pembuatan geometri. 2k menjalankan tahap Ultra pada 2048³. Membutuhkan meshy-7.1 atau latest.
Nilai yang tersedia: standard, 2k
Name
ultra_mode
Type
boolean
⚠ usang
default false
Description
Gunakan geometry_resolution sebagai gantinya. ultra_mode: true setara dengan geometry_resolution: "2k".
Name
should_texture
Type
boolean
default true
Description
Menentukan apakah tekstur dihasilkan. Mengaturnya ke false akan melewati tahap tekstur, sehingga menghasilkan mesh tanpa tekstur.

Hanya berlaku ketika should_texture = true

Name
enable_pbr
Type
boolean
default false
Description
Hasilkan peta PBR (metallic, roughness, normal) selain warna dasar. Peta emisi juga disertakan saat ai_model adalah meshy-6, kecuali pada texture_resolution: 8k. meshy-6-lite, meshy-7.1, dan latest tidak menghasilkan peta emisi.
Name
texture_resolution
Type
string
default 2k
Description
Resolusi tekstur warna dasar. Salah satu dari 2k (2048×2048), 4k (4096×4096), atau 8k (8192×8192). Resolusi yang lebih tinggi menangkap detail permukaan yang lebih banyak.
4k dan 8k membutuhkan ai_model meshy-6, meshy-7.1, atau latest. Pada 8k, tidak ada peta emisi yang dihasilkan.
Name
hd_texture
Type
boolean
⚠ usang
default false
Description
Gunakan texture_resolution sebagai gantinya — setara dengan texture_resolution: "4k". Jika keduanya diatur, texture_resolution akan diprioritaskan.
Name
texture_prompt
Type
string
Description
Sediakan prompt teks untuk memandu proses pembuatan tekstur. Maksimum 800 karakter.
Name
texture_image_url
Type
string
Description
Sediakan gambar 2d untuk memandu proses pembuatan tekstur. Kami saat ini mendukung format .jpg, .jpeg, .png, dan .webp.
Ukuran file maksimum: 20 MB.
Ada dua cara untuk menyediakan gambar:
- URL yang dapat diakses secara publik: URL yang dapat diakses dari internet publik
- Data URI: Data URI gambar yang dienkode base64. Contoh data URI: data:image/jpeg;base64,<your base64-encoded image data>
Pembuatan tekstur gambar mungkin tidak bekerja secara optimal jika terdapat perbedaan geometri yang substansial antara aset asli dan gambar yang diunggah. Hanya salah satu dari texture_image_url atau texture_prompt yang dapat digunakan untuk memandu proses pembuatan tekstur. Jika kedua parameter disediakan, maka texture_prompt akan digunakan secara default untuk memberi tekstur pada model.
Name
texture_image_urls
Type
string[]
Description
Sediakan 1 hingga 4 gambar yang menunjukkan objek yang sama dari sudut pandang yang berbeda untuk memandu pembuatan tekstur. Gambar pertama adalah tampilan utama (depan); urutan tampilan lainnya (kiri, belakang, kanan) tidak berpengaruh.
Setiap elemen menerima format yang sama seperti texture_image_url (URL yang dapat diakses secara publik atau data URI base64, .jpg/.jpeg/.png/.webp).
Ukuran file maksimum: 20 MB per gambar.
Gambar-gambar ini hanya memandu tekstur, dan independen dari image_urls — kedua daftar ini dapat berisi gambar yang berbeda dan jumlah gambar yang berbeda.
Membutuhkan ai_model meshy-7.1 atau latest. Tidak dapat dikombinasikan dengan texture_image_url atau texture_prompt.

Name
should_remesh
Type
boolean
default false (Meshy 6 and Meshy 7 models), true (others)
Description
Mengontrol apakah akan mengaktifkan tahap remesh. Untuk model dengan kualitas tertinggi, kami merekomendasikan untuk mengatur should_remesh ke false.

Hanya berlaku ketika should_remesh = true

Name
topology
Type
string
default triangle
Description
Tentukan topology dari model yang dihasilkan.
Nilai yang tersedia:
- quad: Hasilkan mesh yang didominasi oleh quad.
- triangle: Hasilkan mesh segitiga yang telah di-decimate.
Name
target_polycount
Type
integer
default 30,000
Description
Tentukan target jumlah poligon pada model yang dihasilkan. Jumlah poligon sebenarnya dapat berbeda dari target tergantung pada kompleksitas geometri.
Rentang yang valid adalah 100 hingga 300.000 (inklusif).
Name
decimation_mode
Type
integer
Description
Aktifkan decimation adaptif dengan mengatur tingkat jumlah poligon. Jika diatur, target_polycount akan diabaikan.
Nilai yang tersedia:
- 1: Adaptif — jumlah poligon ultra.
- 2: Adaptif — jumlah poligon tinggi.
- 3: Adaptif — jumlah poligon sedang.
- 4: Adaptif — jumlah poligon rendah.
Name
save_pre_remeshed_model
Type
boolean
default false
Description
Jika diatur ke true, Meshy juga menyimpan file GLB tambahan sebelum tahap remesh selesai.

Name
symmetry_mode
Type
string
⚠ usang
default auto
Description
Usang. Parameter ini tidak lagi memengaruhi output.
Bidang symmetry_mode mengontrol perilaku simetri selama proses pembuatan model.
Nilai yang valid adalah:
- off: Menonaktifkan simetri.
- auto: Secara otomatis menentukan dan menerapkan simetri berdasarkan geometri input.
- on: Menerapkan simetri secara paksa selama proses pembuatan.
Name
pose_mode
Type
string
default ""
Description
Tentukan mode pose untuk model yang dihasilkan.
Nilai yang tersedia:
- a-pose: Hasilkan model dalam pose A.
- t-pose: Hasilkan model dalam pose T.
- "" (string kosong): Tidak ada pose khusus yang diterapkan.
Name
is_a_t_pose
Type
boolean
⚠ usang
default false
Description
Gunakan pose_mode sebagai gantinya. Apakah akan menghasilkan model dalam pose A/T.
Name
image_enhancement
Type
boolean
default true
Description
Mengoptimalkan gambar input untuk hasil yang lebih baik. Atur ke false untuk mempertahankan tampilan asli gambar input tanpa pemrosesan gaya apa pun.
Hanya didukung saat ai_model adalah meshy-6, meshy-7.1, atau latest. Mengaturnya dengan meshy-6-lite akan mengembalikan error.
Name
remove_lighting
Type
boolean
default true
Description
Menghapus highlight dan bayangan dari tekstur warna dasar, menghasilkan hasil yang lebih bersih yang bekerja lebih baik di bawah pengaturan pencahayaan kustom.
Hanya didukung saat ai_model adalah meshy-6, meshy-7.1, atau latest. Mengaturnya dengan meshy-6-lite akan mengembalikan error.
Name
moderation
Type
boolean
default false
Description
Jika diatur ke true, konten input akan secara otomatis diperiksa untuk konten yang berpotensi berbahaya. Jika konten berbahaya terdeteksi, task tidak akan melanjutkan ke tahap pembuatan.
Setiap gambar dari image_urls dan teks dari texture_prompt akan diperiksa.
Name
target_formats
Type
string[]
Description
Menentukan format file 3D mana yang akan disertakan dalam output. Hanya format yang diminta yang akan dihasilkan dan dikembalikan, yang dapat mengurangi waktu penyelesaian task.
Nilai yang tersedia: glb, obj, fbx, stl, usdz, 3mf
Jika dihilangkan, semua format kecuali 3mf akan dihasilkan. 3mf hanya disertakan jika secara eksplisit ditentukan.
Name
auto_size
Type
boolean
default false
Description
Jika diatur ke true, layanan akan menggunakan AI vision untuk secara otomatis memperkirakan tinggi objek di dunia nyata dan mengubah ukuran model sesuai dengan itu. Titik asal akan default ke bottom kecuali origin_at secara eksplisit diatur.
Name
alpha_thumbnail
Type
boolean
default false
Description
Jika diatur ke true, task juga akan merender versi latar belakang transparan (RGBA) dari pratinjau dan mengembalikannya sebagai alpha_thumbnail_url pada respons GET. Bidang thumbnail_url yang sudah ada tidak berubah.
Name
multi_view_thumbnails
Type
boolean
default false
Description
Jika diatur ke true, task juga akan merender empat thumbnail tampilan utama (depan, kanan, belakang, kiri) dan mengembalikannya di bawah thumbnail_urls pada respons GET. Bidang thumbnail_url yang sudah ada tidak berubah dan tetap menunjuk ke tampilan depan, sehingga klien yang sudah ada tidak terpengaruh.
Menambah sekitar 3 detik pada latensi task.

Hanya berlaku ketika auto_size = true

Name
origin_at
Type
string
default bottom
Description
Posisi titik asal saat auto_size diaktifkan. Nilai yang tersedia: bottom, center.

Hasil Pengembalian

Properti result dari respons berisi id task dari task Multi-Gambar ke 3D yang baru dibuat.

Mode Kegagalan

Name
400 - Bad Request
Description
Permintaan tidak dapat diterima. Penyebab umum:
- Parameter hilang: Salah satu dari image_urls atau input_task_id harus disediakan.
- Task input tidak valid: input_task_id harus merujuk pada task Teks ke Gambar, Gambar ke Gambar, atau varian multi-view dengan status SUCCEEDED.
- Jumlah gambar tidak valid: image_urls harus berisi antara 1 hingga 4 gambar, dan texture_image_urls antara 1 hingga 4.
- Format gambar tidak valid: Satu atau lebih gambar dalam image_urls bukan format yang didukung.
- Input tekstur yang bertentangan: texture_image_urls tidak dapat dikombinasikan dengan texture_image_url atau texture_prompt, dan membutuhkan should_texture: true.
- Model tidak didukung untuk tekstur multi-view: texture_image_urls membutuhkan ai_model meshy-7.1 atau latest.
- URL tidak dapat dijangkau: Satu atau lebih elemen image_urls atau texture_image_urls tidak dapat diunduh.
- Gambar terlalu besar: Satu atau lebih gambar image_urls, texture_image_url, atau texture_image_urls melebihi 20 MB.
- Resolusi tidak didukung untuk input multi-gambar: geometry_resolution: "4k" tidak tersedia pada endpoint ini; gunakan 2k atau standard.
- Model tidak didukung untuk opsi gambar: image_enhancement atau remove_lighting diatur dengan ai_model: "meshy-6-lite".
Name
401 - Unauthorized
Description
Autentikasi gagal. Silakan periksa kunci API Anda.
Name
402 - Payment Required
Description
Kredit tidak cukup untuk melakukan task ini.
Name
429 - Too Many Requests
Description
Anda telah melampaui batas laju 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

Retrieve a Multi-Image to 3D Task

Endpoint ini memungkinkan Anda untuk mengambil task Multi-Gambar ke 3D dengan id task yang valid. Lihat The Multi-Image to 3D Task Object untuk melihat properti apa saja yang disertakan dalam objek task Multi-Gambar ke 3D.

Parameter

Name
id
Type
path
Description
Pengenal unik untuk task Multi-Gambar ke 3D yang ingin diambil.

Returns

Respons berisi objek task Multi-Gambar ke 3D. Periksa bagian The Multi-Image to 3D Task Object untuk detailnya.

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

Hapus Task Multi-Gambar ke 3D

Endpoint ini menghapus task Multi-Gambar ke 3D secara permanen, termasuk semua model dan data yang terkait. Tindakan ini tidak dapat dibatalkan.

Path Parameters

Name
id
Type
path
Description
ID dari task Multi-Gambar ke 3D yang akan dihapus.

Status Task

Task yang masih berstatus PENDING akan dihapus dan kredit yang terpakai saat pembuatan task akan dikembalikan.

Task yang sudah berstatus IN_PROGRESS tidak dapat dihapus: permintaan akan ditolak dengan 409 Conflict dan task tetap berjalan. Kredit untuk task yang sudah mulai dikerjakan oleh worker tidak dapat dikembalikan, sehingga menghapusnya di tengah proses akan membuat Anda kehilangan kredit sekaligus hasilnya. Tunggu hingga task mencapai status SUCCEEDED, FAILED atau CANCELED, lalu hapus task tersebut.

Task dalam status akhir (SUCCEEDED, FAILED atau CANCELED) akan dihapus tanpa pengembalian kredit.

Returns

Mengembalikan 200 OK jika berhasil, atau 409 Conflict ketika task berstatus 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

List Multi-Image to 3D Tasks

Endpoint ini memungkinkan Anda untuk mengambil daftar tugas Multi-Gambar ke 3D.

Parameter

Atribut opsional

Name
page_num
Type
integer
Description
Nomor halaman untuk paginasi. Dimulai dan defaultnya adalah 1.
Name
page_size
Type
integer
Description
Batas ukuran halaman. Defaultnya adalah 10 item. Maksimum yang diizinkan adalah 100 item.
Name
sort_by
Type
string
Description
Kolom untuk pengurutan. Nilai yang tersedia:
- +created_at: Urutkan berdasarkan waktu pembuatan secara menaik (ascending).
- -created_at: Urutkan berdasarkan waktu pembuatan secara menurun (descending).

Pengembalian

Mengembalikan daftar berpaginasi dari Objek Tugas Multi-Gambar 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

Melakukan Streaming Tugas Multi-Gambar ke 3D

Endpoint ini melakukan streaming pembaruan secara real-time untuk tugas Multi-Gambar ke 3D menggunakan Server-Sent Events (SSE).

Parameter

Name
id
Type
path
Description
Pengidentifikasi unik untuk tugas Multi-Gambar ke 3D yang akan di-stream.

Returns

Mengembalikan stream dari The Multi-Image to 3D Task Objects sebagai Server-Sent Events.

Untuk tugas PENDING atau IN_PROGRESS, stream respons hanya akan menyertakan field 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
}

The Multi-Image to 3D Task Object

Objek Multi-Gambar ke 3D adalah unit kerja yang dilacak oleh Meshy untuk menghasilkan model 3D dari beberapa gambar (antara 1 hingga 4 gambar). Gambar-gambar tersebut harus berupa objek yang sama, idealnya dari sudut pandang atau sudut yang berbeda. Objek ini memiliki properti-properti berikut:

Properties

Name
id
Type
string
Description
Pengenal unik untuk tugas tersebut. Meskipun kami menggunakan UUID yang dapat diurutkan secara k (k-sortable) untuk id tugas sebagai detail implementasi, Anda tidak boleh membuat asumsi apa pun tentang format id tersebut.
Name
type
Type
string
Description
Tipe dari tugas Multi-Gambar ke 3D. Nilainya adalah multi-image-to-3d.
Name
model_urls
Type
object
Description
URL yang dapat diunduh untuk file model 3D bertekstur yang dihasilkan oleh Meshy. Properti untuk suatu format akan dihilangkan jika format tersebut tidak dihasilkan, alih-alih mengembalikan string kosong.
- Name
  glb
  Type
  string
  Description
  URL yang dapat diunduh untuk file GLB.
- Name
  fbx
  Type
  string
  Description
  URL yang dapat diunduh untuk file FBX.
- Name
  obj
  Type
  string
  Description
  URL yang dapat diunduh untuk file OBJ.
- Name
  usdz
  Type
  string
  Description
  URL yang dapat diunduh untuk file USDZ.
- Name
  mtl
  Type
  string
  Description
  URL yang dapat diunduh untuk file MTL, dikembalikan bersama ekspor OBJ ketika tekstur tersedia.
- Name
  stl
  Type
  string
  Description
  URL yang dapat diunduh untuk file STL.
- Name
  3mf
  Type
  string
  Description
  URL yang dapat diunduh untuk file 3MF. Hanya ada ketika 3mf diminta melalui target_formats.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  URL yang dapat diunduh untuk output GLB asli sebelum remesh.
  Hanya tersedia ketika tugas dibuat dengan should_remesh: true dan save_pre_remeshed_model: true sekaligus.
Name
thumbnail_url
Type
string
Description
URL yang dapat diunduh untuk gambar thumbnail dari file model. Setara dengan thumbnail_urls.front jika ada, dipertahankan untuk kompatibilitas mundur.
Name
alpha_thumbnail_url
Type
string
Description
URL yang dapat diunduh untuk versi latar belakang transparan (RGBA) dari thumbnail_url. Hanya ada ketika tugas dibuat dengan alpha_thumbnail: true dan pratinjau transparan berhasil dirender; jika tidak, kolom ini dihilangkan.
Name
thumbnail_urls
Type
object
Description
URL yang dapat diunduh untuk empat thumbnail tampilan kardinal dari model 3D yang dihasilkan. Setiap nilai adalah URL bertanda tangan menuju gambar PNG 512×512 yang dirender dengan material dan pencahayaan yang sama seperti thumbnail_url. Berguna untuk melihat pratinjau model dari berbagai sudut dalam alur kerja batch tanpa perlu mengunduh GLB.
Hanya ada ketika tugas dibuat dengan multi_view_thumbnails: true dan telah mencapai status SUCCEEDED. Tugas lama dan tugas yang dibuat tanpa opsi ini tidak akan menyertakan kolom ini.
- Name
  front
  Type
  string
  Description
  Tampilan depan, rotasi 0° pada sumbu vertikal (sesuai dengan thumbnail_url).
- Name
  right
  Type
  string
  Description
  Tampilan kanan, rotasi 90°.
- Name
  back
  Type
  string
  Description
  Tampilan belakang, rotasi 180°.
- Name
  left
  Type
  string
  Description
  Tampilan kiri, rotasi 270°.
Name
texture_prompt
Type
string
Description
Prompt teks yang digunakan untuk memandu proses pemberian tekstur.
Name
texture_image_urls
Type
string[]
Description
URL yang dapat diunduh untuk gambar referensi tekstur yang digunakan untuk membuat tugas, sesuai urutan saat diberikan. Hanya ada ketika tugas dibuat dengan texture_image_urls.
Name
ultra_mode
Type
boolean
⚠ usang
Description
Usang; gunakan geometry_resolution sebagai gantinya.
Name
geometry_resolution
Type
string
Description
Tingkatan Ultra yang dijalankan oleh tugas (2k); dihilangkan untuk standard.
Name
progress
Type
integer
Description
Progres dari tugas. Jika tugas belum dimulai, properti ini akan bernilai 0. Setelah tugas berhasil, nilainya akan menjadi 100.
Name
started_at
Type
timestamp
Description
Stempel waktu saat tugas dimulai, dalam milidetik. Jika tugas belum dimulai, properti ini akan bernilai 0.
Stempel waktu merepresentasikan jumlah milidetik yang berlalu sejak 1 Januari 1970 UTC, mengikuti standar RFC 3339. Sebagai contoh, Jumat, 1 September 2023 pukul 12:00:00 GMT direpresentasikan sebagai 1693569600000. Hal ini berlaku untuk semua stempel waktu di Meshy API.
Name
created_at
Type
timestamp
Description
Stempel waktu saat tugas dibuat, dalam milidetik.
Name
expires_at
Type
timestamp
Description
Stempel waktu saat hasil tugas kedaluwarsa, dalam milidetik.
Name
finished_at
Type
timestamp
Description
Stempel waktu saat tugas selesai, dalam milidetik. Jika tugas belum selesai, properti ini akan bernilai 0.
Name
status
Type
string
Description
Status dari tugas. Nilai yang mungkin adalah salah satu dari PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Sebuah array objek URL tekstur yang dihasilkan dari tugas. Biasanya ini hanya berisi satu objek URL tekstur. Setiap URL tekstur memiliki properti-properti berikut:
- Name
  base_color
  Type
  string
  Description
  URL yang dapat diunduh untuk gambar peta warna dasar.
- Name
  metallic
  Type
  string
  Description
  URL yang dapat diunduh untuk gambar peta metalik.
  Jika tugas dibuat dengan enable_pbr: false, properti ini akan dihilangkan.
- Name
  normal
  Type
  string
  Description
  URL yang dapat diunduh untuk gambar normal map.
  Jika tugas dibuat dengan enable_pbr: false, properti ini akan dihilangkan.
- Name
  roughness
  Type
  string
  Description
  URL yang dapat diunduh untuk gambar peta kekasaran.
  Jika tugas dibuat dengan enable_pbr: false, properti ini akan dihilangkan.
- Name
  emission
  Type
  string
  Description
  URL yang dapat diunduh untuk gambar peta emisi.
  Jika tugas dibuat dengan enable_pbr: false, atau ai_model adalah meshy-6-lite, meshy-7.1, atau latest, properti ini akan dihilangkan.
Name
preceding_tasks
Type
integer
Description
Jumlah tugas yang mendahului.
Nilai dari kolom ini hanya bermakna jika status tugas adalah PENDING.
Name
task_error
Type
object
Description
Detail kesalahan untuk tugas yang gagal. Lihat Kesalahan untuk referensi lengkap objek task_error.
Name
consumed_credits
Type
integer
Description
Jumlah kredit yang dikonsumsi oleh tugas ini. Ada ketika status tugas adalah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugas FAILED (kredit dikembalikan jika 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,
}