Teks ke API 3D

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

Teks ke 3D menggunakan aliran kerja dua langkah. Pertama, buat tugas pratonton (mode: "preview") untuk menjana jejaring 3D tanpa tekstur, jadi anda boleh menilai bentuknya. Kemudian, hantar ID tugas pratonton yang telah selesai ke tugas perhalus (mode: "refine") untuk memohon tekstur kepada jejaring. Kedua-dua langkah berkongsi endpoint yang sama.

POST/openapi/v2/text-to-3d

Buat Tugas Pratonton Teks ke 3D

Endpoint ini membuat tugas pratonton Teks ke 3D, yang menjana jejaring 3D tidak bertekstur (geometri sahaja) daripada prompt teks. Ini adalah langkah pertama daripada aliran kerja dua langkah. Apabila pratonton berjaya, gunakan ID tugas yang dipulangkan untuk membuat tugas perhalus untuk pengeteksturan. Rujuk kepada The Text to 3D Task Object untuk skema respons penuh.

Parameter

  • Name
    mode
    Type
    string
    Diperlukan
    Description

    Medan ini harus ditetapkan kepada "preview" semasa membuat tugas pratonton.

  • Name
    prompt
    Type
    string
    Diperlukan
    Description

    Terangkan jenis objek yang menjadi model 3D. Maksimum 600 aksara.

  • Name
    model_type
    Type
    string
    lalai standard
    Description

    Nyatakan jenis penjanaan jejaring 3D.

    Nilai yang tersedia:

    • standard: Penjanaan jejaring 3D terperinci tinggi biasa.
    • smart-topology: Pilih model Smart Topology dengan ai_model (meshy-t2).
    • lowpoly (lapuk): Menjana jejaring low-poly dioptimumkan untuk poligon yang lebih bersih. Kami mengesyorkan menggunakan smart-topology sebaliknya.

    Apabila smart-topology dipilih, should_remesh dan decimation_mode diabaikan, dan hanya topology: triangle diterima.

    Apabila lowpoly dipilih, ai_model, topology, target_polycount, dan should_remesh diabaikan.

  • Name
    ai_model
    Type
    string
    lalai latest
    Description

    ID model yang akan digunakan. Nilai yang tersedia bergantung kepada model_type.

    Penjanaan standard (model_type: standard):

    • meshy-5, meshy-6, meshy-7, latest (Meshy 7)

    Penjanaan Smart Topology (model_type: smart-topology):

    • meshy-t2 (default): model Smart Topology — topology yang lebih bersih, bahagian yang dipisahkan secara native, output segitiga, dan bilangan muka yang anda boleh tetapkan dengan target_polycount.
  • Name
    ultra_mode
    Type
    boolean
    lalai false
    Description

    Aktifkan penjanaan Ultra untuk geometri yang lebih memenuhi dengan butiran permukaan yang lebih halus. Penjanaan mengambil masa lebih lama dan menambah 5 kredit.

    Hanya disokong apabila ai_model adalah meshy-7 (atau latest), dan hanya pada modus preview.

  • Name
    should_remesh
    Type
    boolean
    lalai false (meshy-6, meshy-7), true (others)
    Description

    Mengawal sama ada untuk mengaktifkan fasa remesh. Untuk model kualiti tertinggi, kami mengesyorkan menetapkan should_remesh kepada false.

Hanya berlaku apabila should_remesh = true
  • Name
    topology
    Type
    string
    lalai triangle
    Description

    Nyatakan topology model yang dijana.

    Nilai yang tersedia:

    • quad: Menjana jejaring yang menguasai kuad.
    • triangle: Menjana jejaring segitiga didenai.

    Output Smart Topology adalah hanya segitiga. Memohon quad bersama ai_model: meshy-t2 mengembalikan ralat.

  • Name
    decimation_mode
    Type
    integer
    Description

    Aktifkan pengurangan 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
    target_polycount
    Type
    integer
    Description

    Sasaran bilangan poligon (muka) dalam output. Bilangan sebenar mungkin berbeza daripada sasaran bergantung pada geometri.

    target_polycount berfungsi dalam dua kes berasingan:

    • Remesh — dengan should_remesh: true pada model standard. Jejaring dijana semula (denai) kepada kira-kira bilangan ini. Julat 100 hingga 300,000, default 30,000. Jika decimation_mode ditetapkan, ia mempunyai keutamaan dan target_polycount diabaikan.
    • Smart Topology — dengan model_type: smart-topology dan ai_model: meshy-t2. Model dijana terus pada bilangan muka ini; tiada remesh dijalankan dan should_remesh tidak diperlukan. Julat 100 hingga 15,000, default 4,000.
  • Name
    symmetry_mode
    Type
    string
    ⚠ lapuk
    lalai auto
    Description

    Lapuk. Parameter ini tidak lagi mempengaruhi output.

    Medan symmetry_mode mengawal kelakuan simetri semasa proses penjanaan model.

    Nilai yang sah adalah:

    • 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

    Nyatakan modus pose untuk model yang dijana.

    Nilai yang tersedia:

    • a-pose: Menjana model dalam pose A.
    • t-pose: Menjana model dalam pose T.
    • "" (rentetan kosong): Tiada pose tertentu diterapkan.
  • 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
    art_style
    Type
    string
    ⚠ lapuk
    lalai realistic
    Description

    Tidak disokong oleh Meshy-6. Permintaan menggunakan Meshy-6 akan mengabaikan art_style, dan beberapa kombinasi mungkin menyebabkan ralat. Nilai yang tersedia: realistic, sculpture.

    enable_pbr harus ditetapkan kepada false semasa menggunakan gaya Sculpture, kerana gaya Sculpture menjana set PBR tersendiri.

  • Name
    moderation
    Type
    boolean
    lalai false
    Description

    Apabila ditetapkan kepada true, kandungan input akan disemak secara automatik untuk kandungan yang berpotensi merbahaya. Jika kandungan merbahaya dikesan, tugas tidak akan diteruskan ke penjanaan.

    Teks dari prompt akan disemak.

  • Name
    target_formats
    Type
    string[]
    Description

    Menentukan format fail 3D yang mana untuk dimasukkan dalam output. Hanya format yang diminta akan dijana dan dikembalikan, yang boleh mengurangkan masa penyiapan tugas. Apabila diabaikan, semua format yang disokong termasuk.

    Nilai yang tersedia: glb, obj, fbx, stl, usdz, 3mf

    Apabila diabaikan, semua format kecuali 3mf dijana. 3mf hanya disertakan apabila dinyatakan secara eksplisit.

  • Name
    alpha_thumbnail
    Type
    boolean
    lalai false
    Description

    Apabila ditetapkan kepada true, tugas juga merender versi pratinjau dengan latar belakang telus (RGBA) dan mengembalikannya sebagai alpha_thumbnail_url pada respons GET. Medan thumbnail_url yang sedia ada tidak berubah.

  • Name
    auto_size
    Type
    boolean
    lalai false
    Description

    Apabila ditetapkan kepada true, perkhidmatan menggunakan penglihatan AI untuk menganggar ketinggian sebenar objek secara automatik dan mengubah saiz model sewajarnya. Titik asal akan menerusi bottom kecuali origin_at ditetapkan secara eksplisit.

Hanya berlaku apabila auto_size = true
  • Name
    origin_at
    Type
    string
    lalai bottom
    Description

    Kedudukan titik asal apabila auto_size diaktifkan.

    Nilai yang tersedia: bottom, center.

Returns

Harta result dalam respons mengandungi id tugas Teks ke 3D yang baru dicipta.

Failure Modes

  • Name
    400 - Bad Request
    Description

    Permintaan tidak boleh diterima. Punca biasa:

    • Kekurangan parameter: Parameter wajib (contohnya prompt, mode) tiada.
    • Parameter tidak sah: art_style bukan salah satu daripada nilai yang dibenarkan.
    • Prompt terlalu panjang: prompt melebihi had aksara.
  • Name
    401 - Unauthorized
    Description

    Pengesahan gagal. Sila periksa 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/v2/text-to-3d
# Pratonton mudah dengan parameter wajib sahaja
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a monster mask"
}'

# Pratonton dengan remesh dan A-pose
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a futuristic robot warrior",
  "should_remesh": true,
  "target_polycount": 100000,
  "pose_mode": "a-pose",
  "target_formats": ["glb"]
}'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
POST/openapi/v2/text-to-3d

Buat Tugas Perhalus Teks ke 3D

Endpoint ini membuat tugas perhalus Teks ke 3D, yang memohon tekstur kepada jejaring pratonton yang telah siap. Anda mesti menyediakan preview_task_id daripada tugas pratonton yang berjaya. Ini adalah langkah kedua daripada aliran kerja dua langkah.

Parameter

  • Name
    mode
    Type
    string
    Diperlukan
    Description

    Medan ini harus ditetapkan kepada "refine" semasa membuat tugas perhalus.

  • Name
    preview_task_id
    Type
    string
    Diperlukan
    Description

    ID tugas pratonton yang berkaitan.

    Status tugas pratonton yang diberikan mesti SUCCEEDED.

  • Name
    enable_pbr
    Type
    boolean
    lalai false
    Description

    Menjana peta PBR (logam, kekasaran, normal) sebagai tambahan kepada warna asas. Peta pelepasan juga disertakan apabila ai_model adalah meshy-6, kecuali pada texture_resolution: 8k (tiada peta pelepasan dihasilkan). meshy-7 (dan latest) tidak menghasilkan peta pelepasan.

  • Name
    texture_resolution
    Type
    string
    lalai 2k
    Description

    Resolusi warna asas tekstur. Salah satu 2k (2048×2048), 4k (4096×4096), atau 8k (8192×8192). Resolusi yang lebih tinggi menangkap lebih banyak butiran permukaan. Hanya terpakai kepada modus refine.

    4k dan 8k memerlukan ai_model meshy-6, meshy-7, atau latest. Pada 8k, tiada peta pelepasan dihasilkan.

  • Name
    hd_texture
    Type
    boolean
    ⚠ lapuk
    lalai false
    Description

    Gunakan texture_resolution sebaliknya — bersamaan dengan texture_resolution: "4k". Apabila kedua-duanya ditetapkan, texture_resolution mempunyai keutamaan.

  • Name
    texture_prompt
    Type
    string
    Description

    Berikan prompt teks tambahan untuk membimbing proses pengeteksturan. Maksimum 600 aksara.

  • Name
    texture_image_url
    Type
    string
    Description

    Berikan imej 2D untuk membimbing proses pengeteksturan. Kami kini menyokong format .jpg, .jpeg, dan .png.

    Terdapat dua cara untuk memberikan imej:

    • URL boleh diakses secara umum: URL yang boleh diakses dari internet awam
    • Data URI: URI data yang disandi base64 dari imej. Contoh URI data: data:image/jpeg;base64,<your base64-encoded image data>

    Pengeteksturan imej mungkin tidak berfungsi dengan optimum jika terdapat perbezaan geometri yang besar antara asset asal dan imej yang dimuat naik. Hanya satu daripada texture_image_url atau texture_prompt boleh digunakan untuk membimbing proses pengeteksturan. Jika kedua-dua parameter disediakan, maka texture_prompt akan digunakan untuk menghias model secara default.

  • Name
    ai_model
    Type
    string
    lalai latest
    Description

    ID model yang akan digunakan untuk perhalusan. Nilai yang tersedia: meshy-5, meshy-6, meshy-7, latest (Meshy 7).

    latest menyelesaikan di sini sama seperti pada tugas pratonton (kini Meshy 7), jadi pratonton latest dan perhalus latest sentiasa mendarat pada model tekstur yang sama.

  • Name
    moderation
    Type
    boolean
    lalai false
    Description

    Apabila ditetapkan kepada true, kandungan input akan disemak secara automatik untuk kandungan yang berpotensi merbahaya. Jika kandungan merbahaya dikesan, tugas tidak akan diteruskan ke penjanaan.

    Kedua-dua teks dari texture_prompt dan imej dari texture_image_url akan disemak.

  • Name
    remove_lighting
    Type
    boolean
    lalai true
    Description

    Menghilangkan sorotan dan bayang-bayang dari tekstur warna asas, menghasilkan hasil yang lebih bersih yang lebih baik di bawah tetapan pencahayaan yang disesuaikan.

    Hanya berkuatkuasa apabila ai_model adalah meshy-6. Pada meshy-7 (dan latest) parameter diterima tetapi diabaikan.

  • Name
    target_formats
    Type
    string[]
    Description

    Menentukan format fail 3D yang mana untuk dimasukkan dalam output. Hanya format yang diminta akan dijana dan dikembalikan, yang boleh mengurangkan masa penyiapan tugas. Apabila diabaikan, semua format yang disokong termasuk.

    Nilai yang tersedia: glb, obj, fbx, stl, usdz, 3mf

    Apabila diabaikan, semua format kecuali 3mf dijana. 3mf hanya disertakan apabila dinyatakan secara eksplisit.

  • Name
    alpha_thumbnail
    Type
    boolean
    lalai false
    Description

    Apabila ditetapkan kepada true, tugas juga merender versi pratinjau dengan latar belakang telus (RGBA) dan mengembalikannya sebagai alpha_thumbnail_url pada respons GET. Medan thumbnail_url yang sedia ada tidak berubah.

  • Name
    auto_size
    Type
    boolean
    lalai false
    Description

    Apabila ditetapkan kepada true, perkhidmatan menggunakan penglihatan AI untuk menganggar ketinggian sebenar objek secara automatik dan mengubah saiz model sewajarnya. Titik asal akan menerusi bottom kecuali origin_at ditetapkan secara eksplisit.

Hanya berlaku apabila auto_size = true
  • Name
    origin_at
    Type
    string
    lalai bottom
    Description

    Kedudukan titik asal apabila auto_size diaktifkan.

    Nilai yang tersedia: bottom, center.

Returns

Harta result dalam respons mengandungi id tugas Teks ke 3D yang baru dicipta.

Failure Modes

  • Name
    400 - Bad Request
    Description

    Permintaan tidak boleh diterima. Punca biasa:

    • ID tugas tidak sah: preview_task_id tidak sah atau tidak wujud.
    • Tugas tidak sedia: Tugas pratonton belum berjaya.
    • Ketidakserasian model: Model AI tugas pratonton tidak serasi dengan model perhalus yang diminta.
  • Name
    401 - Unauthorized
    Description

    Pengesahan gagal. Sila periksa kunci API anda.

  • Name
    402 - Payment Required
    Description

    Kredit tidak mencukupi untuk melaksanakan tugas ini.

  • Name
    404 - Not Found
    Description

    Tugas pratonton yang dinyatakan oleh preview_task_id tidak dijumpai.

  • Name
    429 - Too Many Requests
    Description

    Anda telah melebihi had kadar anda.

Request

POST
/openapi/v2/text-to-3d
# Tugas perhalus asas
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "enable_pbr": true
}'

# Perhalus dengan saiz automatik dan format GLB
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "target_formats": ["glb"],
  "auto_size": true
}'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
GET/openapi/v2/text-to-3d/:id

Dapatkan Tugas Teks ke 3D

Endpoint ini membolehkan anda mendapatkan tugas Teks ke 3D dengan memberikan id tugas yang sah. Rujuk kepada The Text to 3D Task Object untuk melihat harta-harta yang termasuk dengan objek tugas Teks ke 3D.

Endpoint ini berfungsi untuk kedua-dua tugas pratonton dan perhalus.

Parameter

  • Name
    id
    Type
    path
    Description

    Pengenal unik untuk tugas Teks ke 3D untuk mendapatkan.

Returns

Respons mengandungi objek tugas Teks ke 3D. Semak bahagian The Text to 3D Task Object untuk butiran.

Contoh

ModeContoh Model
PratontonPreview model
PerhalusRefined model

Request

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-3d-preview",
  "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=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?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=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "prompt": "a monster mask",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 20
}
DELETE/openapi/v2/text-to-3d/:id

Padamkan Tugas Teks ke 3D

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

Path Parameters

  • Name
    id
    Type
    path
    Description

    ID tugas Teks ke 3D untuk dipadam.

Returns

Mengembalikan 200 OK apabila berjaya.

Request

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

Response

// Mengembalikan 200 Ok pada kejayaan.
GET/openapi/v2/text-to-3d

Senarai Tugas Teks ke 3D

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

Parameter

  • Name
    page_num
    Type
    integer
    lalai 1
    Description

    Nombor halaman untuk penomboran halaman.

  • Name
    page_size
    Type
    integer
    lalai 10
    Description

    Had saiz halaman. Maksimum yang dibenarkan ialah 50 item.

  • Name
    sort_by
    Type
    string
    Description

    Medan untuk diisih mengikut.

    Nilai yang tersedia:

    • +created_at: Susun mengikut masa penciptaan dalam susunan menaik.
    • -created_at: Susun mengikut masa penciptaan dalam susunan menurun.

Returns

Mengembalikan senarai dipaginasi The Text to 3D Task Objects.

Request

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

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "text-to-3d-preview",
    "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=***",
      "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "prompt": "a monster mask",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {

      "message": ""

    },

    "consumed_credits": 20
  }
]
GET/openapi/v2/text-to-3d/:id/stream

Strim Tugas Teks ke 3D

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

Parameter

  • Name
    id
    Type
    path
    Description

    Pengenal unik untuk tugas Teks ke 3D untuk menstrim.

Returns

Mengembalikan aliran The Text to 3D Task Objects sebagai Server-Sent Events.

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

Request

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

Response Stream

// Contoh acara ralat
event: error
data: {
  "status_code": 404,
  "message": "Tugas tidak dijumpai"
}

// Contoh acara mesej menunjukkan kemajuan tugas.
// Untuk tugas PENDING atau IN_PROGRESS, aliran respons tidak akan termasuk semua medan.
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 50,
  "status": "IN_PROGRESS"
}

event: message
data: {
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "text-to-3d-preview",
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1692771650657,
"started_at": 1692771667037,
"finished_at": 1692771669037,
"model_urls": {
  "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
},
"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": 20
}

Objek Tugas Teks ke 3D

Objek Tugas Teks ke 3D adalah unit kerja yang Meshy jejak untuk menjana model 3D daripada input teks. Terdapat dua tahap API Teks ke 3D, preview dan refine. Tahap pratonton adalah untuk menjana model 3D hanya jejaring, dan tahap perhalus adalah untuk menjana model 3D bertekstur berdasarkan hasil tahap pratonton.

Objek ini mempunyai sifat-sifat berikut:

Sifat-sifat

  • Name
    id
    Type
    string
    Description

    Pengenal unik untuk tugas. Walaupun kami menggunakan UUID k-sortable untuk id tugas sebagai butiran pelaksanaan, anda tidak sepatutnya membuat sebarang anggapan tentang format id.

  • Name
    type
    Type
    string
    Description

    Jenis tugas Teks ke 3D. Nilai mungkin adalah text-to-3d-preview untuk tugas tahap pratonton dan text-to-3d-refine untuk tugas tahap perhalus.

  • Name
    model_urls
    Type
    object
    Description

    URL boleh dimuat turun kepada fail model 3D bertekstur yang dijana oleh Meshy. Harta untuk format akan dikecualikan jika format tidak dijana dan bukannya mengembalikan rentetan kosong.

    • Name
      glb
      Type
      string
      Description

      URL boleh dimuat turun kepada fail GLB.

    • Name
      fbx
      Type
      string
      Description

      URL boleh dimuat turun kepada fail FBX.

    • Name
      usdz
      Type
      string
      Description

      URL boleh dimuat turun kepada fail USDZ.

    • Name
      obj
      Type
      string
      Description

      URL boleh dimuat turun kepada fail OBJ.

    • Name
      mtl
      Type
      string
      Description

      URL boleh dimuat turun kepada fail MTL.

    • Name
      stl
      Type
      string
      Description

      URL boleh dimuat turun kepada fail STL.

    • Name
      3mf
      Type
      string
      Description

      URL boleh dimuat turun kepada fail 3MF. Hanya hadir apabila 3mf diminta melalui target_formats.

  • Name
    prompt
    Type
    string
    Description

    Ini adalah prompt yang tidak diubah yang digunakan untuk mencipta tugas.

  • Name
    negative_prompt
    Type
    string
    ⚠ lapuk
    Description

    Dikekalkan untuk keserasian ke belakang. Medan ini tidak mempunyai kesan fungsional pada model yang dijana.

  • Name
    art_style
    Type
    string
    ⚠ lapuk
    Description

    Gaya art_style yang tidak diubah yang digunakan untuk mencipta tugas pratonton. Tidak disokong oleh Meshy-6.

  • Name
    texture_richness
    Type
    string
    ⚠ lapuk
    Description

    Dikekalkan untuk keserasian ke belakang. Medan ini tidak mempunyai kesan fungsional pada model yang dijana.

  • Name
    texture_prompt
    Type
    string
    Description

    Prompt teks tambahan yang disediakan untuk memandu proses pengeteksturan semasa tahap perhalus.

  • Name
    ultra_mode
    Type
    boolean
    Description

    Menyamai nilai ultra_mode yang tugas pratonton dicipta dengan. Hanya hadir untuk tugas pratonton meshy-7 (atau latest) yang menetapkan ultra_mode secara eksplisit; dikecualikan sebaliknya.

  • Name
    texture_image_url
    Type
    string
    Description

    URL boleh dimuat turun kepada imej tekstur yang digunakan untuk membimbing proses pengeteksturan.

  • Name
    thumbnail_url
    Type
    string
    Description

    URL boleh dimuat turun kepada imej kecil fail model.

  • Name
    alpha_thumbnail_url
    Type
    string
    Description

    URL boleh dimuat turun kepada versi latar belakang telus (RGBA) thumbnail_url. Hanya hadir apabila tugas dicipta dengan alpha_thumbnail: true dan pratonton telus berjaya dihasilkan; sebaliknya medan ini dikecualikan.

  • Name
    video_url
    Type
    string
    ⚠ lapuk
    Description

    URL boleh dimuat turun kepada video pratonton. Akan dikeluarkan dalam keluaran masa akan datang.

  • Name
    progress
    Type
    integer
    Description

    Kemajuan tugas. Jika tugas belum dimulakan lagi, harta ini akan 0. Setelah tugas berjaya, ini akan menjadi 100.

  • Name
    started_at
    Type
    timestamp
    Description

    Cap masa apabila tugas dimulakan, dalam milisaat. Jika tugas belum dimulakan lagi, harta ini akan 0.

    Cap masa mewakili bilangan milisaat yang telah berlalu sejak 1 Januari 1970 UTC, mengikut standard RFC 3339. Sebagai contoh, 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 tugas dicipta, dalam milisaat.

  • Name
    finished_at
    Type
    timestamp
    Description

    Cap masa apabila tugas selesai, dalam milisaat. Jika tugas belum selesai lagi, harta ini akan 0.

  • Name
    status
    Type
    string
    Description

    Status tugas. Nilai mungkin adalah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    texture_urls
    Type
    array
    Description

    Tatasusunan objek URL tekstur yang dijana dari tugas. Biasanya ini hanya mengandungi satu objek URL tekstur. Setiap URL tekstur memiliki sifat berikut:

    • Name
      base_color
      Type
      string
      Description

      URL boleh dimuat turun kepada imej peta warna asas.

    • Name
      metallic
      Type
      string
      Description

      URL boleh dimuat turun kepada imej peta logam.

      Jika tugas dicipta dengan enable_pbr: false, sifat ini akan dikecualikan.

    • Name
      normal
      Type
      string
      Description

      URL boleh dimuat turun kepada imej peta normal.

      Jika tugas dicipta dengan enable_pbr: false, sifat ini akan dikecualikan.

    • Name
      roughness
      Type
      string
      Description

      URL boleh dimuat turun kepada imej peta kekasaran.

      Jika tugas dicipta dengan enable_pbr: false, sifat ini akan dikecualikan.

    • Name
      emission
      Type
      string
      Description

      URL boleh dimuat turun kepada imej peta pelepasan.

      Jika tugas dicipta dengan enable_pbr: false, atau ai_model adalah meshy-5, sifat ini akan dikecualikan.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Kiraan tugas terdahulu.

    Nilai medan ini bermakna hanya jika status tugas adalah PENDING.

  • Name
    task_error
    Type
    object
    Description

    Butiran ralat untuk tugas gagal. Lihat Ralat untuk rujukan objek task_error penuh.

  • Name
    consumed_credits
    Type
    integer
    Description

    Bilangan kredit yang digunakan oleh tugas ini. Hadir apabila status tugas adalah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugas FAILED (kredit dipulangkan atas kegagalan).

Example Text to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-3d-preview",
  "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=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  },
  "prompt": "a monster mask",
  "texture_prompt": "green slimy skin with scales and warts",
  "texture_image_url": "",
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "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": 20
}