API Teks ke 3D

API Teks ke 3D ialah 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. Mula-mula, cipta tugasan pratonton (mode: "preview") untuk menjana jejaring 3D tanpa tekstur, supaya anda boleh menilai bentuknya. Kemudian, hantarkan ID tugasan pratonton yang telah selesai kepada tugasan penambahbaikan (mode: "refine") untuk menggunakan tekstur pada jejaring. Kedua-dua langkah berkongsi endpoint yang sama.

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

Cipta Tugasan Pratonton Teks ke 3D

endpoint ini mencipta tugasan pratonton Teks ke 3D, yang menjana jejaring 3D tanpa texture (geometri sahaja) daripada prompt teks. Ini ialah langkah pertama dalam aliran kerja dua langkah. Setelah pratonton berjaya, gunakan ID tugasan yang dikembalikan untuk mencipta tugasan refine bagi pentexturean. Rujuk Objek Tugasan Teks ke 3D untuk skema respons penuh.

Parameter

  • Name
    mode
    Type
    string
    Diperlukan
    Description

    Medan ini harus ditetapkan kepada "preview" apabila mencipta tugasan pratonton.

  • Name
    prompt
    Type
    string
    Diperlukan
    Description

    Terangkan jenis objek bagi model 3D tersebut. Maksimum 600 aksara.

  • Name
    model_type
    Type
    string
    lalai standard
    Description

    Tentukan jenis penjanaan jejaring 3D.

    Nilai tersedia:

    • standard: Penjanaan jejaring 3D berperincian tinggi biasa.
    • lowpoly: Menjana jejaring low-poly yang dioptimumkan untuk poligon yang lebih bersih.

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

  • Name
    ai_model
    Type
    string
    lalai latest
    Description

    ID model yang hendak digunakan. Nilai tersedia: meshy-5, meshy-6, latest (Meshy 6).

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

    Mengawal sama ada untuk mendayakan fasa remesh. Apabila ditetapkan kepada false, API akan terus 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 tersedia:

    • quad: Jana jejaring yang didominasi quad.
    • triangle: Jana jejaring segi tiga yang telah dikecilkan.
  • Name
    target_polycount
    Type
    integer
    lalai 30,000
    Description

    Tentukan bilangan sasaran poligon dalam model yang dijana. Bilangan sebenar poligon mungkin menyimpang daripada sasaran bergantung pada kerumitan geometri.

    Julat nilai yang sah berbeza bergantung pada peringkat pengguna:

    • 100 hingga 300,000 (termasuk)
  • Name
    decimation_mode
    Type
    integer
    Description

    Dayakan pengecilan adaptif dengan menetapkan tahap bilangan poligon. Apabila ditetapkan, target_polycount diabaikan.

    Nilai tersedia:

    • 1: Adaptif — bilangan poligon ultra.
    • 2: Adaptif — bilangan poligon tinggi.
    • 3: Adaptif — bilangan poligon sederhana.
    • 4: Adaptif — bilangan poligon rendah.
  • 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 yang sah ialah:

    • off: Menyahdayakan 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 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
    art_style
    Type
    string
    ⚠ lapuk
    lalai realistic
    Description

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

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

  • 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, tugasan tidak akan diteruskan kepada penjanaan.

    Teks daripada prompt akan disaring.

  • Name
    target_formats
    Type
    string[]
    Description

    Menentukan format fail 3D yang hendak disertakan dalam output. Hanya format yang diminta akan dijana dan dikembalikan, yang boleh mengurangkan masa penyelesaian tugasan. Apabila ditinggalkan, semua format yang disokong disertakan.

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

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

  • Name
    alpha_thumbnail
    Type
    boolean
    lalai false
    Description

    Apabila ditetapkan kepada true, tugasan turut merender versi pratonton berlatar belakang telus (RGBA) dan mengembalikannya sebagai alpha_thumbnail_url pada respons GET. Medan thumbnail_url sedia ada tidak berubah.

  • 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 secara lalai ditetapkan kepada bottom melainkan 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 didayakan.

    Nilai tersedia: bottom, center.

Mengembalikan

Sifat result bagi respons mengandungi id tugasan bagi tugasan Teks ke 3D yang baru dicipta.

Mode Kegagalan

  • Name
    400 - Bad Request
    Description

    Permintaan tidak boleh diterima. Punca biasa:

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

    Pengesahan gagal. Sila semak kunci API anda.

  • Name
    402 - Payment Required
    Description

    Kredit tidak mencukupi untuk melaksanakan tugasan ini.

  • Name
    429 - Too Many Requests
    Description

    Anda telah melebihi had kadar anda.

Request

POST
/openapi/v2/text-to-3d
# Simple preview with required params only
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"
}'

# Preview with remesh and 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

Cipta Tugas Perincian Teks ke 3D

endpoint ini mencipta tugas perincian Teks ke 3D, yang menggunakan tekstur pada jejaring pratonton yang telah selesai. Anda mesti menyediakan preview_task_id daripada tugas pratonton yang berjaya. Ini ialah langkah kedua dalam aliran kerja dua langkah.

Parameter

  • Name
    mode
    Type
    string
    Diperlukan
    Description

    Medan ini harus ditetapkan kepada "refine" apabila mencipta tugas perincian.

  • Name
    preview_task_id
    Type
    string
    Diperlukan
    Description

    Id tugas pratonton yang sepadan.

    Status tugas pratonton yang diberikan mestilah SUCCEEDED.

  • Name
    enable_pbr
    Type
    boolean
    lalai false
    Description

    Jana peta PBR (metallic, roughness, normal) sebagai tambahan kepada warna asas. Peta emission juga 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 tambahan untuk membimbing proses peneksturan. Maksimum 600 aksara.

  • Name
    texture_image_url
    Type
    string
    Description

    Sediakan imej 2d untuk membimbing proses peneksturan. Pada masa ini kami menyokong format .jpg, .jpeg, dan .png.

    Terdapat dua cara untuk menyediakan imej:

    • URL yang 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>

    Peneksturan imej mungkin tidak berfungsi secara optimum jika terdapat perbezaan geometri yang ketara antara asset asal dan imej yang dimuat naik. Hanya satu daripada texture_image_url atau texture_prompt boleh digunakan untuk membimbing proses peneksturan. Jika kedua-dua parameter disediakan, maka texture_prompt akan digunakan untuk memberi tekstur kepada model secara lalai.

  • Name
    ai_model
    Type
    string
    lalai latest
    Description

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

  • 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 kepada penjanaan.

    Kedua-dua teks daripada texture_prompt dan imej daripada texture_image_url akan disaring.

  • Name
    remove_lighting
    Type
    boolean
    lalai true
    Description

    Mengalih keluar sorotan dan bayang-bayang daripada tekstur warna asas, menghasilkan keputusan yang lebih bersih dan berfungsi dengan lebih baik di bawah tetapan pencahayaan tersuai.

    Hanya disokong apabila ai_model ialah meshy-6 atau latest.

  • Name
    target_formats
    Type
    string[]
    Description

    Menentukan format fail 3D yang hendak 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 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 pratonton dengan latar belakang telus (RGBA) dan mengembalikannya sebagai alpha_thumbnail_url pada respons GET. Medan thumbnail_url sedia ada tidak berubah.

  • 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 sewajarnya. titik asal akan ditetapkan secara lalai kepada bottom melainkan 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 didayakan.

    Nilai tersedia: bottom, center.

Pulangan

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

Mode Kegagalan

  • Name
    400 - Bad Request
    Description

    Permintaan tidak boleh diterima. Punca biasa:

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

    Pengesahan gagal. Sila semak kunci API anda.

  • Name
    402 - Payment Required
    Description

    kredit tidak mencukupi untuk melaksanakan tugas ini.

  • Name
    404 - Not Found
    Description

    Tugas pratonton yang ditentukan oleh preview_task_id tidak ditemui.

  • Name
    429 - Too Many Requests
    Description

    Anda telah melebihi had kadar anda.

Request

POST
/openapi/v2/text-to-3d
# Basic refine task
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
}'

# Refine with auto-size and GLB format
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 Tugasan Teks ke 3D

endpoint ini membolehkan anda mendapatkan tugasan Teks ke 3D dengan id tugasan yang sah. Rujuk Objek Tugasan Teks ke 3D untuk melihat sifat yang disertakan dengan objek tugasan Teks ke 3D.

endpoint ini berfungsi untuk kedua-dua tugasan pratonton dan perhalus.

Parameter

  • Name
    id
    Type
    path
    Description

    Pengecam unik untuk tugasan Teks ke 3D yang hendak didapatkan.

Mengembalikan

Respons mengandungi objek tugasan Teks ke 3D. Semak bahagian Objek Tugasan Teks ke 3D untuk butiran.

Contoh

modeModel Contoh
PratontonModel pratonton
PerhalusModel diperhalusi

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

Padam Tugasan Teks ke 3D

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

Parameter Laluan

  • Name
    id
    Type
    path
    Description

    ID tugasan Teks ke 3D yang hendak dipadamkan.

Pulangan

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

// Returns 200 Ok on success.
GET/openapi/v2/text-to-3d

Senaraikan Tugasan Teks ke 3D

endpoint ini membolehkan anda mendapatkan senarai tugasan 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 tersedia:

    • +created_at: Isih mengikut masa penciptaan dalam tertib menaik.
    • -created_at: Isih mengikut masa penciptaan dalam tertib menurun.

Pulangan

Mengembalikan senarai berpenomboran halaman bagi Objek Tugasan Teks ke 3D.

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

Strimkan Tugasan Teks ke 3D

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

Parameter

  • Name
    id
    Type
    path
    Description

    Pengecam unik untuk tugasan Teks ke 3D yang akan distrim.

Pulangan

Mengembalikan strim Objek Tugasan Teks ke 3D sebagai Server-Sent Events.

Untuk tugasan PENDING atau IN_PROGRESS, strim respons hanya akan menyertakan 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

// 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",
  "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 Tugasan Teks ke 3D

Objek Tugasan Teks ke 3D ialah unit kerja yang dijejaki oleh Meshy untuk menjana model 3D daripada input teks. Terdapat dua peringkat API Teks ke 3D, preview dan refine. Peringkat pratonton adalah untuk menjana model 3D jejaring sahaja, dan peringkat perincian adalah untuk menjana model 3D dengan peta tekstur berdasarkan hasil peringkat pratonton.

Objek ini mempunyai sifat berikut:

Sifat

  • Name
    id
    Type
    string
    Description

    Pengecam unik untuk tugas. Walaupun kami menggunakan UUID k-sortable untuk id tugas sebagai butiran pelaksanaan, anda tidak seharusnya membuat sebarang andaian tentang format id tersebut.

  • Name
    type
    Type
    string
    Description

    Jenis tugas Teks ke 3D. Nilai yang mungkin ialah text-to-3d-preview untuk tugas peringkat pratonton dan text-to-3d-refine untuk tugas peringkat penambahbaikan.

  • Name
    model_urls
    Type
    object
    Description

    URL boleh dimuat turun kepada fail model 3D bertekstur yang dijana oleh Meshy. Sifat untuk sesuatu format akan diabaikan jika format tersebut tidak dijana, 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 ialah prompt yang tidak diubah suai yang digunakan untuk mencipta tugas.

  • Name
    negative_prompt
    Type
    string
    ⚠ lapuk
    Description

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

  • Name
    art_style
    Type
    string
    ⚠ lapuk
    Description

    art_style yang tidak diubah suai 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 fungsi pada model yang dijana.

  • Name
    texture_prompt
    Type
    string
    Description

    Prompt teks tambahan yang disediakan untuk membimbing proses penteksturan semasa peringkat penambahbaikan.

  • Name
    texture_image_url
    Type
    string
    Description

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

  • 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 lutsinar (RGBA) bagi thumbnail_url. Hanya hadir apabila tugas dicipta dengan alpha_thumbnail: true dan pratonton lutsinar berjaya dirender; jika tidak, medan ini diabaikan.

  • Name
    video_url
    Type
    string
    ⚠ lapuk
    Description

    URL boleh dimuat turun kepada video pratonton. Akan dialih keluar dalam keluaran akan datang.

  • Name
    progress
    Type
    integer
    Description

    Progress tugas. Jika tugas belum bermula, sifat ini akan menjadi 0. Setelah tugas berjaya, ini akan menjadi 100.

  • Name
    started_at
    Type
    timestamp
    Description

    Cap masa apabila tugas dimulakan, dalam milisaat. Jika tugas belum bermula, sifat ini akan menjadi 0.

    Cap masa mewakili bilangan milisaat yang berlalu sejak 1 Januari 1970 UTC, mengikut piawaian 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, sifat ini akan menjadi 0.

  • Name
    status
    Type
    string
    Description

    Status tugas. 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 tugas. Biasanya ini hanya mengandungi satu objek URL tekstur. Setiap URL tekstur mempunyai 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 metalik.

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

    • Name
      normal
      Type
      string
      Description

      URL boleh dimuat turun kepada imej peta normal.

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

    • Name
      roughness
      Type
      string
      Description

      URL boleh dimuat turun kepada imej peta kekasaran.

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

    • Name
      emission
      Type
      string
      Description

      URL boleh dimuat turun kepada imej peta emisi.

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

  • Name
    preceding_tasks
    Type
    integer
    Description

    Bilangan tugas terdahulu.

    Nilai medan ini hanya bermakna jika status tugas ialah PENDING.

  • Name
    task_error
    Type
    object
    Description

    Butiran ralat untuk tugas yang 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 ialah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugas FAILED (kredit dipulangkan apabila gagal).

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,
  "seed": 1234,
  "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
}