API Ảnh sang 3D

API Ảnh sang 3D là một tính năng cho phép bạn tích hợp khả năng Ảnh 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.

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

Create an Image to 3D Task

Endpoint này cho phép bạn tạo một tác vụ Ảnh sang 3D mới. Tham khảo The Image to 3D Task Object để xem những thuộc tính nào được bao gồm trong đối tượng tác vụ Ảnh sang 3D.

Tham số

Chỉ một trong hai tham số input_task_id hoặc image_url là bắt buộc. Nếu cả hai đều được cung cấp, input_task_id sẽ được ưu tiên.

Name
input_task_id
Type
string
Bắt buộc
Description
ID của một tác vụ tạo ảnh đã hoàn thành, có kết quả đầu ra sẽ được sử dụng làm ảnh đầu vào. Tác vụ này phải là một trong các loại sau: Văn bản sang ảnh hoặc Ảnh sang ảnh. Ngoài ra, nó phải được chạy thông qua API, có trạng thái là SUCCEEDED, và tạo ra chính xác một ảnh.

Name
image_url
Type
string
Bắt buộc
Description
Cung cấp một ảnh để Meshy sử dụng trong việc tạo mô hình. Hiện tại chúng tôi hỗ trợ các định dạng .jpg, .jpeg, và .png.
Có hai cách để cung cấp ảnh:
- URL công khai: Một URL có thể truy cập được từ internet công cộng.
- Data URI: Một chuỗi Data URI mã hóa base64 của ảnh. Ví dụ về một Data URI: data:image/jpeg;base64,<dữ liệu ảnh mã hóa base64 của bạn>.

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ị sử dụng smart-topology thay thế.
Khi chọn smart-topology, các tham số topology, should_remesh, và save_pre_remeshed_model sẽ bị bỏ qua.
Khi chọn lowpoly, các tham số ai_model, topology, target_polycount, should_remesh, và save_pre_remeshed_model sẽ bị bỏ qua.
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 tiêu chuẩn (model_type: standard):
- meshy-5, meshy-6, meshy-7, latest (Meshy 7)
Tạo 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 riêng một cách 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 độ chân thực cao hơn với chi tiết bề mặt tinh xảo hơn.
Chỉ được hỗ trợ khi ai_model là meshy-7 (hoặc latest).
Name
should_texture
Type
boolean
mặc định true
Description
Xác định xem có tạo texture hay không. Đặt thành false sẽ bỏ qua giai đoạn tạo texture, cho ra một lưới không có texture.

Chỉ áp dụng khi should_texture = true

Name
enable_pbr
Type
boolean
mặc định false
Description
Tạo bản đồ PBR (metallic, roughness, normal) bên cạnh màu nền (base color). Một bản đồ phát xạ (emission map) cũng được bao gồm khi ai_model là meshy-6, ngoại trừ ở texture_resolution: 8k. meshy-7 và latest không tạo bản đồ phát xạ.
Name
texture_resolution
Type
string
mặc định 2k
Description
Độ phân giải texture màu nền (base color). Một trong các giá trị 2k (2048×2048), 4k (4096×4096), hoặc 8k (8192×8192). Độ phân giải càng cao càng ghi lại được nhiều chi tiết bề mặt hơn.
4k và 8k không khả dụng với ai_model: meshy-5. Ở mức 8k, không có bản đồ phát xạ nào được tạo ra.
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 đều được thiết lập, texture_resolution sẽ được ưu tiên.
Name
texture_prompt
Type
string
Description
Cung cấp 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 ả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, và .png.
Có hai cách để cung cấp ảnh:
- URL công khai: Một URL có thể truy cập được từ internet công cộng
- Data URI: Một chuỗi Data URI mã hóa base64 của ảnh. Ví dụ về một Data URI: data:image/jpeg;base64,<dữ liệu ảnh mã hóa base64 của bạn>
Việc tạo texture theo ảnh có thể không hoạt động tối ưu nếu có sự khác biệt đáng kể về hình học giữa tài sản gốc và ảnh được tải lên. Chỉ một trong hai tham số texture_image_url hoặc texture_prompt có thể được sử dụng để định hướng quá trình tạo texture. Nếu cả hai tham số đều được cung cấp, thì texture_prompt sẽ được mặc định sử dụng để tạo texture cho mô hình. Việc tạo texture thông qua văn bản hoặc ảnh sẽ tốn 10 tín dụng cho mỗi tác vụ.

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. Để có 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 ra.
Các giá trị khả dụng:
- quad: Tạo một lưới chủ yếu là tứ giác (quad-dominant).
- triangle: Tạo một lưới tam giác được giản lược (decimated).
Name
decimation_mode
Type
integer
Description
Bật chế độ giản lược thích ứng (adaptive decimation) bằng cách thiết lập một 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 (ultra).
- 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
save_pre_remeshed_model
Type
boolean
mặc định false
Description
Khi được đặt thành true, Meshy sẽ đồng thời lưu trữ thêm một tệp GLB trước khi giai đoạn remesh hoàn tất.

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ể chênh 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ột mô hình standard. Lưới sẽ được remesh (giản lược) xuống xấp xỉ số lượng này. Phạm vi từ 100 đến 300.000, mặc định là 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: meshy-t2. Mô hình được tạo trực tiếp với số mặt này; không có quá trình remesh nào chạy và should_remesh là không cần thiết. Phạm vi từ 100 đến 15.000, mặc định là 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 áp dụng tính đối xứng trong quá trình tạo.
Name
pose_mode
Type
string
mặc định ""
Description
Chỉ định mode tư thế 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
Sử dụng pose_mode thay thế. Xác định có tạo mô hình ở tư thế A/T hay không.
Name
image_enhancement
Type
boolean
mặc định true
Description
Tối ưu hóa ảnh đầu vào để có kết quả tốt hơn. Đặt thành false để giữ nguyên chính xác hình dáng của ảnh đầu vào mà không qua bất kỳ xử lý phong cách nào.
Chỉ được hỗ trợ khi ai_model là meshy-6, meshy-7, hoặc latest.
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 màu nền (base color), tạo ra kết quả gọn gàng hơn, phù hợp hơn khi sử dụng với các thiết lập ánh sáng tùy chỉnh.
Chỉ được hỗ trợ khi ai_model là meshy-6.
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 gây hại, tác vụ sẽ không tiếp tục quá trình tạo.
Nội dung từ các đầu vào image_url, texture_image_url, và texture_prompt sẽ được kiểm duyệt.
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 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ợ đều được bao gồm.
Các giá trị khả dụng: glb, obj, fbx, stl, usdz, 3mf
Khi bỏ trống, tất cả các định dạng ngoại trừ 3mf sẽ được tạo ra. 3mf chỉ được bao gồm khi được chỉ định rõ ràng.
Name
auto_size
Type
boolean
mặc định false
Description
Khi được đặt thành true, dịch vụ sẽ sử dụng thị giác AI để tự động ước tính chiều cao thực tế của đối tượng và điều chỉnh 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.
Name
alpha_thumbnail
Type
boolean
mặc định false
Description
Khi được đặt thành true, tác vụ sẽ đồng thời render 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
multi_view_thumbnails
Type
boolean
mặc định false
Description
Khi được đặt thành true, tác vụ sẽ đồng thời render bốn ảnh thu nhỏ theo bốn hướng chính (trước, phải, sau, trái) và trả về chúng trong thumbnail_urls ở phản hồi GET. Trường thumbnail_url hiện có không thay đổi và vẫn trỏ đến góc nhìn phía trước, do đó các client hiện tại không bị ảnh hưởng.
Tăng thêm khoảng 3 giây vào độ trễ của tác vụ.

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 trong phản hồi chứa id của tác vụ Ảnh sang 3D vừa được tạo.

Các 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:
- Thiếu tham số: Phải cung cấp một trong hai tham số image_url hoặc input_task_id.
- Tác vụ đầu vào không hợp lệ: input_task_id phải tham chiếu đến một tác vụ Văn bản sang ảnh hoặc Ảnh sang ảnh có trạng thái SUCCEEDED và tạo ra chính xác một ảnh.
- Định dạng ảnh không hợp lệ: image_url được cung cấp không phải là định dạng được hỗ trợ (.jpg, .jpeg, .png).
- URL không thể truy cập: Không thể tải xuống image_url (lỗi 404 hoặc timeout).
- Data URI không hợp lệ: Chuỗi base64 không đúng định dạng.
- Kết hợp tham số không hợp lệ: enable_pbr chỉ được hỗ trợ khi should_texture là true.
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/v1/image-to-3d

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

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

Response

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

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

Truy xuất một Nhiệm vụ Ảnh sang 3D

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

Tham số

Name
id
Type
path
Description
Định danh duy nhất cho nhiệm vụ Ảnh sang 3D cần truy xuất.

Trả về

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

Yêu cầu

GET

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

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

Phản hồi

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

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

Xóa một tác vụ Ảnh sang 3D

Endpoint này xóa vĩnh viễn một tác vụ Ảnh 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 tác vụ Ảnh sang 3D cần xóa.

Trả về

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

Yêu cầu

DELETE

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

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

Phản hồi

// Returns 200 Ok on success.

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

Danh sách các tác vụ Ảnh sang 3D

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

Tham số

Thuộc tính tùy chọn

Name
page_num
Type
integer
Description
Số trang cho phân trang. Bắt đầu và mặc định là 1.
Name
page_size
Type
integer
Description
Giới hạn kích thước trang. Mặc định là 10 mục. 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 tác vụ Ảnh sang 3D.

Yêu cầu

GET

/openapi/v1/image-to-3d

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

Phản hồi

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

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

Truyền tải một tác vụ Ảnh sang 3D

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

Tham số

Name
id
Type
path
Description
Định danh duy nhất cho tác vụ Ảnh sang 3D cần truyền tải.

Trả về

Trả về một luồng của Các đối tượng tác vụ Ảnh sang 3D 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.

Yêu cầu

GET

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

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

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

Đối tượng Nhiệm vụ Ảnh sang 3D

Đối tượng Nhiệm vụ Ảnh 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 là ảnh. Đố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 theo 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ụ Ảnh sang 3D. Giá trị là image-to-3d.
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
  obj
  Type
  string
  Description
  URL có thể tải xuống cho tệp OBJ.
- Name
  usdz
  Type
  string
  Description
  URL có thể tải xuống cho tệp USDZ.
- Name
  mtl
  Type
  string
  Description
  URL có thể tải xuống cho tệp MTL, được trả về cùng với xuất OBJ khi có texture.
- 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
  pre_remeshed_glb
  Type
  string
  Description
  URL có thể tải xuống cho đầu ra GLB gốc trước khi remesh.
  Chỉ có khi nhiệm vụ được tạo với cả should_remesh: true và save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
URL có thể tải xuống cho ảnh thu nhỏ của tệp mô hình. Tương đương với thumbnail_urls.front khi có, giữ lại để tương thích ngược.
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 kết xuất thành công; nếu không, trường này sẽ bị bỏ qua.
Name
thumbnail_urls
Type
object
Description
URL có thể tải xuống cho bốn ảnh thu nhỏ từ các góc nhìn chính của mô hình 3D được tạo. Mỗi giá trị là một URL đã ký cho một PNG 512×512 được kết xuất với cùng vật liệu và ánh sáng như thumbnail_url. Hữu ích để xem trước mô hình từ nhiều góc độ trong các quy trình hàng loạt mà không cần tải xuống GLB.
Chỉ có khi nhiệm vụ được tạo với multi_view_thumbnails: true và đã đạt SUCCEEDED. Các nhiệm vụ cũ và nhiệm vụ được tạo mà không có lựa chọn này sẽ không bao gồm trường này.
- Name
  front
  Type
  string
  Description
  Góc nhìn phía trước, xoay 0° quanh trục dọc (khớp với thumbnail_url).
- Name
  right
  Type
  string
  Description
  Góc nhìn bên phải, xoay 90°.
- Name
  back
  Type
  string
  Description
  Góc nhìn phía sau, xoay 180°.
- Name
  left
  Type
  string
  Description
  Góc nhìn bên trái, xoay 270°.
Name
texture_prompt
Type
string
Description
Prompt văn bản được sử dụng để hướng dẫn quá trình texturing.
Name
texture_image_url
Type
string
Description
URL có thể tải xuống cho ảnh texture được sử dụng để hướng dẫn quá trình texturing.
Name
ultra_mode
Type
boolean
Description
Phản ánh giá trị ultra_mode mà nhiệm vụ được tạo với. Chỉ có cho các nhiệm vụ meshy-7 (hoặc latest) mà đặt rõ ultra_mode; nếu không sẽ bị bỏ qua.
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, giá trị này sẽ trở thành 100.
Name
started_at
Type
timestamp
Description
Dấu thời gian khi nhiệm vụ 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.
Một dấu thời gian đại diện cho số mili giây đã trôi qua kể từ ngày 1 tháng 1 năm 1970 UTC, theo tiêu chuẩn RFC 3339. Ví dụ, Thứ Sáu, ngày 1 tháng 9 năm 2023 12:00:00 PM GMT được biểu diễn là 1693569600000. Điều này áp dụng cho tất cả các dấu thời gian trong Meshy API.
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
expires_at
Type
timestamp
Description
Dấu thời gian khi kết quả nhiệm vụ hết hạn, tính bằng mili giây.
Name
finished_at
Type
timestamp
Description
Dấu thời gian khi nhiệm vụ 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 từ nhiệm vụ. Thông thường, 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 ảnh bản đồ màu cơ bản.
- Name
  metallic
  Type
  string
  Description
  URL có thể tải xuống cho ảnh bản đồ metallic.
  Nếu nhiệm vụ được tạo với enable_pbr: false, thuộc tính này sẽ bị bỏ qua.
- Name
  normal
  Type
  string
  Description
  URL có thể tải xuống cho ảnh bản đồ normal.
  Nếu nhiệm vụ được tạo với enable_pbr: false, thuộc tính này sẽ bị bỏ qua.
- Name
  roughness
  Type
  string
  Description
  URL có thể tải xuống cho ảnh bản đồ roughness.
  Nếu nhiệm vụ được tạo với enable_pbr: false, thuộc tính này sẽ bị bỏ qua.
- Name
  emission
  Type
  string
  Description
  URL có thể tải xuống cho ảnh bản đồ emission.
  Nếu nhiệm vụ được tạo với enable_pbr: false, hoặc ai_model là meshy-5, meshy-7, hoặc latest, thuộc tính này sẽ bị bỏ qua.
Name
preceding_tasks
Type
integer
Description
Số lượng nhiệm vụ trước đó.
Giá trị của trường này chỉ có ý nghĩa nếu trạng thái nhiệm vụ là PENDING.
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ó 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ụ Đối tượng Nhiệm vụ Ảnh sang 3D

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