API Imej ke 3D

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

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

Cipta Tugas Imej ke 3D

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

Parameter

Hanya salah satu daripada input_task_id atau image_url adalah diperlukan. Jika kedua-duanya diberikan, input_task_id mengambil keutamaan.

Name
input_task_id
Type
string
Diperlukan
Description
ID tugas penjanaan imej yang telah selesai, yang outputnya harus digunakan sebagai imej input. Tugas ini mestilah salah satu daripada tugas berikut: Teks ke Imej atau Imej ke Imej. Selain itu, ia mestilah telah dijalankan melalui API, mempunyai status SUCCEEDED, dan menghasilkan tepat satu imej.

Name
image_url
Type
string
Diperlukan
Description
Sediakan imej untuk digunakan oleh Meshy dalam penciptaan model. Buat masa ini kami menyokong format .jpg, .jpeg, dan .png.
Terdapat dua cara untuk menyediakan imej:
- URL boleh diakses secara awam: URL yang boleh diakses daripada internet awam.
- Data URI: Data URI imej yang dikodkan base64. Contoh data URI: data:image/jpeg;base64,<your base64-encoded image data>.

Name
model_type
Type
string
lalai standard
Description
Tentukan jenis penjanaan jejaring 3D.
Nilai yang tersedia:
- standard: Penjanaan jejaring 3D biasa dengan perincian tinggi.
- lowpoly: Menjana jejaring low-poly yang dioptimumkan untuk poligon yang lebih bersih.
Apabila lowpoly dipilih, ai_model, topology, target_polycount, should_remesh, save_pre_remeshed_model diabaikan.
Name
ai_model
Type
string
lalai latest
Description
ID model untuk digunakan. Nilai yang tersedia: meshy-5, meshy-6, latest (Meshy 6).
Name
should_texture
Type
boolean
lalai true
Description
Menentukan sama ada tekstur dijana. Menetapkannya kepada false melangkau fasa tekstur, menyediakan jejaring tanpa tekstur.

Hanya berlaku apabila should_texture = true

Name
enable_pbr
Type
boolean
lalai false
Description
Jana peta PBR (metallic, roughness, normal) sebagai tambahan kepada warna asas. Peta emission turut disertakan apabila ai_model ialah meshy-6 atau latest.
Name
hd_texture
Type
boolean
lalai false
Description
Jana tekstur warna asas pada resolusi 4K (4096×4096) untuk perincian yang lebih tinggi.
Hanya disokong apabila ai_model ialah meshy-6 atau latest. Peta PBR sentiasa dijana pada 2K.
Name
texture_prompt
Type
string
Description
Sediakan prompt teks untuk membimbing proses penteksturan. Maksimum 600 aksara.
Name
texture_image_url
Type
string
Description
Sediakan imej 2d untuk membimbing proses penteksturan. Buat masa ini kami menyokong format .jpg, .jpeg, dan .png.
Terdapat dua cara untuk menyediakan imej:
- URL boleh diakses secara awam: URL yang boleh diakses daripada internet awam
- Data URI: Data URI imej yang dikodkan base64. Contoh data URI: data:image/jpeg;base64,<your base64-encoded image data>
Penteksturan imej mungkin tidak berfungsi secara optimum jika terdapat perbezaan geometri yang ketara antara aset asal dan imej yang dimuat naik. Hanya salah satu daripada texture_image_url atau texture_prompt boleh digunakan untuk membimbing proses penteksturan. Jika kedua-dua parameter diberikan, maka texture_prompt akan digunakan untuk memberi tekstur pada model secara lalai. Penteksturan melalui teks atau imej akan menelan kos 10 kredit bagi setiap tugas.

Name
should_remesh
Type
boolean
lalai false (meshy-6), true (others)
Description
Mengawal sama ada untuk mendayakan fasa remesh. Apabila ditetapkan kepada false, API mengembalikan jejaring segi tiga berketepatan tertinggi.

Hanya berlaku apabila should_remesh = true

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

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

Hanya berlaku apabila auto_size = true

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

Mengembalikan

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

Mode Kegagalan

Name
400 - Bad Request
Description
Permintaan tidak dapat diterima. Punca biasa:
- Parameter hilang: Sama ada image_url atau input_task_id mesti diberikan.
- Tugas input tidak sah: input_task_id mesti merujuk kepada tugas Teks ke Imej atau Imej ke Imej yang SUCCEEDED dan menghasilkan tepat satu imej.
- Format imej tidak sah: image_url yang diberikan bukan format yang disokong (.jpg, .jpeg, .png).
- URL tidak dapat dicapai: image_url tidak dapat dimuat turun (404 atau timeout).
- Data URI tidak sah: Rentetan base64 cacat.
- Gabungan parameter tidak sah: enable_pbr hanya disokong apabila should_texture adalah true.
Name
401 - Unauthorized
Description
Pengesahan gagal. Sila semak kunci API anda.
Name
402 - Payment Required
Description
Kredit tidak mencukupi untuk melaksanakan tugas ini.
Name
429 - Too Many Requests
Description
Anda telah melebihi had kadar anda.

Request

POST

/openapi/v1/image-to-3d

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

# With remesh, PBR, and A-pose
curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>",
    "enable_pbr": true,
    "should_remesh": true,
    "target_polycount": 100000,
    "should_texture": true,
    "pose_mode": "a-pose",
    "target_formats": ["glb"]
  }'

Response

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

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

Dapatkan Tugas Imej ke 3D

endpoint ini membolehkan anda mendapatkan tugas Imej ke 3D dengan id tugas yang sah. Rujuk Objek Tugas Imej ke 3D untuk melihat sifat yang disertakan dengan objek tugas Imej ke 3D.

Parameter

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

Mengembalikan

Respons mengandungi objek tugas Imej ke 3D. Semak bahagian Objek Tugas Imej ke 3D untuk butiran.

Request

GET

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

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "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/image-to-3d/:id

Padam Tugas Imej ke 3D

Endpoint ini memadamkan tugas Imej ke 3D secara kekal, termasuk semua model dan data yang berkaitan. Tindakan ini tidak boleh dibatalkan.

Parameter Laluan

Name
id
Type
path
Description
ID tugas Imej ke 3D yang hendak dipadamkan.

Pulangan

Mengembalikan 200 OK apabila berjaya.

Request

DELETE

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

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

Response

// Returns 200 Ok on success.

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

Senaraikan Tugas Imej ke 3D

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

Parameter

Atribut pilihan

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

Pulangan

Mengembalikan senarai bernombor halaman bagi Objek Tugas Imej ke 3D.

Request

GET

/openapi/v1/image-to-3d

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

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "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/image-to-3d/:id/stream

Strim Tugas Imej ke 3D

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

Parameter

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

Pulangan

Mengembalikan strim Objek Tugas Imej ke 3D sebagai Server-Sent Events.

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

Request

GET

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

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

Objek Tugasan Imej ke 3D

Objek Tugasan Imej ke 3D ialah unit kerja yang dijejaki oleh Meshy untuk menjana model 3D daripada input imej. Objek ini mempunyai sifat berikut:

Sifat

Name
id
Type
string
Description
Pengecam unik untuk tugasan. Walaupun kami menggunakan UUID k-sortable untuk id tugasan sebagai butiran pelaksanaan, anda tidak patut membuat sebarang andaian tentang format id.
Name
type
Type
string
Description
Jenis tugasan Imej ke 3D. Nilainya ialah image-to-3d.
Name
model_urls
Type
object
Description
URL boleh dimuat turun untuk fail model 3D bertekstur yang dijana oleh Meshy. Sifat untuk sesuatu format akan ditinggalkan jika format tersebut tidak dijana, dan bukannya mengembalikan rentetan kosong.
- Name
  glb
  Type
  string
  Description
  URL boleh dimuat turun untuk fail GLB.
- Name
  fbx
  Type
  string
  Description
  URL boleh dimuat turun untuk fail FBX.
- Name
  obj
  Type
  string
  Description
  URL boleh dimuat turun untuk fail OBJ.
- Name
  usdz
  Type
  string
  Description
  URL boleh dimuat turun untuk fail USDZ.
- Name
  mtl
  Type
  string
  Description
  URL boleh dimuat turun untuk fail MTL, dikembalikan bersama eksport OBJ apabila tekstur hadir.
- Name
  stl
  Type
  string
  Description
  URL boleh dimuat turun untuk fail STL.
- Name
  3mf
  Type
  string
  Description
  URL boleh dimuat turun untuk fail 3MF. Hanya hadir apabila 3mf diminta melalui target_formats.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  URL boleh dimuat turun untuk output GLB asal sebelum remesh.
  Tersedia hanya apabila tugasan dicipta dengan kedua-dua should_remesh: true dan save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
URL boleh dimuat turun untuk imej kecil fail model. Setara dengan thumbnail_urls.front apabila hadir, dikekalkan untuk keserasian ke belakang.
Name
alpha_thumbnail_url
Type
string
Description
URL boleh dimuat turun untuk versi berlatar belakang lutsinar (RGBA) bagi thumbnail_url. Hanya hadir apabila tugasan dicipta dengan alpha_thumbnail: true dan pratonton lutsinar berjaya dirender; jika tidak, medan ini ditinggalkan.
Name
thumbnail_urls
Type
object
Description
URL boleh dimuat turun untuk empat imej kecil pandangan arah utama bagi model 3D yang dijana. Setiap nilai ialah URL bertandatangan kepada PNG 512×512 yang dirender dengan bahan dan pencahayaan yang sama seperti thumbnail_url. Berguna untuk pratonton model dari pelbagai sudut dalam saluran paip kelompok tanpa memuat turun GLB.
Hanya hadir apabila tugasan dicipta dengan multi_view_thumbnails: true dan telah mencapai SUCCEEDED. Tugasan lama dan tugasan yang dicipta tanpa keikutsertaan pilihan tidak akan menyertakan medan ini.
- Name
  front
  Type
  string
  Description
  Pandangan hadapan, putaran 0° di sekeliling paksi menegak (sepadan dengan thumbnail_url).
- Name
  right
  Type
  string
  Description
  Pandangan kanan, putaran 90°.
- Name
  back
  Type
  string
  Description
  Pandangan belakang, putaran 180°.
- Name
  left
  Type
  string
  Description
  Pandangan kiri, putaran 270°.
Name
texture_prompt
Type
string
Description
Prompt teks yang digunakan untuk membimbing proses penteksturan.
Name
texture_image_url
Type
string
Description
URL boleh dimuat turun untuk imej tekstur yang digunakan untuk membimbing proses penteksturan.
Name
progress
Type
integer
Description
Progress tugasan. Jika tugasan belum dimulakan, sifat ini akan menjadi 0. Setelah tugasan berjaya, ini akan menjadi 100.
Name
started_at
Type
timestamp
Description
Cap masa apabila tugasan dimulakan, dalam milisaat. Jika tugasan belum dimulakan, sifat ini akan menjadi 0.
Cap masa mewakili bilangan milisaat yang berlalu sejak 1 Januari 1970 UTC, mengikut standard RFC 3339. Contohnya, Jumaat, 1 September 2023 12:00:00 PM GMT diwakili sebagai 1693569600000. Ini terpakai kepada semua cap masa dalam Meshy API.
Name
created_at
Type
timestamp
Description
Cap masa apabila tugasan dicipta, dalam milisaat.
Name
expires_at
Type
timestamp
Description
Cap masa apabila hasil tugasan tamat tempoh, dalam milisaat.
Name
finished_at
Type
timestamp
Description
Cap masa apabila tugasan selesai, dalam milisaat. Jika tugasan belum selesai, sifat ini akan menjadi 0.
Name
status
Type
string
Description
Status tugasan. Nilai yang mungkin ialah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Tatasusunan objek URL tekstur yang dijana daripada tugasan. Biasanya ini hanya mengandungi satu objek URL tekstur. Setiap URL tekstur mempunyai sifat berikut:
- Name
  base_color
  Type
  string
  Description
  URL boleh dimuat turun untuk imej peta warna asas.
- Name
  metallic
  Type
  string
  Description
  URL boleh dimuat turun untuk imej peta logam.
  Jika tugasan dicipta dengan enable_pbr: false, sifat ini akan ditinggalkan.
- Name
  normal
  Type
  string
  Description
  URL boleh dimuat turun untuk imej peta normal.
  Jika tugasan dicipta dengan enable_pbr: false, sifat ini akan ditinggalkan.
- Name
  roughness
  Type
  string
  Description
  URL boleh dimuat turun untuk imej peta kekasaran.
  Jika tugasan dicipta dengan enable_pbr: false, sifat ini akan ditinggalkan.
- Name
  emission
  Type
  string
  Description
  URL boleh dimuat turun untuk imej peta pancaran.
  Jika tugasan dicipta dengan enable_pbr: false, atau ai_model ialah meshy-5, sifat ini akan ditinggalkan.
Name
preceding_tasks
Type
integer
Description
Bilangan tugasan terdahulu.
Nilai medan ini hanya bermakna jika status tugasan ialah PENDING.
Name
task_error
Type
object
Description
Butiran ralat untuk tugasan yang gagal. Lihat Ralat untuk rujukan objek task_error penuh.
Name
consumed_credits
Type
integer
Description
Bilangan kredit yang digunakan oleh tugasan ini. Hadir apabila status tugasan ialah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugasan FAILED (kredit dipulangkan apabila gagal).

Example Image to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "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": "",
  "texture_image_url": "",
  "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
}