API Multi-Gambar ke 3D

Hasilkan model 3D dari satu hingga empat gambar objek yang sama, yang diambil dari sudut yang berbeda.

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

Membuat task Multi-Gambar ke 3D

Membuat task Multi-Gambar ke 3D. Task berjalan di latar belakang. Untuk perkiraan berapa lama sebuah task biasanya berlangsung, lihat Waktu pemrosesan. Untuk kolom yang dimiliki sebuah task, lihat Objek task Multi-Gambar ke 3D.

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

# Textured with Meshy N1 from the input images, the first as the front view
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 front view image url or base64-encoded data URI>",
      "<your back view image url or base64-encoded data URI>"
    ],
    "ai_model": "meshy-7.1",
    "texture_model": "meshy-n1"
  }'

Response

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

Parameter

Name
input_task_id
Type
string
Wajib
Description
Wajib kecuali Anda mengirim image_urls. ID dari task Teks ke Gambar atau Gambar ke Gambar, termasuk yang multi-tampilan. Meshy menggunakan satu hingga empat gambarnya sebagai input. Task tersebut harus merupakan task yang Anda buat dengan API dan memiliki status SUCCEEDED.

Name
image_urls
Type
array
Wajib
Description
Wajib kecuali Anda mengirim input_task_id. Satu hingga empat gambar, masing-masing berupa URL publik atau Data URI, seperti data:image/jpeg;base64,<your base64-encoded image data>. Jika Anda mengirim keduanya, Meshy menggunakan input_task_id.
Setiap gambar harus berupa file .jpg, .jpeg, .png, atau .webp berukuran paling banyak 20 MB, dengan sisi paling kecil 32 piksel, dan paling banyak 178.956.970 piksel (lebar × tinggi). Lebih dari empat gambar akan mengembalikan 400.
Untuk hasil terbaik, gambar-gambar tersebut sebaiknya menampilkan objek yang sama dari sudut yang berbeda. Dengan meshy-7.1 atau latest, Meshy menggunakan gambar pertama sebagai tampilan depan, dan urutan gambar lainnya tidak masalah.

Name
ai_model
Type
string
default latest
Description
Model AI yang menghasilkan model 3D.
Nilai yang tersedia:
- latest: Meshy 7.1
- meshy-7.1
- meshy-6
- meshy-6-lite
- meshy-7: usang, kirim meshy-7.1 sebagai gantinya
Name
geometry_resolution
Type
string
default standard
Description
Seberapa banyak detail geometri yang akan dihasilkan.
Nilai yang tersedia:
- standard
- 2k: menjalankan tahap Ultra pada 2048³. Memerlukan meshy-7.1, latest, atau meshy-7 yang sudah usang.
Name
ultra_mode
Type
boolean
⚠ usang
default false
Description
Kirim geometry_resolution sebagai gantinya. ultra_mode: true sama dengan geometry_resolution: "2k".
Name
should_texture
Type
boolean
default true
Description
Apakah akan menghasilkan tekstur. true mengembalikan model bertekstur, dan false melewati tahap tekstur dan mengembalikan mesh tanpa tekstur.

Hanya berlaku ketika should_texture = true

Name
texture_model
Type
string
default depends on ai_model
Description
Model AI yang memberi tekstur pada model 3D dari beberapa tampilan, dalam task yang sama. Biarkan kosong untuk menggunakan model tekstur default untuk ai_model Anda. Ini tidak mengubah biaya kredit.
Nilai yang tersedia:
- meshy-7: Meshy 7, dengan peta PBR dan tekstur hingga 8K
- meshy-n1: Meshy N1, tekstur warna dasar 2K hanya dari gambar referensi
Setiap ai_model menerima keduanya. Permintaan bertekstur dengan meshy-6 atau meshy-6-lite akan mengembalikan 400, begitu juga opsi yang tidak didukung oleh model tekstur yang dipilih. Dengan should_texture: false, Meshy mengabaikan texture_model, tetapi nilai yang tidak dikenal tetap mengembalikan 400.
Dengan meshy-n1, Meshy memberi tekstur dari texture_image_urls atau texture_image_url, atau dari gambar input saat Anda tidak mengirim keduanya. Gambar pertama adalah tampilan depan. Model yang dihasilkan dengan lebih dari 7.999.999 segitiga akan menggagalkan task, dan Meshy mengembalikan kreditnya.
Lihat Model untuk mengetahui fungsi setiap model tekstur dan mana yang harus dipilih.
Name
enable_pbr
Type
boolean
default false
Description
Apakah akan juga menghasilkan peta metallic, roughness, dan normal, selain warna dasar. Model tekstur Meshy 6 juga menghasilkan peta emission, kecuali pada texture_resolution: 8k. Dengan texture_model: meshy-n1, true akan mengembalikan 400.
Name
texture_resolution
Type
string
default 2k
Description
Ukuran tekstur warna dasar. Ukuran yang lebih besar menangkap lebih banyak detail permukaan.
Nilai yang tersedia:
- 2k: 2048×2048
- 4k: 4096×4096
- 8k: 8192×8192
4k dan 8k memerlukan model tekstur Meshy 7 atau Meshy 6, dan mengembalikan 400 dengan model lainnya. Pada 8k, Meshy tidak menghasilkan peta emission.
Name
hd_texture
Type
boolean
⚠ usang
default false
Description
Kirim texture_resolution sebagai gantinya. hd_texture: true sama dengan texture_resolution: "4k". Jika Anda mengirim keduanya, Meshy menggunakan texture_resolution.
Name
texture_prompt
Type
string
Description
Teks yang memandu tekstur, hingga 800 karakter. Teks yang lebih panjang akan mengembalikan 400. Dengan texture_model: meshy-n1, mengirim ini akan mengembalikan 400.
Name
texture_image_url
Type
string
Description
Satu gambar 2D yang memandu tekstur, berupa URL publik atau Data URI, seperti data:image/jpeg;base64,<your base64-encoded image data>. Gambar harus berupa file .jpg, .jpeg, .png, atau .webp berukuran paling banyak 20 MB, dengan sisi paling kecil 32 piksel, dan paling banyak 178.956.970 piksel (lebar × tinggi).
Jika Anda mengirim texture_image_url dan texture_prompt sekaligus, Meshy menggunakan texture_prompt. Dengan texture_model: meshy-n1, Meshy memberi tekstur dari gambar ini sebagai tampilan depan.
Tekstur mungkin tidak dihasilkan dengan baik jika bentuk dalam gambar sangat berbeda dari model 3D.
Name
texture_image_urls
Type
string[]
Description
Satu hingga empat gambar objek dari tampilan yang berbeda yang memandu tekstur. Meshy menggunakan gambar pertama sebagai tampilan depan. Urutan tampilan lainnya (kiri, belakang, kanan) tidak masalah.
Setiap gambar mengikuti aturan yang sama seperti texture_image_url. Berupa URL publik atau Data URI, dalam format .jpg, .jpeg, .png, atau .webp, paling banyak 20 MB, dengan sisi paling kecil 32 piksel, dan paling banyak 178.956.970 piksel (lebar × tinggi).
Gambar-gambar ini hanya memandu tekstur dan tidak bergantung pada image_urls. Kedua daftar dapat memuat gambar yang berbeda dan jumlah gambar yang berbeda.
texture_image_urls memerlukan model tekstur Meshy 7 atau Meshy N1. Kirim bersama salah satu dari berikut:
- ai_model berupa meshy-7.1, latest, atau meshy-7 yang sudah usang
- texture_model berupa meshy-7 atau meshy-n1
Anda tidak dapat mengirimnya bersama texture_image_url atau texture_prompt.

Name
should_remesh
Type
boolean
default true (meshy-6-lite), false (other models)
Description
Apakah akan melakukan remesh pada model setelah pembuatan. Untuk model 3D dengan kualitas tertinggi, atur ke false.

Hanya berlaku ketika should_remesh = true

Name
topology
Type
string
default triangle
Description
Jenis wajah dari model yang di-remesh.
Nilai yang tersedia:
- quad: mesh yang didominasi quad
- triangle: mesh segitiga yang didesimasi
Dengan texture_model: meshy-n1, quad akan mengembalikan 400 saat model di-remesh, yang secara default dilakukan oleh meshy-6-lite.
Name
target_polycount
Type
integer
default 30000
Description
Jumlah wajah yang ditargetkan, dari 100 hingga 300000. Hasilnya dapat berbeda dari target, tergantung pada geometri model. Nilai di luar rentang akan mengembalikan 400.
Name
decimation_mode
Type
integer
Description
Jumlah wajah adaptif, berdasarkan level. Saat Anda mengaturnya, Meshy mengabaikan target_polycount.
Nilai yang tersedia:
- 1: ultra
- 2: tinggi
- 3: sedang
- 4: rendah
Name
save_pre_remeshed_model
Type
boolean
default false
Description
Apakah akan juga menyimpan GLB dari sebelum remesh, dikembalikan dalam model_urls.pre_remeshed_glb.

Name
symmetry_mode
Type
string
⚠ usang
default auto
Description
Biarkan kosong. Ini tidak memengaruhi output.
Nilai yang tersedia:
- off: tanpa simetri
- auto: simetri berdasarkan geometri input
- on: simetri yang dipaksakan
Name
pose_mode
Type
string
default ""
Description
Pose dari model yang dihasilkan.
Nilai yang tersedia:
- a-pose: pose A
- t-pose: pose T
- "" (string kosong): tanpa pose tertentu
Name
is_a_t_pose
Type
boolean
⚠ usang
default false
Description
Kirim pose_mode sebagai gantinya. Apakah akan menghasilkan model dalam pose A atau T.
Name
image_enhancement
Type
boolean
default true
Description
Apakah akan mengoptimalkan gambar input sebelum pembuatan. false mempertahankan tampilan persis dari gambar input, tanpa pemrosesan gaya. Hanya didukung dengan meshy-6, meshy-7.1, atau latest. Mengirim ini dengan meshy-6-lite akan mengembalikan 400.
Name
remove_lighting
Type
boolean
default true
Description
Apakah akan menghapus highlight dan bayangan dari tekstur warna dasar. Hasil yang lebih bersih bekerja lebih baik di bawah pencahayaan Anda sendiri. Hanya model tekstur Meshy 6 yang menggunakannya, dan pada texture_resolution: 8k selalu menghapus pencahayaan. Dengan texture_model: meshy-n1, true akan mengembalikan 400. Dengan ai_model: meshy-6-lite dan model teksturnya yang default, mengirim ini akan mengembalikan 400.
Name
moderation
Type
boolean
default false
Description
Apakah akan menyaring input untuk konten berbahaya. Meshy menyaring setiap gambar input, texture_image_url atau setiap gambar dalam texture_image_urls, dan teks dalam texture_prompt. Jika Meshy menemukan konten berbahaya, permintaan akan mengembalikan 400 dan Meshy tidak membuat task.
Name
target_formats
Type
string[]
Description
Format file 3D yang akan dihasilkan. Meshy hanya menghasilkan dan mengembalikan format yang Anda cantumkan, yang dapat mempersingkat task.
Nilai yang tersedia:
- glb
- obj
- fbx
- stl
- usdz
- 3mf
Jika Anda tidak mencantumkannya, Meshy menghasilkan semua format kecuali 3mf. Meshy menghasilkan 3mf hanya saat Anda mencantumkannya.
Name
auto_size
Type
boolean
default false
Description
Apakah akan memperkirakan tinggi objek di dunia nyata menggunakan AI vision dan mengubah ukuran model sesuai itu. Meshy menempatkan titik asal di bagian bawah kecuali Anda mengatur origin_at.

Hanya berlaku ketika auto_size = true

Name
origin_at
Type
string
default bottom
Description
Di mana menempatkan titik asal model, bottom atau center.

Name
alpha_thumbnail
Type
boolean
default false
Description
Apakah akan juga merender pratinjau dengan latar belakang transparan (RGBA), dikembalikan dalam alpha_thumbnail_url saat Anda mengambil task tersebut. thumbnail_url tidak berubah.
Name
multi_view_thumbnails
Type
boolean
default false
Description
Apakah akan juga merender pratinjau depan, kanan, belakang, dan kiri, dikembalikan dalam thumbnail_urls saat Anda mengambil task tersebut. thumbnail_url tidak berubah dan tetap menampilkan tampilan depan. Ini menambah sekitar 5 detik pada task.

Hasil

Kolom result pada respons menyimpan ID dari task Multi-Gambar ke 3D yang baru.

Mode kegagalan

Name
400 - Bad Request
Description
Permintaan tidak dapat dijalankan. Pesan kesalahan menunjukkan masalah apa yang ditemukan. Contohnya:
- Parameter hilang: Baik image_urls maupun input_task_id tidak dikirim.
- Task input tidak valid: input_task_id bukan task Teks ke Gambar atau Gambar ke Gambar dengan status SUCCEEDED, atau bukan yang multi-tampilan.
- Jumlah gambar tidak valid: image_urls atau texture_image_urls tidak memuat 1 hingga 4 gambar.
- Format gambar tidak valid: Sebuah gambar dalam image_urls tidak dalam format yang didukung.
- Input tekstur yang saling bertentangan: texture_image_urls dikirim bersama texture_image_url, dengan texture_prompt, atau dengan should_texture: false.
- Model tidak didukung untuk tekstur multi-tampilan: texture_image_urls dikirim bersama ai_model berupa meshy-6 atau meshy-6-lite, kecuali texture_model adalah meshy-7 atau meshy-n1.
- URL tidak dapat dijangkau: Meshy tidak dapat mengunduh gambar dalam image_urls atau texture_image_urls.
- Gambar terlalu besar: Sebuah gambar dalam image_urls, texture_image_url, atau texture_image_urls berukuran lebih dari 20 MB.
- Ukuran gambar tidak valid: Sebuah gambar dalam image_urls, texture_image_url, atau texture_image_urls memiliki sisi lebih pendek dari 32 piksel, atau lebih dari 178.956.970 piksel (lebar × tinggi).
- Resolusi tidak didukung untuk input multi-gambar: geometry_resolution adalah "4k", yang tidak didukung oleh endpoint ini. Gunakan 2k atau standard.
- Model tidak didukung untuk opsi gambar: image_enhancement dikirim bersama ai_model: "meshy-6-lite", atau remove_lighting dikirim bersama ai_model: "meshy-6-lite" dan model teksturnya yang default.
- Model tekstur tidak valid: texture_model bukan nama model tekstur yang valid.
- Model tekstur tidak tersedia: Permintaan bertekstur mengirim texture_model berupa meshy-6 atau meshy-6-lite. Multi-Gambar ke 3D hanya menerima model tekstur yang memberi tekstur dari beberapa tampilan. Kirim meshy-7 atau meshy-n1, atau biarkan texture_model tidak diisi.
- Opsi tidak didukung untuk model tekstur: Permintaan meminta opsi dari model tekstur yang tidak didukungnya, seperti enable_pbr: true dengan meshy-n1 atau tekstur 4k dengan meshy-6-lite. Lihat Model.
Perbaiki permintaan, lalu kirim lagi. Lihat Kesalahan.
Name
401 - Unauthorized
Description
Kunci API tidak ada atau tidak valid. Periksa header Authorization.
Name
402 - Payment Required
Description
Contohnya:
- Kredit tidak cukup: Akun tidak memiliki cukup kredit untuk task ini, atau akun mencapai batas kredit. Periksa saldo kredit Anda, lalu coba lagi.
- Paket gratis: Membuat task memerlukan paket berbayar. Tingkatkan paket Anda di pengaturan langganan, lalu coba lagi.
Name
403 - Forbidden
Description
Moderasi konten memblokir prompt atau gambar input. Ubah input, lalu coba lagi.
Name
404 - Not Found
Description
input_task_id tidak cocok dengan task Anda mana pun. Periksa ID task, lalu kirim permintaan lagi.
Name
429 - Too Many Requests
Description
Anda melampaui batas laju. Tunggu, lalu coba lagi. Lihat Batas laju.

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

Dapatkan task Multi-Gambar ke 3D

Mengembalikan task Multi-Gambar ke 3D berdasarkan ID-nya.

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"
    }
  ],
  "preceding_tasks": 0,
  "task_error": null,

  "consumed_credits": 30
}

Parameter

Name
id
Type
path
Description
ID task dari respons pembuatan.

Hasil

Objek task Multi-Gambar ke 3D.

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

Hapus tugas Multi-Gambar ke 3D

Menghapus secara permanen tugas Multi-Gambar ke 3D, termasuk model dan datanya. Anda tidak dapat membatalkan penghapusan.

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

Parameter path

Name
id
Type
path
Description
ID dari tugas yang akan dihapus.

Status tugas

Menghapus tugas PENDING akan mengembalikan kredit yang digunakan saat Anda membuatnya.

Tugas IN_PROGRESS tidak dapat dihapus. Permintaan akan mengembalikan 409 Conflict, dan tugas tersebut tetap berjalan. Meshy tidak mengembalikan kredit untuk tugas yang sudah dimulai, jadi menghapusnya akan membuat Anda kehilangan baik kredit maupun hasilnya. Tunggu hingga tugas mencapai status SUCCEEDED, FAILED, atau CANCELED, baru kemudian hapus.

Menghapus tugas dalam status akhir (SUCCEEDED, FAILED, atau CANCELED) tidak mengembalikan kreditnya.

Mengembalikan

200 OK ketika tugas berhasil dihapus, atau 409 Conflict ketika tugas berstatus IN_PROGRESS.

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

List tugas Multi-Gambar ke 3D

Mengembalikan daftar tugas Multi-Gambar ke 3D Anda.

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"
      }
    ],
    "preceding_tasks": 0,
    "task_error": null,

    "consumed_credits": 30
  }
]

Parameter

Name
page_num
Type
integer
default 1
Description
Nomor halaman yang akan dikembalikan, hingga 255. Nilai yang lebih besar akan mengembalikan 400.
Name
page_size
Type
integer
default 10
Description
Jumlah tugas per halaman, hingga 100.
Name
sort_by
Type
string
Description
Urutan pengurutan.
Nilai yang tersedia:
- +created_at: terlama lebih dulu
- -created_at: terbaru lebih dulu

Hasil Pengembalian

Daftar berhalaman dari objek tugas Multi-Gambar ke 3D.

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

Streaming tugas Multi-Gambar ke 3D

Melakukan streaming pembaruan tugas Multi-Gambar ke 3D sebagai Server-Sent Events (SSE).

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.
// These examples are shortened. Each event holds the full task object.
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"
    }
  ],
  "preceding_tasks": 0,
  "task_error": null,

  "consumed_credits": 30
}

Parameter

Name
id
Type
path
Description
ID tugas dari respons pembuatan.

Hasil Pengembalian

Sebuah stream dari objek tugas Multi-Gambar ke 3D sebagai Server-Sent Events.

Setiap event berisi objek tugas lengkap, dalam bentuk yang sama seperti yang dikembalikan oleh endpoint Get. Selama tugas berstatus PENDING atau IN_PROGRESS, kolom hasilnya belum memiliki nilai.

Objek tugas Multi-Gambar ke 3D

Objek tugas Multi-Gambar ke 3D menjelaskan satu proses pembuatan model 3D dari satu hingga empat gambar sebuah objek. Objek ini menyimpan status, progress, dan file model ketika tugas berhasil.

Properti

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"
    }
  ],
  "preceding_tasks": 0,
  "task_error": null,

  "consumed_credits": 30
}

Name
id
Type
string
Description
ID tugas. Perlakukan sebagai string buram, dan jangan bergantung pada formatnya.
Name
type
Type
string
Description
Jenis tugas, selalu multi-image-to-3d.
Name
model_urls
Type
object
Description
URL unduhan untuk model 3D yang dihasilkan, satu untuk setiap format file. Format yang tidak dihasilkan oleh tugas tidak memiliki kunci, bukan string kosong.
- Name
  glb
  Type
  string
  Description
  File GLB.
- Name
  fbx
  Type
  string
  Description
  File FBX.
- Name
  obj
  Type
  string
  Description
  File OBJ.
- Name
  usdz
  Type
  string
  Description
  File USDZ.
- Name
  mtl
  Type
  string
  Description
  File MTL, dikembalikan bersama file OBJ saat model memiliki tekstur.
- Name
  stl
  Type
  string
  Description
  File STL.
- Name
  3mf
  Type
  string
  Description
  File 3MF. Hanya ada ketika target_formats menyertakan 3mf.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  File GLB dari sebelum remesh. Hanya ada ketika Anda membuat tugas dengan should_remesh: true dan save_pre_remeshed_model: true sekaligus.
Name
thumbnail_url
Type
string
Description
URL unduhan untuk gambar pratinjau model. Nilainya sama dengan thumbnail_urls.front ketika field tersebut ada.
Name
alpha_thumbnail_url
Type
string
Description
URL unduhan untuk versi thumbnail_url dengan latar belakang transparan (RGBA). Hanya ada ketika Anda membuat tugas dengan alpha_thumbnail: true dan Meshy merender pratinjau transparan tersebut.
Name
thumbnail_urls
Type
object
Description
URL unduhan untuk pratinjau model 3D dari empat sisi. Setiap URL adalah signed URL ke PNG berukuran 512×512, dirender dengan material dan pencahayaan yang sama seperti thumbnail_url. Anda dapat menggunakannya untuk melihat pratinjau model dari beberapa sudut tanpa mengunduh GLB.
Hanya ada ketika Anda membuat tugas dengan multi_view_thumbnails: true dan tugas mencapai SUCCEEDED. Tugas yang dibuat tanpa multi_view_thumbnails: true tidak memiliki field ini.
- Name
  front
  Type
  string
  Description
  Tampilan depan, pada 0° di sekitar sumbu vertikal. Nilainya sama dengan thumbnail_url.
- Name
  right
  Type
  string
  Description
  Tampilan kanan, pada 90°.
- Name
  back
  Type
  string
  Description
  Tampilan belakang, pada 180°.
- Name
  left
  Type
  string
  Description
  Tampilan kiri, pada 270°.
Name
texture_prompt
Type
string
Description
Prompt teks yang memandu tekstur.
Name
texture_image_urls
Type
string[]
Description
URL unduhan untuk gambar referensi tekstur yang Anda gunakan saat membuat tugas, dalam urutan Anda mengirimkannya. Hanya ada ketika Anda membuat tugas dengan texture_image_urls.
Name
ultra_mode
Type
boolean
⚠ usang
Description
Gunakan geometry_resolution sebagai gantinya.
Name
geometry_resolution
Type
string
Description
Tingkatan Ultra yang dijalankan tugas, yaitu 2k. Tugas standard tidak memiliki field ini.
Name
progress
Type
integer
Description
Seberapa banyak tugas yang telah selesai, dalam persentase. Nilainya 0 sampai tugas dimulai dan 100 ketika tugas berhasil.
Name
started_at
Type
timestamp
Description
Waktu tugas dimulai, dalam milidetik Unix. Nilainya 0 sampai tugas dimulai.
Name
created_at
Type
timestamp
Description
Waktu tugas dibuat, dalam milidetik Unix.
Name
expires_at
Type
timestamp
Description
Waktu hasil tugas kedaluwarsa, dalam milidetik Unix.
Name
finished_at
Type
timestamp
Description
Waktu tugas selesai, dalam milidetik Unix. Nilainya 0 sampai tugas selesai.
Name
status
Type
string
Description
Status tugas, salah satu dari PENDING, IN_PROGRESS, SUCCEEDED, FAILED, atau CANCELED.
Name
texture_urls
Type
array
Description
URL unduhan untuk peta tekstur yang dihasilkan tugas, sebagai array objek. Biasanya berisi satu objek. Setiap objek memiliki field berikut:
- Name
  base_color
  Type
  string
  Description
  Peta warna dasar.
- Name
  metallic
  Type
  string
  Description
  Peta metallic. Tidak disertakan ketika Anda membuat tugas dengan enable_pbr: false.
- Name
  normal
  Type
  string
  Description
  Normal map. Tidak disertakan ketika Anda membuat tugas dengan enable_pbr: false.
- Name
  roughness
  Type
  string
  Description
  Peta roughness. Tidak disertakan ketika Anda membuat tugas dengan enable_pbr: false.
- Name
  emission
  Type
  string
  Description
  Peta emission. Hanya disertakan ketika Anda membuat tugas dengan semua kondisi berikut:
  
  ai_model: meshy-6, dengan model tekstur bawaannya
  
  enable_pbr: true
  
  texture_resolution bernilai 2k atau 4k
Name
preceding_tasks
Type
integer
Description
Jumlah tugas yang berada di depan tugas ini dalam antrean. Nilai ini hanya berarti selama tugas berstatus PENDING.
Name
task_error
Type
object
Description
Detail kesalahan ketika tugas gagal. Nilainya null kecuali statusnya FAILED. Lihat Kesalahan.
Name
consumed_credits
Type
integer
Description
Jumlah kredit yang digunakan tugas. Ada ketika statusnya PENDING, IN_PROGRESS, atau SUCCEEDED. Nilainya 0 untuk tugas FAILED, karena Meshy mengembalikan kredit ketika tugas gagal.