lowpoly sẽ ngừng hoạt động vào 30 thg 10, 2026. Hãy chuyển sang mô hình khác trước các ngày này để tránh lỗi yêu cầu.

Text to 3D API

Text to 3D API 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 sử dụng API này.

Văn bản sang 3D sử dụng quy trình làm việc gồm hai bước. Đầu tiên, tạo một tác vụ preview (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 đó, truyền ID tác vụ của preview đã hoàn thành vào một tác vụ refine (mode: "refine") để áp dụng texture cho lưới. Cả hai bước đều dùng chung một endpoint.


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

Create a Text to 3D Preview Task

Endpoint này tạo một tác vụ xem trước Văn bản sang 3D, tạo ra một lưới 3D chưa có 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 tác vụ được trả về để tạo một tác vụ refine để thêm texture. Tham khảo Đối tượng Tác vụ Văn bản sang 3D để biết schema phản hồi đầy đủ.

Tác vụ chạy ở chế độ nền. Để biết thời gian thường mất, xem Thời gian xử lý.

Tham số

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

    Trường này cần được đặt là "preview" khi tạo một tác 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 hình 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 hoặc meshy-t2.5).
    • lowpoly (không dùng nữa, sẽ ngừng hỗ trợ vào ngày 30 tháng 10 năm 2026): Tạo lưới low-poly được tối ưu hóa cho các đa giác gọn gàng hơn. Chúng tôi khuyến nghị sử dụng Meshy T2.5 thay thế: smart-topology với meshy-t2.5.
  • Name
    ai_model
    Type
    string
    mặc định latest
    Description

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

    Tạo dạng tiêu chuẩn (model_type: standard):

    • meshy-6-lite, meshy-6, meshy-7.1, latest (Meshy 7.1)
    • meshy-7 (không dùng nữa): hãy dùng meshy-7.1 thay thế.

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

    • meshy-t2: mô hình Smart Topology — topology gọn gàng hơn, các bộ phận được tách tự nhiên, đầu ra tam giác, và số lượng mặt có thể thiết lập bằng target_polycount.
    • meshy-t2.5 (mặc định): Chi tiết sắc nét hơn cho asset trong game. Đầu ra tam giác, và số lượng mặt có thể thiết lập bằng target_polycount.
  • Name
    geometry_resolution
    Type
    string
    mặc định standard
    Description

    Giai đoạn tạo hình học. 2k chạy tiến trình Ultra ở độ phân giải 2048³; 4k chạy ở độ phân giải 4096³ để cho chi tiết bề mặt tinh xảo nhất.

    Các giá trị khả dụng: standard, 2k, 4k

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

    Hãy dùng geometry_resolution thay thế. ultra_mode: true tương đương với geometry_resolution: "2k".

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

    Kiểm soát việc có bật giai đoạn remesh hay không. Để đạt chất lượng mô hình cao nhất, chúng tôi khuyến nghị đặt should_remesh là 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 ra.

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

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

    Bật chế độ giản lược thích ứng bằng cách thiết lập mức số đa giác. Khi được thiết lập, 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ố lượng đa giác (mặt) mục tiêu trong đầu ra. Số lượng thực tế có thể lệch so với mục tiêu tùy thuộc vào hình học.

    target_polycount có hiệu lực trong hai trường hợp độc lập:

    • Remesh — với should_remesh: true trên mô hình standard. Lưới sẽ được remesh (giản lược) về xấp xỉ số lượng này. Khoảng từ 100 đến 300.000, mặc định 30.000. Nếu decimation_mode được thiết lập, nó sẽ được ưu tiên và target_polycount sẽ bị bỏ qua.
    • Smart Topology — với model_type: smart-topology và ai_model là meshy-t2 hoặc meshy-t2.5. 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. Với meshy-t2: khoảng từ 100 đến 15.000, mặc định 4.000. Với meshy-t2.5: khoảng từ 100 đến 30.000, mặc định 15.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 đối xứng.
    • auto: Tự động xác định và áp dụng đối xứng dựa trên hình học đầu vào.
    • on: 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 ra.

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

    • a-pose: Tạo mô hình ở tư thế chữ A.
    • t-pose: Tạo mô hình ở tư thế chữ 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ế. 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 sử dụng Meshy-6 sẽ bỏ qua art_style, và một số 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 là true, nội dung đầu vào sẽ tự động được sàng lọc để phát hiện nội dung có khả năng gây hại. Nếu phát hiện nội dung gây hại, tác vụ sẽ không tiếp tục sang bước tạo.

    Văn bản từ prompt sẽ được sàng lọc.

  • Name
    target_formats
    Type
    string[]
    Description

    Chỉ định những định dạng tệp 3D nào cần có trong đầu ra. Chỉ các đị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 tác vụ. Khi bỏ trống, 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ẽ render thêm một phiên bản nền trong suốt (RGBA) của bản xem trước 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à đổi kích thước mô hình tương ứng. 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.

Giá trị trả về

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

Các trường hợp 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:

    • 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ự.
    • Mô hình không được hỗ trợ cho low poly: ai_model: "meshy-6-lite" không hỗ trợ model_type: "lowpoly".
    • Mô hình không được hỗ trợ cho Ultra: geometry_resolution yêu cầu meshy-7.1 hoặc latest.
  • 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
    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 Ultra 4K geometry, 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",
  "ai_model": "meshy-7.1",
  "geometry_resolution": "4k",
  "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

Tạo tác vụ Refine Văn bản sang 3D

Endpoint này tạo một tác vụ refine Văn bản sang 3D, áp dụng texture cho 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 làm việc hai bước.

Tác vụ chạy ở chế độ nền. Để biết thời gian thường mất bao lâu, xem Thời gian xử lý.

Tham số

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

    Trường này nên được đặt thành "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 màu nền (base color). Bản đồ emission cũng được bao gồm khi ai_model là meshy-6, ngoại trừ ở texture_resolution: 8k (không tạo bản đồ emission). meshy-6-lite, meshy-7.1 và latest không tạo bản đồ emission, và một refine của preview meshy-t2 không đặt ai_model cũng vậy.

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

    Độ phân giải texture màu nền. 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 sẽ nắm bắt được 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

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

  • Name
    texture_prompt
    Type
    string
    Description

    Cung cấp thêm một prompt văn bản để đị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. Hiện tại chúng tôi hỗ trợ các định dạng .jpg, .jpeg, .png, và .webp.

    Kích thước tệp tối đa: 20 MB.

    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 khai
    • Data URI: Một data URI của hình ảnh được mã hóa base64. Ví dụ về một data URI: data:image/jpeg;base64,<dữ liệu hình ảnh được mã hóa base64 của bạn>
  • Name
    ai_model
    Type
    string
    mặc định inherited from the preview task
    Description

    ID của mô hình được dùng để refine.

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

    • meshy-6-lite, meshy-6, meshy-7.1, latest (Meshy 7.1)
    • meshy-7 (không dùng nữa): hãy dùng meshy-7.1 thay thế.

    Bỏ qua tham số này để kế thừa mô hình được sử dụng bởi tác vụ preview, giữ cho một preview và refine của nó dùng cùng một mô hình xuyên suốt. Truyền một giá trị rõ ràng để ghi đè việc kế thừa đó.

  • 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 để tìm nội dung có khả năng gây hại. Nếu phát hiện nội dung gây hại, tác vụ sẽ không tiếp tục 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 highlight và bóng khỏi texture màu nền, tạo ra một kết quả sạch hơn, hoạt động tốt hơn với các thiết lập ánh sáng tùy chỉnh.

  • Name
    target_formats
    Type
    string[]
    Description

    Chỉ định những định dạng tệp 3D nào sẽ được bao gồm trong đầu ra. Chỉ những đị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ỏ 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 thành true, tác vụ sẽ render thêm một phiên bản nền trong suốt (RGBA) của preview và trả về dưới dạng alpha_thumbnail_url trong phản hồi GET. Trường thumbnail_url hiện có vẫn không thay đổi.

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

    Khi được đặt thành 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 tương ứng. 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í 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 tác vụ của tác vụ Văn bản sang 3D vừa được tạo.

Chế độ lỗ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 mô hình: Mô hình AI của tác vụ preview không tương thích với mô hình refine được yêu cầu.
    • Mô hình không hỗ trợ remove_lighting: remove_lighting được đặt cùng với ai_model: "meshy-6-lite".
  • 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

Retrieve a Text to 3D Task

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

Endpoint này hoạt động cho cả tác vụ preview và refine.

Tham số

  • Name
    id
    Type
    path
    Description

    Định danh duy nhất của tác vụ Văn bản sang 3D cần truy xuất.

Kết quả trả về

Phản hồi chứa đối tượng tác vụ Văn bản sang 3D. Xem phần The Text to 3D Task Object để biết chi tiết.

Ví dụ

ModeMô hình mẫu
PreviewPreview model
RefineRefined 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

Xóa tác vụ Văn bản sang 3D

Endpoint này xóa vĩnh viễn một tác 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ể hoàn tác.

Tham số đường dẫn

  • Name
    id
    Type
    path
    Description

    ID của tác vụ Văn bản sang 3D cần xóa.

Trạng thái tác vụ

Một tác vụ vẫn đang ở trạng thái PENDING sẽ được xóa và số tín dụng đã tiêu khi tạo sẽ được hoàn lại.

Một tác vụ đã ở trạng thái IN_PROGRESS thì không thể xóa: yêu cầu sẽ bị từ chối với mã 409 Conflict và tác vụ vẫn tiếp tục chạy. Tín dụng cho một tác vụ mà worker đã bắt đầu xử lý sẽ không được hoàn lại, vì vậy việc xóa nó giữa chừng sẽ khiến bạn mất cả tín dụng lẫn kết quả. Hãy đợi cho đến khi tác vụ đạt trạng thái SUCCEEDED, FAILED hoặc CANCELED, rồi mới xóa.

Một tác vụ ở trạng thái cuối (SUCCEEDED, FAILED hoặc CANCELED) sẽ được xóa mà không được hoàn tín dụng.

Giá trị trả về

Trả về 200 OK khi thành công, hoặc 409 Conflict khi tác vụ đang ở trạng thái IN_PROGRESS.

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

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS — the task is left running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}

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

List Text to 3D Tasks

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

Tham số

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

    Số trang dùng cho phân trang.

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

    Giới hạn số lượng mỗi trang. Tối đa cho phép là 100 mục.

  • Name
    sort_by
    Type
    string
    Description

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

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

    • +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.

Giá trị trả về

Trả về một danh sách phân trang các Đối tượng Tác vụ Văn bản sang 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

Stream a Text to 3D Task

Endpoint này truyền trực tiếp các cập nhật theo thời gian thực cho một tác vụ Văn bản sang 3D bằng Server-Sent Events (SSE).

Tham số

  • Name
    id
    Type
    path
    Description

    Mã định danh duy nhất cho tác vụ Văn bản sang 3D cần truyền trực tiếp.

Giá trị trả về

Trả về một luồng The Text to 3D Task Objects dưới dạng Server-Sent Events.

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

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
}

Đối tượng Task Văn bản sang 3D

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

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

Thuộc tính

  • Name
    id
    Type
    string
    Description

    Định danh duy nhất cho task. Mặc dù chúng tôi sử dụng UUID có thể sắp xếp theo k (k-sortable UUID) làm chi tiết triển khai cho id của task, 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 của task Văn bản sang 3D. Các giá trị có thể là text-to-3d-preview cho các task ở giai đoạn preview và text-to-3d-refine cho các task ở giai đoạn refine.

  • Name
    model_urls
    Type
    object
    Description

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

    • Name
      glb
      Type
      string
      Description

      URL để tải xuống tệp GLB.

    • Name
      fbx
      Type
      string
      Description

      URL để tải xuống tệp FBX.

    • Name
      usdz
      Type
      string
      Description

      URL để tải xuống tệp USDZ.

    • Name
      obj
      Type
      string
      Description

      URL để tải xuống tệp OBJ.

    • Name
      mtl
      Type
      string
      Description

      URL để tải xuống tệp MTL.

    • Name
      stl
      Type
      string
      Description

      URL để tải xuống tệp STL.

    • Name
      3mf
      Type
      string
      Description

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

  • Name
    prompt
    Type
    string
    Description

    Đây là prompt không bị chỉnh sửa đã được dùng để tạo task.

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

    Được giữ lại để đảm bảo khả năng tương thích ngược. Trường này không có tác động chức năng nào đế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 bị chỉnh sửa đã được dùng để tạo task preview. Không được hỗ trợ bởi Meshy-6.

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

    Được giữ lại để đảm bảo khả năng tương thích ngược. Trường này không có tác động chức năng nào đế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 để định hướng quá trình tạo texture trong giai đoạn refine.

  • Name
    ultra_mode
    Type
    boolean
    ⚠ không dùng nữa
    Description

    Không dùng nữa; hãy đọc geometry_resolution thay thế.

  • Name
    geometry_resolution
    Type
    string
    Description

    Cấp Ultra mà task preview đã chạy (2k hoặc 4k); bị bỏ qua đối với standard.

  • Name
    texture_image_url
    Type
    string
    Description

    URL để tải xuống hình ảnh texture đã được dùng để định hướng quá trình tạo texture.

  • Name
    thumbnail_url
    Type
    string
    Description

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

  • Name
    alpha_thumbnail_url
    Type
    string
    Description

    URL để tải xuống phiên bản nền trong suốt (RGBA) của thumbnail_url. Chỉ xuất hiện khi task được tạo với alpha_thumbnail: true và bản xem trước trong suốt đã được kết xuất thành công; nếu không, trường này sẽ bị bỏ qua.

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

    URL để tải xuống video xem trước. Sẽ bị xóa trong một bản phát hành trong tương lai.

  • Name
    progress
    Type
    integer
    Description

    Tiến trình của task. Nếu task chưa bắt đầu, thuộc tính này sẽ là 0. Khi task đã thành công, giá trị này sẽ trở thành 100.

  • Name
    started_at
    Type
    timestamp
    Description

    Dấu thời gian cho biết thời điểm task bắt đầu, tính bằng mili giây. Nếu task 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 cho biết thời điểm task được tạo, tính bằng mili giây.

  • Name
    finished_at
    Type
    timestamp
    Description

    Dấu thời gian cho biết thời điểm task hoàn thành, tính bằng mili giây. Nếu task 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 task. Các giá trị có thể là một trong các giá trị 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ừ task. Thông thường mảng 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 để tải xuống hình ảnh bản đồ màu cơ bản (base color map).

    • Name
      metallic
      Type
      string
      Description

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

    • Name
      normal
      Type
      string
      Description

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

    • Name
      roughness
      Type
      string
      Description

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

    • Name
      emission
      Type
      string
      Description

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

  • Name
    preceding_tasks
    Type
    integer
    Description

    Số lượng task đứng trước.

  • Name
    task_error
    Type
    object
    Description

    Chi tiết lỗi cho các task thất bại. Xem Lỗi để biết tài liệu tham khảo đầy đủ về đối tượng task_error.

  • Name
    consumed_credits
    Type
    integer
    Description

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

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
}