API Văn bản sang 3D

API Văn bản sang 3D là một tính năng cho phép bạn tích hợp khả năng Văn bản sang 3D của Meshy vào ứng dụng của riêng bạn. Trong phần này, bạn sẽ tìm thấy tất cả thông tin cần thiết để bắt đầu với API này.

Văn bản sang 3D sử dụng quy trình làm việc hai bước. Đầu tiên, tạo một nhiệm vụ xem trước (mode: "preview") để tạo ra một lưới 3D không có texture, để bạn có thể đánh giá hình dạng. Sau đó, chuyển ID nhiệm vụ xem trước đã hoàn thành sang một nhiệm vụ tinh chỉnh (mode: "refine") để áp dụng texture cho lưới. Cả hai bước đều sử dụng chung một endpoint.


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

Tạo Nhiệm vụ Xem trước Văn bản sang 3D

Endpoint này tạo một nhiệm vụ xem trước Văn bản sang 3D, tạo ra một lưới 3D chưa có bản đồ đắp texture (chỉ có hình học) từ một prompt văn bản. Đây là bước đầu tiên trong quy trình hai bước. Sau khi bản xem trước thành công, hãy dùng ID nhiệm vụ được trả về để tạo một nhiệm vụ refine nhằm áp texture. Xem Đối tượng Nhiệm vụ Văn bản sang 3D để biết đầy đủ lược đồ phản hồi.

Tham số

  • Name
    mode
    Type
    string
    Bắt buộc
    Description

    Trường này nên được đặt thành "preview" khi tạo một nhiệm vụ xem trước.

  • Name
    prompt
    Type
    string
    Bắt buộc
    Description

    Mô tả loại đối tượng mà mô hình 3D thể hiện. Tối đa 800 ký tự.

  • Name
    model_type
    Type
    string
    mặc định standard
    Description

    Chỉ định loại tạo lưới 3D.

    Các giá trị khả dụng:

    • standard: Tạo lưới 3D độ chi tiết cao thông thường.
    • smart-topology: Chọn mô hình Smart Topology với ai_model (meshy-t2).
    • lowpoly (không dùng nữa): Tạo lưới low-poly được tối ưu hóa cho các đa giác gọn hơn. Chúng tôi khuyến nghị dùng smart-topology thay thế.
  • Name
    ai_model
    Type
    string
    mặc định latest
    Description

    ID của mô hình sẽ sử dụng. Các giá trị khả dụng phụ thuộc vào model_type.

    Tạo theo chuẩn thông thường (model_type: standard):

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

    Tạo theo Smart Topology (model_type: smart-topology):

    • meshy-t2 (mặc định): mô hình Smart Topology — topology gọn gàng hơn, các bộ phận được tách biệt tự nhiên, đầu ra dạng tam giác, và số lượng mặt có thể thiết lập bằng target_polycount.
  • Name
    ultra_mode
    Type
    boolean
    mặc định false
    Description

    Bật chế độ tạo Ultra để có hình học độ trung thực cao hơn với chi tiết bề mặt tinh xảo hơn. Quá trình tạo mất nhiều thời gian hơn và tốn thêm 5 tín dụng.

  • Name
    should_remesh
    Type
    boolean
    mặc định false (meshy-6, meshy-7), true (others)
    Description

    Kiểm soát việc có bật giai đoạn remesh hay không. Đối với mô hình chất lượng cao nhất, chúng tôi khuyến nghị đặt should_remesh thành false.

Chỉ áp dụng khi should_remesh = true
  • Name
    topology
    Type
    string
    mặc định triangle
    Description

    Chỉ định topology của mô hình được tạo.

    Các giá trị khả dụng:

    • quad: Tạo một lưới chủ yếu là tứ giác.
    • triangle: Tạo một lưới tam giác đã được decimate.
  • Name
    decimation_mode
    Type
    integer
    Description

    Bật tính năng decimation thích ứng bằng cách đặt một mức số đa giác. Khi được đặt, target_polycount sẽ bị bỏ qua.

    Các giá trị khả dụng:

    • 1: Thích ứng — số đa giác cực cao.
    • 2: Thích ứng — số đa giác cao.
    • 3: Thích ứng — số đa giác trung bình.
    • 4: Thích ứng — số đa giác thấp.
  • Name
    target_polycount
    Type
    integer
    Description

    Số đa giác (mặt) mục tiêu trong đầu ra. Số lượng thực tế có thể khác với mục tiêu tùy thuộc vào hình học.

    target_polycount có tác dụng trong hai trường hợp độc lập:

    • Remesh — với should_remesh: true trên một mô hình standard. Lưới được remesh (decimate) xuống xấp xỉ số lượng này. Phạm vi từ 100 đến 300.000, mặc định 30.000. Nếu decimation_mode được đặt, nó sẽ được ưu tiên và target_polycount sẽ bị bỏ qua.
    • Smart Topology — với model_type: smart-topologyai_model: meshy-t2. Mô hình được tạo trực tiếp với số lượng mặt này; không có bước remesh nào chạy và không cần should_remesh. Phạm vi từ 100 đến 15.000, mặc định 4.000.
  • Name
    symmetry_mode
    Type
    string
    không dùng nữa
    mặc định auto
    Description

    Không dùng nữa. Tham số này không còn ảnh hưởng đến đầu ra.

    Trường symmetry_mode kiểm soát hành vi đối xứng trong quá trình tạo mô hình.

    Các giá trị hợp lệ là:

    • off: Tắt tính năng đối xứng.
    • auto: Tự động xác định và áp dụng tính đối xứng dựa trên hình học đầu vào.
    • on: Bắt buộc đối xứng trong quá trình tạo.
  • Name
    pose_mode
    Type
    string
    mặc định ""
    Description

    Chỉ định pose_mode cho mô hình được tạo.

    Các giá trị khả dụng:

    • a-pose: Tạo mô hình ở tư thế A.
    • t-pose: Tạo mô hình ở tư thế T.
    • "" (chuỗi rỗng): Không áp dụng tư thế cụ thể nào.
  • Name
    is_a_t_pose
    Type
    boolean
    không dùng nữa
    mặc định false
    Description

    Hãy dùng pose_mode thay thế. Xác định có tạo mô hình ở tư thế A/T hay không.

  • Name
    art_style
    Type
    string
    không dùng nữa
    mặc định realistic
    Description

    Không được hỗ trợ bởi Meshy-6. Các yêu cầu dùng Meshy-6 sẽ bỏ qua art_style, và một số kết hợp có thể gây ra lỗi. Các giá trị khả dụng: realistic, sculpture.

  • Name
    moderation
    Type
    boolean
    mặc định false
    Description

    Khi được đặt thành true, nội dung đầu vào sẽ tự động được kiểm duyệt để phát hiện nội dung có khả năng gây hại. Nếu phát hiện nội dung có hại, nhiệm vụ sẽ không tiếp tục tạo.

    Văn bản từ prompt sẽ được kiểm duyệt.

  • Name
    target_formats
    Type
    string[]
    Description

    Chỉ định các định dạng tệp 3D nào sẽ được đưa vào đầu ra. Chỉ những định dạng được yêu cầu mới được tạo ra và trả về, điều này có thể giảm thời gian hoàn thành nhiệm vụ. Khi bỏ trống, tất cả các định dạng được hỗ trợ sẽ được đưa vào.

    Các giá trị khả dụng: glb, obj, fbx, stl, usdz, 3mf

  • Name
    alpha_thumbnail
    Type
    boolean
    mặc định false
    Description

    Khi được đặt thành true, nhiệm vụ sẽ đồng thời kết xuất một phiên bản xem trước có nền trong suốt (RGBA) và trả về dưới dạng alpha_thumbnail_url trong phản hồi GET. Trường thumbnail_url hiện có không thay đổi.

  • Name
    auto_size
    Type
    boolean
    mặc định false
    Description

    Khi được đặt thành true, dịch vụ sẽ dùng AI vision để tự động ước tính chiều cao thực tế của đối tượng và đổi kích thước mô hình cho phù hợp. Gốc tọa độ sẽ mặc định là bottom trừ khi origin_at được đặt rõ ràng.

Chỉ áp dụng khi auto_size = true
  • Name
    origin_at
    Type
    string
    mặc định bottom
    Description

    Vị trí gốc tọa độ khi auto_size được bật.

    Các giá trị khả dụng: bottom, center.

Kết quả trả về

Thuộc tính result của phản hồi chứa id nhiệm vụ của nhiệm vụ Văn bản sang 3D vừa được tạo.

Các chế độ lỗi

  • Name
    400 - Bad Request
    Description

    Yêu cầu không thể chấp nhận được. Các nguyên nhân phổ biến:

    • Thiếu tham số: Thiếu một tham số bắt buộc (ví dụ: prompt, mode).
    • Tham số không hợp lệ: art_style không phải là một trong các giá trị được cho phép.
    • Prompt quá dài: prompt vượt quá giới hạn ký tự.
  • Name
    401 - Unauthorized
    Description

    Xác thực thất bại. Vui lòng kiểm tra khóa API của bạn.

  • Name
    402 - Payment Required
    Description

    Không đủ tín dụng để thực hiện nhiệm vụ này.

  • Name
    429 - Too Many Requests
    Description

    Bạn đã vượt quá giới hạn tốc độ.

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

Create a Text to 3D Refine Task

Endpoint này tạo một tác vụ refine cho Văn bản sang 3D, áp dụng texture lên một lưới preview đã hoàn thành. Bạn phải cung cấp preview_task_id từ một tác vụ preview thành công. Đây là bước thứ hai trong quy trình hai bước.

Tham số

  • Name
    mode
    Type
    string
    Bắt buộc
    Description

    Trường này nên được đặt là "refine" khi tạo một tác vụ refine.

  • Name
    preview_task_id
    Type
    string
    Bắt buộc
    Description

    ID của tác vụ preview tương ứng.

    Trạng thái của tác vụ preview đã cho phải là SUCCEEDED.

  • Name
    enable_pbr
    Type
    boolean
    mặc định false
    Description

    Tạo bản đồ PBR (metallic, roughness, normal) ngoài base color. Bản đồ emission cũng được bao gồm khi ai_modelmeshy-6, ngoại trừ ở texture_resolution: 8k (không tạo bản đồ emission). meshy-7 (và latest) không tạo bản đồ emission.

  • Name
    texture_resolution
    Type
    string
    mặc định 2k
    Description

    Độ phân giải texture base color. Một trong các giá trị 2k (2048×2048), 4k (4096×4096), hoặc 8k (8192×8192). Độ phân giải cao hơn ghi lại nhiều chi tiết bề mặt hơn. Chỉ áp dụng cho mode refine.

  • Name
    hd_texture
    Type
    boolean
    không dùng nữa
    mặc định false
    Description

    Sử dụng texture_resolution thay thế — tương đương với texture_resolution: "4k". Khi cả hai được đặt, texture_resolution sẽ được ưu tiên.

  • Name
    texture_prompt
    Type
    string
    Description

    Cung cấp một prompt văn bản bổ sung để định hướng quá trình tạo texture. Tối đa 800 ký tự.

  • Name
    texture_image_url
    Type
    string
    Description

    Cung cấp một hình ảnh 2d để định hướng quá trình tạo texture. Chúng tôi hiện hỗ trợ các định dạng .jpg, .jpeg, và .png.

    Có hai cách để cung cấp hình ảnh:

    • URL truy cập công khai: Một URL có thể truy cập được từ internet công cộng
    • Data URI: Một data URI được mã hóa base64 của hình ảnh. Ví dụ về một data URI: data:image/jpeg;base64,<your base64-encoded image data>
  • Name
    ai_model
    Type
    string
    mặc định latest
    Description

    ID của model được sử dụng để refine. Các giá trị khả dụng: meshy-5, meshy-6, meshy-7, latest (Meshy 7).

  • Name
    moderation
    Type
    boolean
    mặc định false
    Description

    Khi được đặt là true, nội dung đầu vào sẽ tự động được kiểm duyệt để phát hiện nội dung có khả năng gây hại. Nếu phát hiện nội dung có hại, tác vụ sẽ không tiếp tục quá trình tạo.

    Cả văn bản từ texture_prompt và hình ảnh từ texture_image_url đều sẽ được kiểm duyệt.

  • Name
    remove_lighting
    Type
    boolean
    mặc định true
    Description

    Loại bỏ các điểm sáng và bóng đổ khỏi texture base color, tạo ra kết quả sạch hơn, hoạt động tốt hơn dưới các thiết lập ánh sáng tùy chỉnh.

  • Name
    target_formats
    Type
    string[]
    Description

    Chỉ định các định dạng tệp 3D nào sẽ được bao gồm trong đầu ra. Chỉ các định dạng được yêu cầu mới được tạo và trả về, điều này có thể giảm thời gian hoàn thành tác vụ. Khi bị bỏ qua, tất cả các định dạng được hỗ trợ sẽ được bao gồm.

    Các giá trị khả dụng: glb, obj, fbx, stl, usdz, 3mf

  • Name
    alpha_thumbnail
    Type
    boolean
    mặc định false
    Description

    Khi được đặt là true, tác vụ sẽ tạo thêm một phiên bản nền trong suốt (RGBA) của bản preview và trả về dưới dạng alpha_thumbnail_url trong phản hồi GET. Trường thumbnail_url hiện có không thay đổi.

  • Name
    auto_size
    Type
    boolean
    mặc định false
    Description

    Khi được đặt là true, dịch vụ sẽ sử dụng AI vision để tự động ước tính chiều cao thực tế của đối tượng và thay đổi kích thước mô hình cho phù hợp. Gốc tọa độ sẽ mặc định là bottom trừ khi origin_at được thiết lập rõ ràng.

Chỉ áp dụng khi auto_size = true
  • Name
    origin_at
    Type
    string
    mặc định bottom
    Description

    Vị trí của gốc tọa độ khi auto_size được bật.

    Các giá trị khả dụng: bottom, center.

Kết quả trả về

Thuộc tính result của phản hồi chứa id của tác vụ Văn bản sang 3D vừa được tạo.

Các chế độ thất bại

  • Name
    400 - Bad Request
    Description

    Yêu cầu không được chấp nhận. Các nguyên nhân phổ biến:

    • ID tác vụ không hợp lệ: preview_task_id không hợp lệ hoặc không tồn tại.
    • Tác vụ chưa sẵn sàng: Tác vụ preview chưa thành công.
    • Không khớp model: AI model của tác vụ preview không tương thích với model refine được yêu cầu.
  • Name
    401 - Unauthorized
    Description

    Xác thực thất bại. Vui lòng kiểm tra khóa API của bạn.

  • Name
    402 - Payment Required
    Description

    Không đủ tín dụng để thực hiện tác vụ này.

  • Name
    404 - Not Found
    Description

    Không tìm thấy tác vụ preview được chỉ định bởi preview_task_id.

  • Name
    429 - Too Many Requests
    Description

    Bạn đã vượt quá giới hạn tốc độ.

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

Truy xuất một Nhiệm vụ Văn bản sang 3D

Endpoint này cho phép bạn truy xuất một nhiệm vụ Văn bản sang 3D với một id nhiệm vụ hợp lệ. Tham khảo Đối tượng Nhiệm vụ Văn bản sang 3D để xem các thuộc tính nào được bao gồm với đối tượng nhiệm vụ Văn bản sang 3D.

Endpoint này hoạt động cho cả nhiệm vụ xem trước và tinh chỉnh.

Tham số

  • Name
    id
    Type
    path
    Description

    Định danh duy nhất cho nhiệm vụ Văn bản sang 3D cần truy xuất.

Trả về

Phản hồi chứa đối tượng nhiệm vụ Văn bản sang 3D. Kiểm tra phần Đối tượng Nhiệm vụ Văn bản sang 3D để biết chi tiết.

Ví dụ

Chế độMô hình mẫu
Xem trướcMô hình xem trước
Tinh chỉnhMô hình tinh chỉnh

Yêu cầu

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

Phản hồi

{
  "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

Xóa một Nhiệm vụ Văn bản sang 3D

Endpoint này xóa vĩnh viễn một nhiệm vụ Văn bản sang 3D, bao gồm tất cả các mô hình và dữ liệu liên quan. Hành động này không thể đảo ngược.

Tham số Đường dẫn

  • Name
    id
    Type
    path
    Description

    ID của nhiệm vụ Văn bản sang 3D cần xóa.

Trả về

Trả về 200 OK khi thành công.

Yêu cầu

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

Phản hồi

// Returns 200 Ok on success.

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

Danh sách Nhiệm vụ Văn bản sang 3D

Endpoint này cho phép bạn truy xuất danh sách các nhiệm vụ Văn bản sang 3D.

Tham số

  • Name
    page_num
    Type
    integer
    mặc định 1
    Description

    Số trang cho phân trang.

  • Name
    page_size
    Type
    integer
    mặc định 10
    Description

    Giới hạn kích thước trang. Tối đa cho phép là 50 mục.

  • Name
    sort_by
    Type
    string
    Description

    Trường để sắp xếp.

    Các giá trị có sẵn:

    • +created_at: Sắp xếp theo thời gian tạo theo thứ tự tăng dần.
    • -created_at: Sắp xếp theo thời gian tạo theo thứ tự giảm dần.

Trả về

Trả về danh sách phân trang của Các Đối tượng Nhiệm vụ Văn bản sang 3D.

Yêu cầu

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

Phản hồi

[
  {
    "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

Truyền tải một Nhiệm vụ Văn bản sang 3D

Endpoint này truyền tải các cập nhật thời gian thực cho một nhiệm vụ Văn bản sang 3D sử dụng Server-Sent Events (SSE).

Tham số

  • Name
    id
    Type
    path
    Description

    Định danh duy nhất cho nhiệm vụ Văn bản sang 3D để truyền tải.

Trả về

Trả về một luồng của Các Đối tượng Nhiệm vụ Văn bản sang 3D dưới dạng Server-Sent Events.

Đối với các nhiệm vụ PENDING hoặc IN_PROGRESS, luồng phản hồi sẽ chỉ bao gồm các trường progressstatus cần thiết.

Yêu cầu

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

Luồng Phản hồi

// 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
}

Đối tượng Nhiệm vụ Văn bản sang 3D

Đối tượng Nhiệm vụ Văn bản sang 3D là một đơn vị công việc mà Meshy theo dõi để tạo ra một mô hình 3D từ đầu vào văn bản. Có hai giai đoạn của API Văn bản sang 3D, previewrefine. Giai đoạn preview là để tạo ra một mô hình 3D chỉ có lưới, và giai đoạn refine là để tạo ra một mô hình 3D có texture dựa trên kết quả của giai đoạn preview.

Đối tượng có các thuộc tính sau:

Thuộc tính

  • Name
    id
    Type
    string
    Description

    Định danh duy nhất cho nhiệm vụ. Mặc dù chúng tôi sử dụng UUID có thể sắp xếp k cho id nhiệm vụ như một chi tiết triển khai, bạn không nên đưa ra bất kỳ giả định nào về định dạng của id.

  • Name
    type
    Type
    string
    Description

    Loại nhiệm vụ Văn bản sang 3D. Các giá trị có thể là text-to-3d-preview cho các nhiệm vụ giai đoạn preview và text-to-3d-refine cho các nhiệm vụ giai đoạn refine.

  • Name
    model_urls
    Type
    object
    Description

    URL có thể tải xuống cho tệp mô hình 3D có texture được tạo bởi Meshy. Thuộc tính cho một định dạng sẽ bị bỏ qua nếu định dạng không được tạo thay vì trả về một chuỗi rỗng.

    • Name
      glb
      Type
      string
      Description

      URL có thể tải xuống cho tệp GLB.

    • Name
      fbx
      Type
      string
      Description

      URL có thể tải xuống cho tệp FBX.

    • Name
      usdz
      Type
      string
      Description

      URL có thể tải xuống cho tệp USDZ.

    • Name
      obj
      Type
      string
      Description

      URL có thể tải xuống cho tệp OBJ.

    • Name
      mtl
      Type
      string
      Description

      URL có thể tải xuống cho tệp MTL.

    • Name
      stl
      Type
      string
      Description

      URL có thể tải xuống cho tệp STL.

    • Name
      3mf
      Type
      string
      Description

      URL có thể tải xuống cho tệp 3MF. Chỉ có khi 3mf được yêu cầu thông qua target_formats.

  • Name
    prompt
    Type
    string
    Description

    Đây là prompt không thay đổi đã được sử dụng để tạo nhiệm vụ.

  • Name
    negative_prompt
    Type
    string
    không dùng nữa
    Description

    Duy trì để tương thích ngược. Trường này không có tác động chức năng đến các mô hình được tạo ra.

  • Name
    art_style
    Type
    string
    không dùng nữa
    Description

    art_style không thay đổi đã được sử dụng để tạo nhiệm vụ preview. Không được hỗ trợ bởi Meshy-6.

  • Name
    texture_richness
    Type
    string
    không dùng nữa
    Description

    Duy trì để tương thích ngược. Trường này không có tác động chức năng đến các mô hình được tạo ra.

  • Name
    texture_prompt
    Type
    string
    Description

    Prompt văn bản bổ sung được cung cấp để hướng dẫn quá trình tạo texture trong giai đoạn refine.

  • Name
    ultra_mode
    Type
    boolean
    Description

    Phản ánh giá trị ultra_mode mà nhiệm vụ preview được tạo ra. Chỉ có mặt cho các nhiệm vụ preview meshy-7 (hoặc latest) mà đã đặt ultra_mode rõ ràng; nếu không thì bị bỏ qua.

  • Name
    texture_image_url
    Type
    string
    Description

    URL có thể tải xuống cho hình ảnh texture đã được sử dụng để hướng dẫn quá trình tạo texture.

  • Name
    thumbnail_url
    Type
    string
    Description

    URL có thể tải xuống cho ảnh thu nhỏ của tệp mô hình.

  • Name
    alpha_thumbnail_url
    Type
    string
    Description

    URL có thể tải xuống cho phiên bản nền trong suốt (RGBA) của thumbnail_url. Chỉ có khi nhiệm vụ được tạo với alpha_thumbnail: true và bản xem trước trong suốt đã được render thành công; nếu không thì trường này bị bỏ qua.

  • Name
    video_url
    Type
    string
    không dùng nữa
    Description

    URL có thể tải xuống cho video preview. Sẽ bị loại bỏ trong bản phát hành tương lai.

  • Name
    progress
    Type
    integer
    Description

    Tiến độ của nhiệm vụ. Nếu nhiệm vụ chưa bắt đầu, thuộc tính này sẽ là 0. Khi nhiệm vụ đã thành công, điều này sẽ trở thành 100.

  • Name
    started_at
    Type
    timestamp
    Description

    Dấu thời gian khi nhiệm vụ được bắt đầu, tính bằng mili giây. Nếu nhiệm vụ chưa bắt đầu, thuộc tính này sẽ là 0.

  • Name
    created_at
    Type
    timestamp
    Description

    Dấu thời gian khi nhiệm vụ được tạo, tính bằng mili giây.

  • Name
    finished_at
    Type
    timestamp
    Description

    Dấu thời gian khi nhiệm vụ được hoàn thành, tính bằng mili giây. Nếu nhiệm vụ chưa hoàn thành, thuộc tính này sẽ là 0.

  • Name
    status
    Type
    string
    Description

    Trạng thái của nhiệm vụ. Các giá trị có thể là một trong PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    texture_urls
    Type
    array
    Description

    Một mảng các đối tượng URL texture được tạo ra từ nhiệm vụ. Thông thường, điều này chỉ chứa một đối tượng URL texture. Mỗi URL texture có các thuộc tính sau:

    • Name
      base_color
      Type
      string
      Description

      URL có thể tải xuống cho hình ảnh bản đồ màu cơ bản.

    • Name
      metallic
      Type
      string
      Description

      URL có thể tải xuống cho hình ảnh bản đồ metallic.

    • Name
      normal
      Type
      string
      Description

      URL có thể tải xuống cho hình ảnh bản đồ normal.

    • Name
      roughness
      Type
      string
      Description

      URL có thể tải xuống cho hình ảnh bản đồ roughness.

    • Name
      emission
      Type
      string
      Description

      URL có thể tải xuống cho hình ảnh bản đồ emission.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Số lượng nhiệm vụ trước đó.

  • Name
    task_error
    Type
    object
    Description

    Chi tiết lỗi cho các nhiệm vụ thất bại. Xem Lỗi để tham khảo đầy đủ đối tượng task_error.

  • Name
    consumed_credits
    Type
    integer
    Description

    Số lượng tín dụng đã tiêu thụ bởi nhiệm vụ này. Có mặt khi trạng thái nhiệm vụ là PENDING, IN_PROGRESS, hoặc SUCCEEDED. Trả về 0 cho các nhiệm vụ FAILED (tín dụng được hoàn lại khi thất bại).

Ví dụ về Đối tượng Nhiệm vụ Văn bản sang 3D

{
  "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
}