API Berbilang Imej ke 3D

Jana model 3D daripada satu hingga empat imej objek yang sama, diambil dari sudut yang berbeza.

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

Cipta tugasan Berbilang Imej ke 3D

Mencipta tugasan Berbilang Imej ke 3D. Tugasan berjalan di latar belakang. Untuk tempoh biasa tugasan ini, lihat Masa pemprosesan. Untuk medan yang dimiliki oleh sesuatu tugasan, lihat Objek tugasan Berbilang Imej 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
Diperlukan
Description
Diperlukan kecuali anda menghantar image_urls. ID bagi tugasan Teks ke Imej atau Imej ke Imej, termasuk tugasan berbilang pandangan. Meshy menggunakan satu hingga empat imejnya sebagai input. Tugasan tersebut mestilah yang anda cipta menggunakan API dan mempunyai status SUCCEEDED.

Name
image_urls
Type
array
Diperlukan
Description
Diperlukan kecuali anda menghantar input_task_id. Satu hingga empat imej, setiap satu sebagai URL awam atau Data URI, seperti data:image/jpeg;base64,<data imej anda yang dikodkan base64>. Jika anda menghantar kedua-duanya, Meshy menggunakan input_task_id.
Setiap imej mestilah fail .jpg, .jpeg, .png, atau .webp bersaiz maksimum 20 MB, sekurang-kurangnya 32 piksel pada setiap sisi, dan maksimum 178,956,970 piksel (lebar × tinggi). Lebih daripada empat imej akan memulangkan 400.
Untuk hasil terbaik, imej-imej tersebut harus menunjukkan objek yang sama dari sudut yang berbeza. Dengan meshy-7.1 atau latest, Meshy menggunakan imej pertama sebagai pandangan hadapan, dan susunan imej lain tidak penting.

Name
ai_model
Type
string
lalai latest
Description
Model AI yang menjana model 3D.
Nilai yang tersedia:
- latest: Meshy 7.1
- meshy-7.1
- meshy-6
- meshy-6-lite
- meshy-7: lapuk, hantar meshy-7.1 sebagai gantinya
Name
geometry_resolution
Type
string
lalai standard
Description
Sejauh mana perincian geometri yang perlu dijana.
Nilai yang tersedia:
- standard
- 2k: menjalankan laluan Ultra pada 2048³. Memerlukan meshy-7.1, latest, atau meshy-7 yang lapuk.
Name
ultra_mode
Type
boolean
⚠ lapuk
lalai false
Description
Hantar geometry_resolution sebagai gantinya. ultra_mode: true adalah sama dengan geometry_resolution: "2k".
Name
should_texture
Type
boolean
lalai true
Description
Sama ada untuk menjana tekstur. true memulangkan model bertekstur, dan false melangkau langkah tekstur dan memulangkan jejaring tanpa tekstur.

Hanya berlaku apabila should_texture = true

Name
texture_model
Type
string
lalai depends on ai_model
Description
Model AI yang mentekstur model 3D daripada beberapa pandangan, dalam tugasan yang sama. Biarkan kosong untuk menggunakan model tekstur lalai bagi ai_model anda. Ia tidak mengubah kos kredit.
Nilai yang tersedia:
- meshy-7: Meshy 7, dengan peta PBR dan tekstur sehingga 8K
- meshy-n1: Meshy N1, tekstur warna asas 2K hanya daripada imej rujukan
Setiap ai_model menerima kedua-duanya. Permintaan bertekstur dengan meshy-6 atau meshy-6-lite memulangkan 400, begitu juga dengan pilihan yang tidak disokong oleh model tekstur yang dipilih. Dengan should_texture: false, Meshy mengabaikan texture_model, tetapi nilai yang tidak dikenali tetap memulangkan 400.
Dengan meshy-n1, Meshy mentekstur daripada texture_image_urls atau texture_image_url, atau daripada imej input apabila anda tidak menghantar kedua-duanya. Imej pertama adalah pandangan hadapan. Model yang dijana melebihi 7,999,999 segi tiga menyebabkan tugasan gagal, dan Meshy memulangkan semula kredit untuknya.
Lihat Model untuk mengetahui apa yang dilakukan oleh setiap model tekstur dan yang mana hendak dipilih.
Name
enable_pbr
Type
boolean
lalai false
Description
Sama ada untuk turut menjana peta metalik, kekasaran, dan normal, sebagai tambahan kepada warna asas. Model tekstur Meshy 6 juga menjana peta pancaran, kecuali pada texture_resolution: 8k. Dengan texture_model: meshy-n1, true memulangkan 400.
Name
texture_resolution
Type
string
lalai 2k
Description
Saiz tekstur warna asas. Saiz yang lebih besar menangkap lebih banyak perincian 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 memulangkan 400 dengan yang lain. Pada 8k, Meshy tidak menjana peta pancaran.
Name
hd_texture
Type
boolean
⚠ lapuk
lalai false
Description
Hantar texture_resolution sebagai gantinya. hd_texture: true adalah sama dengan texture_resolution: "4k". Jika anda menghantar kedua-duanya, Meshy menggunakan texture_resolution.
Name
texture_prompt
Type
string
Description
Teks yang memandu tekstur, sehingga 800 aksara. Teks yang lebih panjang memulangkan 400. Dengan texture_model: meshy-n1, menghantarnya memulangkan 400.
Name
texture_image_url
Type
string
Description
Satu imej 2D yang memandu tekstur, sebagai URL awam atau Data URI, seperti data:image/jpeg;base64,<data imej anda yang dikodkan base64>. Imej tersebut mestilah fail .jpg, .jpeg, .png, atau .webp bersaiz maksimum 20 MB, sekurang-kurangnya 32 piksel pada setiap sisi, dan maksimum 178,956,970 piksel (lebar × tinggi).
Jika anda menghantar kedua-dua texture_image_url dan texture_prompt, Meshy menggunakan texture_prompt. Dengan texture_model: meshy-n1, Meshy mentekstur daripada imej ini sebagai pandangan hadapan.
Tekstur mungkin tidak terhasil dengan baik apabila bentuk dalam imej jauh berbeza daripada model 3D.
Name
texture_image_urls
Type
string[]
Description
Satu hingga empat imej objek dari pandangan yang berbeza yang memandu tekstur. Meshy menggunakan imej pertama sebagai pandangan hadapan. Susunan pandangan lain (kiri, belakang, kanan) tidak penting.
Setiap imej mengikuti peraturan yang sama seperti texture_image_url. Ia adalah URL awam atau Data URI, dalam format .jpg, .jpeg, .png, atau .webp, bersaiz maksimum 20 MB, sekurang-kurangnya 32 piksel pada setiap sisi, dan maksimum 178,956,970 piksel (lebar × tinggi).
Imej-imej ini hanya memandu tekstur dan tidak bergantung kepada image_urls. Kedua-dua senarai boleh menyimpan imej yang berbeza dan bilangan imej yang berbeza.
texture_image_urls memerlukan model tekstur Meshy 7 atau Meshy N1. Hantarnya dengan salah satu daripada:
- ai_model iaitu meshy-7.1, latest, atau meshy-7 yang lapuk
- texture_model iaitu meshy-7 atau meshy-n1
Anda tidak boleh menghantarnya bersama texture_image_url atau texture_prompt.

Name
should_remesh
Type
boolean
lalai true (meshy-6-lite), false (other models)
Description
Sama ada untuk melakukan remesh pada model selepas penjanaan. Untuk model 3D berkualiti tertinggi, tetapkan kepada false.

Hanya berlaku apabila should_remesh = true

Name
topology
Type
string
lalai triangle
Description
Jenis permukaan bagi model yang di-remesh.
Nilai yang tersedia:
- quad: jejaring yang didominasi segi empat
- triangle: jejaring segi tiga yang dinyahkan
Dengan texture_model: meshy-n1, quad memulangkan 400 apabila model di-remesh, yang mana meshy-6-lite lakukan secara lalai.
Name
target_polycount
Type
integer
lalai 30000
Description
Bilangan permukaan yang disasarkan, dari 100 hingga 300000. Hasilnya boleh berbeza daripada sasaran, bergantung kepada geometri model. Nilai di luar julat memulangkan 400.
Name
decimation_mode
Type
integer
Description
Bilangan permukaan adaptif, mengikut tahap. Apabila anda menetapkannya, Meshy mengabaikan target_polycount.
Nilai yang tersedia:
- 1: ultra
- 2: tinggi
- 3: sederhana
- 4: rendah
Name
save_pre_remeshed_model
Type
boolean
lalai false
Description
Sama ada untuk turut menyimpan GLB sebelum remesh, dipulangkan dalam model_urls.pre_remeshed_glb.

Name
symmetry_mode
Type
string
⚠ lapuk
lalai auto
Description
Biarkan kosong. Ia tidak mempengaruhi output.
Nilai yang tersedia:
- off: tiada simetri
- auto: simetri berdasarkan geometri input
- on: simetri dikuatkuasakan
Name
pose_mode
Type
string
lalai ""
Description
Postur model yang dijana.
Nilai yang tersedia:
- a-pose: postur A
- t-pose: postur T
- "" (rentetan kosong): tiada postur tertentu
Name
is_a_t_pose
Type
boolean
⚠ lapuk
lalai false
Description
Hantar pose_mode sebagai gantinya. Sama ada untuk menjana model dalam postur A atau T.
Name
image_enhancement
Type
boolean
lalai true
Description
Sama ada untuk mengoptimumkan imej input sebelum penjanaan. false mengekalkan rupa sebenar imej input, tanpa pemprosesan gaya. Hanya disokong dengan meshy-6, meshy-7.1, atau latest. Menghantarnya dengan meshy-6-lite memulangkan 400.
Name
remove_lighting
Type
boolean
lalai true
Description
Sama ada untuk menghapuskan sorotan dan bayang-bayang daripada tekstur warna asas. Hasil yang lebih bersih berfungsi lebih baik di bawah pencahayaan anda sendiri. Hanya model tekstur Meshy 6 yang menggunakannya, dan pada texture_resolution: 8k ia sentiasa menghapuskan pencahayaan. Dengan texture_model: meshy-n1, true memulangkan 400. Dengan ai_model: meshy-6-lite dan model tekstur lalainya, menghantarnya memulangkan 400.
Name
moderation
Type
boolean
lalai false
Description
Sama ada untuk menyaring input bagi kandungan berbahaya. Meshy menyaring setiap imej input, texture_image_url atau setiap imej dalam texture_image_urls, dan teks dalam texture_prompt. Jika Meshy mengesan kandungan berbahaya, permintaan memulangkan 400 dan Meshy tidak mencipta tugasan.
Name
target_formats
Type
string[]
Description
Format fail 3D yang hendak dijana. Meshy hanya menjana dan memulangkan format yang anda senaraikan, yang boleh memendekkan tugasan.
Nilai yang tersedia:
- glb
- obj
- fbx
- stl
- usdz
- 3mf
Jika anda membiarkannya kosong, Meshy menjana setiap format kecuali 3mf. Meshy menjana 3mf hanya apabila anda menyenaraikannya.
Name
auto_size
Type
boolean
lalai false
Description
Sama ada untuk menganggarkan ketinggian sebenar objek menggunakan penglihatan AI dan mengubah saiz model mengikutnya. Meshy meletakkan titik asal di bahagian bawah kecuali anda menetapkan origin_at.

Hanya berlaku apabila auto_size = true

Name
origin_at
Type
string
lalai bottom
Description
Lokasi untuk meletakkan titik asal model, bottom atau center.

Name
alpha_thumbnail
Type
boolean
lalai false
Description
Sama ada untuk turut merender pratonton dengan latar belakang lutsinar (RGBA), dipulangkan dalam alpha_thumbnail_url apabila anda mendapatkan tugasan tersebut. thumbnail_url tidak berubah.
Name
multi_view_thumbnails
Type
boolean
lalai false
Description
Sama ada untuk turut merender pratonton hadapan, kanan, belakang, dan kiri, dipulangkan dalam thumbnail_urls apabila anda mendapatkan tugasan tersebut. thumbnail_url tidak berubah dan masih menunjukkan pandangan hadapan. Ini menambah lebih kurang 5 saat kepada tugasan.

Pulangan

Medan result dalam respons memegang ID bagi tugasan Berbilang Imej ke 3D yang baharu.

Mod kegagalan

Name
400 - Bad Request
Description
Permintaan tidak dapat dijalankan. Mesej ralat menyatakan masalah yang ditemui. Contohnya:
- Parameter hilang: Tiada image_urls mahupun input_task_id yang dihantar.
- Tugasan input tidak sah: input_task_id bukan tugasan Teks ke Imej atau Imej ke Imej yang berstatus SUCCEEDED, atau tugasan berbilang pandangan.
- Bilangan imej tidak sah: image_urls atau texture_image_urls tidak mengandungi 1 hingga 4 imej.
- Format imej tidak sah: Satu imej dalam image_urls bukan dalam format yang disokong.
- Input tekstur bercanggah: texture_image_urls dihantar bersama texture_image_url, dengan texture_prompt, atau dengan should_texture: false.
- Model tidak disokong untuk tekstur berbilang pandangan: texture_image_urls dihantar bersama ai_model iaitu meshy-6 atau meshy-6-lite, kecuali texture_model ialah meshy-7 atau meshy-n1.
- URL tidak boleh dicapai: Meshy tidak dapat memuat turun imej dalam image_urls atau texture_image_urls.
- Imej terlalu besar: Satu imej dalam image_urls, texture_image_url, atau texture_image_urls melebihi 20 MB.
- Saiz imej tidak sah: Satu imej dalam image_urls, texture_image_url, atau texture_image_urls mempunyai sisi lebih pendek daripada 32 piksel, atau melebihi 178,956,970 piksel (lebar × tinggi).
- Resolusi tidak disokong untuk input berbilang imej: geometry_resolution ialah "4k", yang tidak disokong oleh endpoint ini. Gunakan 2k atau standard.
- Model tidak disokong untuk pilihan imej: image_enhancement dihantar bersama ai_model: "meshy-6-lite", atau remove_lighting dihantar bersama ai_model: "meshy-6-lite" dan model tekstur lalainya.
- Model tekstur tidak sah: texture_model bukan nama model tekstur yang sah.
- Model tekstur tidak tersedia: Permintaan bertekstur menghantar texture_model iaitu meshy-6 atau meshy-6-lite. Berbilang Imej ke 3D hanya menerima model tekstur yang mentekstur daripada beberapa pandangan. Hantar meshy-7 atau meshy-n1, atau biarkan texture_model kosong.
- Pilihan tidak disokong untuk model tekstur: Permintaan meminta model tekstur untuk pilihan yang tidak disokongnya, seperti enable_pbr: true dengan meshy-n1 atau tekstur 4k dengan meshy-6-lite. Lihat Model.
Perbetulkan permintaan, kemudian hantar semula. Lihat Ralat.
Name
401 - Unauthorized
Description
Kunci API hilang atau tidak sah. Semak header Authorization.
Name
402 - Payment Required
Description
Contohnya:
- Kredit tidak mencukupi: Akaun tidak mempunyai kredit yang mencukupi untuk tugasan ini, atau akaun telah mencapai had kredit. Semak baki kredit anda, kemudian cuba semula.
- Pelan percuma: Mencipta tugasan memerlukan pelan berbayar. Naik taraf pelan anda dalam tetapan langganan anda, kemudian cuba semula.
Name
403 - Forbidden
Description
Moderasi kandungan menyekat prompt atau imej input. Ubah input, kemudian cuba semula.
Name
404 - Not Found
Description
input_task_id tidak sepadan dengan mana-mana tugasan anda. Semak ID tugasan, kemudian hantar permintaan semula.
Name
429 - Too Many Requests
Description
Anda telah melebihi had kadar anda. Tunggu, kemudian cuba semula. Lihat Had kadar.

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

Dapatkan tugas Berbilang Imej ke 3D

Mengembalikan tugas Berbilang Imej ke 3D mengikut 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 tugas daripada respons create.

Pulangan

Objek tugas Berbilang Imej ke 3D.

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

Padam tugas Berbilang Imej ke 3D

Memadamkan tugas Berbilang Imej ke 3D secara kekal, termasuk model dan data berkaitannya. Anda tidak boleh membatalkan tindakan padam ini.

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 laluan

Name
id
Type
path
Description
ID tugas yang hendak dipadam.

Status tugas

Memadamkan tugas PENDING akan memulangkan kredit yang digunakan semasa anda mencipta tugas tersebut.

Tugas IN_PROGRESS tidak boleh dipadam. Permintaan akan mengembalikan 409 Conflict, dan tugas tersebut akan terus berjalan. Meshy tidak memulangkan kredit untuk tugas yang telah bermula, jadi memadamkannya akan menyebabkan anda kehilangan kedua-dua kredit dan hasilnya. Tunggu sehingga ia mencapai status SUCCEEDED, FAILED, atau CANCELED, kemudian padamkannya.

Memadamkan tugas yang berada dalam status akhir (SUCCEEDED, FAILED, atau CANCELED) tidak akan memulangkan kreditnya.

Pulangan

200 OK apabila tugas berjaya dipadam, atau 409 Conflict apabila tugas berstatus IN_PROGRESS.

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

Senaraikan tugas Berbilang Imej ke 3D

Mengembalikan senarai tugas Berbilang Imej 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
lalai 1
Description
Nombor halaman yang hendak dikembalikan, sehingga 255. Nilai yang lebih besar akan mengembalikan 400.
Name
page_size
Type
integer
lalai 10
Description
Bilangan tugas setiap halaman, sehingga 100.
Name
sort_by
Type
string
Description
Susunan isihan.
Nilai yang tersedia:
- +created_at: paling lama dahulu
- -created_at: paling baru dahulu

Hasil

Senarai bersiri objek tugas Berbilang Imej ke 3D.

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

Strim tugas Berbilang Imej ke 3D

Menstrim kemas kini tugas Berbilang Imej 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 daripada respons create.

Pulangan

Strim objek tugas Berbilang Imej ke 3D sebagai Server-Sent Events.

Setiap event memegang objek tugas yang lengkap, dalam bentuk yang sama seperti yang dikembalikan oleh endpoint Get. Semasa tugas berstatus PENDING atau IN_PROGRESS, medan hasilnya masih belum mempunyai nilai.

Objek tugas Berbilang Imej ke 3D

Objek tugas Berbilang Imej ke 3D menerangkan satu penjanaan model 3D daripada satu hingga empat imej sesuatu objek. Ia menyimpan status, progress, dan fail model apabila tugas berjaya.

Ciri-ciri

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. Anggap ia sebagai rentetan legap, dan jangan bergantung pada formatnya.
Name
type
Type
string
Description
Jenis tugas, sentiasa multi-image-to-3d.
Name
model_urls
Type
object
Description
URL muat turun untuk model 3D yang dijana, satu bagi setiap format fail. Format yang tidak dijana oleh tugas tidak mempunyai kunci, bukannya rentetan kosong.
- Name
  glb
  Type
  string
  Description
  Fail GLB.
- Name
  fbx
  Type
  string
  Description
  Fail FBX.
- Name
  obj
  Type
  string
  Description
  Fail OBJ.
- Name
  usdz
  Type
  string
  Description
  Fail USDZ.
- Name
  mtl
  Type
  string
  Description
  Fail MTL, dikembalikan bersama fail OBJ apabila model mempunyai tekstur.
- Name
  stl
  Type
  string
  Description
  Fail STL.
- Name
  3mf
  Type
  string
  Description
  Fail 3MF. Hanya hadir apabila target_formats termasuk 3mf.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  Fail GLB sebelum remesh. Hanya hadir apabila anda mencipta tugas dengan kedua-dua should_remesh: true dan save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
URL muat turun untuk imej pratonton model. Ia sama seperti thumbnail_urls.front apabila medan itu hadir.
Name
alpha_thumbnail_url
Type
string
Description
URL muat turun untuk versi thumbnail_url dengan latar belakang lutsinar (RGBA). Hanya hadir apabila anda mencipta tugas dengan alpha_thumbnail: true dan Meshy telah merender pratonton lutsinar tersebut.
Name
thumbnail_urls
Type
object
Description
URL muat turun untuk pratonton model 3D dari empat sisi. Setiap satu adalah URL bertandatangan ke PNG 512×512, dirender dengan bahan dan pencahayaan yang sama seperti thumbnail_url. Anda boleh menggunakannya untuk pratonton model dari pelbagai sudut tanpa memuat turun GLB.
Hanya hadir apabila anda mencipta tugas dengan multi_view_thumbnails: true dan tugas mencapai SUCCEEDED. Tugas yang dicipta tanpa multi_view_thumbnails: true tidak mempunyai medan ini.
- Name
  front
  Type
  string
  Description
  Pandangan depan, pada 0° di sekeliling paksi menegak. Ia sepadan dengan thumbnail_url.
- Name
  right
  Type
  string
  Description
  Pandangan kanan, pada 90°.
- Name
  back
  Type
  string
  Description
  Pandangan belakang, pada 180°.
- Name
  left
  Type
  string
  Description
  Pandangan kiri, pada 270°.
Name
texture_prompt
Type
string
Description
Prompt teks yang memandu tekstur.
Name
texture_image_urls
Type
string[]
Description
URL muat turun untuk imej rujukan tekstur yang anda gunakan untuk mencipta tugas, mengikut urutan anda menghantarnya. Hanya hadir apabila anda mencipta tugas dengan texture_image_urls.
Name
ultra_mode
Type
boolean
⚠ lapuk
Description
Baca geometry_resolution sebagai gantinya.
Name
geometry_resolution
Type
string
Description
Tahap Ultra yang digunakan oleh tugas, iaitu 2k. Tugas standard tidak mempunyai medan ini.
Name
progress
Type
integer
Description
Berapa banyak tugas telah selesai, sebagai peratusan. Ia 0 sehingga tugas bermula dan 100 apabila ia berjaya.
Name
started_at
Type
timestamp
Description
Masa tugas bermula, dalam milisaat Unix. Ia 0 sehingga tugas bermula.
Name
created_at
Type
timestamp
Description
Masa tugas dicipta, dalam milisaat Unix.
Name
expires_at
Type
timestamp
Description
Masa hasil tugas tamat tempoh, dalam milisaat Unix.
Name
finished_at
Type
timestamp
Description
Masa tugas selesai, dalam milisaat Unix. Ia 0 sehingga tugas selesai.
Name
status
Type
string
Description
Status tugas, salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED, atau CANCELED.
Name
texture_urls
Type
array
Description
URL muat turun untuk peta tekstur yang dijana oleh tugas, sebagai array objek. Ia biasanya menyimpan satu objek. Setiap objek mempunyai medan-medan ini:
- Name
  base_color
  Type
  string
  Description
  Peta warna asas.
- Name
  metallic
  Type
  string
  Description
  Peta metalik. Tidak disertakan apabila anda mencipta tugas dengan enable_pbr: false.
- Name
  normal
  Type
  string
  Description
  Peta normal. Tidak disertakan apabila anda mencipta tugas dengan enable_pbr: false.
- Name
  roughness
  Type
  string
  Description
  Peta kekasaran. Tidak disertakan apabila anda mencipta tugas dengan enable_pbr: false.
- Name
  emission
  Type
  string
  Description
  Peta pancaran. Disertakan hanya apabila anda mencipta tugas dengan kesemua perkara berikut:
  
  ai_model: meshy-6, dengan model tekstur lalainya
  
  enable_pbr: true
  
  texture_resolution pada 2k atau 4k
Name
preceding_tasks
Type
integer
Description
Bilangan tugas yang berada di hadapan tugas ini dalam baris gilir. Nilai ini hanya bermakna semasa tugas berstatus PENDING.
Name
task_error
Type
object
Description
Butiran ralat apabila tugas gagal. Ia null melainkan statusnya FAILED. Lihat Ralat.
Name
consumed_credits
Type
integer
Description
Bilangan kredit yang digunakan oleh tugas. Hadir apabila statusnya PENDING, IN_PROGRESS, atau SUCCEEDED. Ia 0 untuk tugas FAILED, kerana Meshy memulangkan semula kredit apabila tugas gagal.