Nhiều ảnh sang 3D API là một tính năng cho phép bạn tích hợp khả năng chuyển đổi Nhiều ảnh sang 3D của Meshy vào ứng dụng riêng của bạn. Trong phần này, bạn sẽ tìm thấy tất cả thông tin bạn cần để bắt đầu với API này.
Endpoint này cho phép bạn tạo một nhiệm vụ Nhiều ảnh sang 3D mới. Tham khảo
Đối tượng Nhiệm vụ Nhiều ảnh sang 3D để thấy các
thuộc tính được bao gồm với đối tượng nhiệm vụ Nhiều ảnh sang 3D.
Tham số
Chỉ một trong hai input_task_id hoặc image_urls là bắt buộc. Nếu cả hai đượ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 nhiệm vụ tạo ảnh đã hoàn tất có đầu ra (1-4 ảnh) được sử dụng làm đầu vào. Nhiệm vụ này phải là một trong các nhiệm vụ sau: Văn bản sang ảnh, Ảnh sang ảnh, Văn bản sang ảnh Đa góc nhìn, hoặc Ảnh sang ảnh Đa góc nhìn. Ngoài ra, nó phải được thực thi thông qua API và có trạng thái là SUCCEEDED.
Name
image_urls
Type
array
Bắt buộc
Description
Cung cấp từ 1 đến 4 ả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. Tất cả các ảnh nên miêu tả cùng một đối tượng từ các góc độ khác nhau để đạt kết quả tốt nhất.
Có hai cách để cung cấp mỗi ảnh:
URL công khai có thể truy cập: Một URL có thể truy cập từ Internet công cộng.
Data URI: Một 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>.
Với meshy-7 (hoặc latest), ảnh đầu tiên được sử dụng làm góc nhìn chính (trước). Thứ tự của các ảnh còn lại không quan trọng.
Name
ai_model
Type
string
mặc định latest
Description
ID của mô hình được sử dụng. Giá trị khả dụng: meshy-5, meshy-6, meshy-7, latest (Meshy 7).
Name
should_texture
Type
boolean
mặc định true
Description
Xác định liệu textures có được tạo ra hay không. Đặt nó thành false sẽ bỏ qua giai đoạn tạo textures, cung cấp một lưới mà không có textures.
Chỉ áp dụng khi should_texture = true
Name
enable_pbr
Type
boolean
mặc định false
Description
Tạo Bản đồ PBR (kim loại, độ nhám, bản đồ normal) ngoài màu nền. Một bản đồ phát sáng 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 ra bản đồ phát sáng.
Name
texture_resolution
Type
string
mặc định 2k
Description
Độ phân giải màu nền texture. 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 thu thập nhiều chi tiết bề mặt hơn.
Các định dạng 4k và 8k yêu cầu ai_model là meshy-6, meshy-7 hoặc latest. Ở 8k, không có bản đồ phát sáng đượ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 đượ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 để hướng dẫn quá trình tạo texture. Tối đa 600 ký tự.
Name
texture_image_url
Type
string
Description
Cung cấp một ảnh 2D để hướng dẫn 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 có thể truy cập: Một URL có thể truy cập từ Internet công cộng
Data URI: Một 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>
Texture ảnh có thể không hoạt động tối ưu nếu có sự khác biệt hình học đáng kể giữa tài sản gốc và ảnh được tải lên. Chỉ một trong hai texture_image_url hoặc texture_prompt có thể được sử dụng để hướng dẫn quá trình tạo texture. Nếu cả hai tham số được cung cấp, thì texture_prompt sẽ được sử dụng để tạo texture cho mô hình mặc định.
Name
should_remesh
Type
boolean
mặc định false (meshy-6), true (others)
Description
Kiểm soát việc kích hoạt giai đoạn remesh. Để có mô hình chất lượng cao nhất, chúng tôi khuyên nên thiết lập 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 tạo ra.
Giá trị khả dụng:
quad: Tạo lưới chủ yếu là quad.
triangle: Tạo một lưới tam giác giảm bớt.
Name
target_polycount
Type
integer
mặc định 30,000
Description
Chỉ định số lượng đa giác mục tiêu trong mô hình tạo ra. Số lượng thực tế có thể chệch khỏi mục tiêu tùy thuộc vào độ phức tạp của hình học.
Phạm vi giá trị hợp lệ thay đổi tùy theo cấp người dùng:
100 đến 300,000 (bao gồm)
Name
decimation_mode
Type
integer
Description
Kích hoạt giảm thiểu thích ứng bằng cách thiết lập mức số đa giác. Khi đã thiết lập, target_polycount sẽ bị bỏ qua.
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
save_pre_remeshed_model
Type
boolean
mặc định false
Description
Khi được thiết lập thành true, Meshy cũng lưu trữ một tệp GLB bổ sung trước khi giai đoạn remesh hoàn tất.
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 nữa.
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: Vô hiệu hóa đố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: Bắt buộc đối xứng trong quá trình tạo.
Name
pose_mode
Type
string
mặc định ""
Description
Chỉ định chế độ tạo dáng cho mô hình tạo ra.
Giá trị khả dụng:
a-pose: Tạo mô hình trong tư thế A.
t-pose: Tạo mô hình trong tư thế T.
"" (chuỗi trống): Không áp dụng tư thế cụ thể.
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ế. Liệu cần tạo mô hình trong tư thế A/T.
Name
image_enhancement
Type
boolean
mặc định true
Description
Tối ưu hóa các ảnh đầu vào để có kết quả tốt hơn. Đặt thành false để giữ nguyên diện mạo chính xác của các ảnh đầu vào mà không có bất kỳ quá trình xử lý kiểu dáng 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 đánh dấu sáng và bóng từ màu nền texture, tạo ra kết quả sạch hơn để hoạt động tốt hơn dưới các cài đặt ánh sáng tùy chỉnh.
Chỉ được hỗ trợ khi ai_model là meshy-6, meshy-7 hoặc latest.
Name
moderation
Type
boolean
mặc định false
Description
Khi được thiết lập thành true, nội dung đầu vào sẽ tự động được kiểm tra nội dung có thể gây hại. Nếu phát hiện thấy nội dung có hại, nhiệm vụ sẽ không tiến hành tạo ra.
Mỗi hình ảnh từ image_urls và văn bản từ texture_prompt sẽ được kiểm tra.
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 ra và trả về, điều này có thể giảm thời gian hoàn thành nhiệm vụ.
Giá trị khả dụng: glb, obj, fbx, stl, usdz, 3mf
Khi bị bỏ qua, tất 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 thiết lập thành true, dịch vụ sử dụng tầm nhìn AI để 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 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 thiết lập thành true, nhiệm vụ bổ sung thêm một phiên bản nền trong suốt (RGBA) của bản xem trước và trả về nó 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 thiết lập thành true, nhiệm vụ bổ sung thêm bốn ảnh thu nhỏ từ các góc nhìn chính (trước, phải, sau, trái) và trả về chúng dưới dạng thumbnail_urls trong phản hồi GET. Trường thumbnail_url hiện có không thay đổi và tiếp tục chỉ vào góc nhìn phía trước, vì vậy các khách hàng hiện có không bị ảnh hưởng.
Tăng khoảng 3 giây độ trễ nhiệm 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.
Trả về
Thuộc tính result của phản hồi chứa id của nhiệm vụ đã được tạo mới Nhiều ảnh sang 3D.
Chế độ Thất bạ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ố: Phải cung cấp một trong hai image_urls hoặc input_task_id.
Nhiệm vụ đầu vào không hợp lệ: input_task_id phải tham chiếu đến một nhiệm vụ Văn bản sang Ảnh, Ảnh sang Ảnh đã đến SUCCEEDED.
Số lượng ảnh không hợp lệ: image_urls phải chứa từ 1 đến 4 ảnh.
Định dạng ảnh không hợp lệ: Một hoặc nhiều ảnh trong image_urls không phải là định dạng được hỗ trợ.
URL không thể truy cập: Một hoặc nhiều image_urls không thể tải xuống.
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/v1/multi-image-to-3d
# Yêu cầu đơn giảncurlhttps://api.meshy.ai/openapi/v1/multi-image-to-3d \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_urls": [ "<url ảnh công khai hoặc dữ liệu URI mã hóa base64 của bạn>", "<url ảnh công khai thứ hai hoặc dữ liệu URI mã hóa base64 của bạn>" ] }'# Với texture PBR và định dạng GLBcurlhttps://api.meshy.ai/openapi/v1/multi-image-to-3d \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_urls": [ "<url ảnh công khai hoặc dữ liệu URI mã hóa base64 của bạn>", "<url ảnh công khai thứ hai hoặc dữ liệu URI mã hóa base64 của bạn>" ], "should_texture": true, "enable_pbr": true, "target_formats": ["glb"] }'
Endpoint này cho phép bạn nhận một Nhiệm vụ Nhiều ảnh sang 3D với một id nhiệm vụ hợp lệ.
Tham khảo Đối tượng Nhiệm vụ Nhiều ảnh sang 3D để thấy các
thuộc tính được bao gồm với đối tượng nhiệm vụ Nhiều ảnh sang 3D.
Tham số
Name
id
Type
path
Description
Định danh duy nhất cho nhiệm vụ Nhiều ảnh sang 3D để nhận.
Đối tượng Nhiệm vụ Nhiều ả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ừ nhiều ảnh (từ 1 đến 4 bao gồm cả). Các ảnh nên là của cùng một đối tượng, lý tưởng nhất là từ các góc nhìn hoặc góc độ khác nhau. Đố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 để làm 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ụ Nhiều ảnh sang 3D. Giá trị là multi-image-to-3d.
Name
model_urls
Type
object
Description
URL có thể tải về cho tệp mô hình 3D có texture được tạo ra bởi Meshy. Thuộc tính cho một định dạng sẽ bị loại bỏ nếu định dạng không được tạo ra thay vì trả về một chuỗi trống.
Name
glb
Type
string
Description
URL có thể tải về cho tệp GLB.
Name
fbx
Type
string
Description
URL có thể tải về cho tệp FBX.
Name
obj
Type
string
Description
URL có thể tải về cho tệp OBJ.
Name
usdz
Type
string
Description
URL có thể tải về cho tệp USDZ.
Name
mtl
Type
string
Description
URL có thể tải về cho tệp MTL, được trả về cùng với các xuất OBJ khi có texture.
Name
stl
Type
string
Description
URL có thể tải về cho tệp STL.
Name
3mf
Type
string
Description
URL có thể tải về cho tệp 3MF. Chỉ hiện diện khi 3mf được yêu cầu thông qua target_formats.
Name
pre_remeshed_glb
Type
string
Description
URL có thể tải về cho đầu ra GLB gốc trước khi remeshing.
Chỉ có sẵn 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 về cho ảnh thu nhỏ của tệp mô hình. Tương đương với thumbnail_urls.front khi có mặt, được giữ để tương thích ngược.
Name
alpha_thumbnail_url
Type
string
Description
URL có thể tải về cho phiên bản nền trong suốt (RGBA) của thumbnail_url. Chỉ hiện diện 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 thì trường này bị loại bỏ.
Name
thumbnail_urls
Type
object
Description
Các URL có thể tải về cho bốn ảnh thu nhỏ từ góc nhìn chính của mô hình 3D tạo ra. Mỗi giá trị là một URL đã ký đến tệp PNG 512x512 đượ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 nhìn trong lưu trình hàng loạt mà không cần tải về GLB.
Chỉ hiện diện khi nhiệm vụ được tạo với multi_view_thumbnails: true và đã đạt SUCCEEDED. Các nhiệm vụ cũ và các nhiệm vụ được tạo mà không đăng ký 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° xung 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
Văn bản prompt được sử dụng để hướng dẫn quá trình tạo texture.
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ụ đã hoàn tất, điều này sẽ trở thành 100.
Name
started_at
Type
timestamp
Description
Dấu thời gian của khi nhiệm vụ bắt đầu được tính bằng milliseconds. 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ố milliseconds đã trôi qua 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ả dấu thời gian trong Meshy API.
Name
created_at
Type
timestamp
Description
Dấu thời gian của khi nhiệm vụ được tạo ra, tính bằng milliseconds.
Name
expires_at
Type
timestamp
Description
Dấu thời gian của khi kết quả nhiệm vụ hết hạn, tính bằng milliseconds.
Name
finished_at
Type
timestamp
Description
Dấu thời gian của khi nhiệm vụ hoàn tất, tính bằng milliseconds. Nếu nhiệm vụ chưa hoàn tất, 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, nó 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 về cho hình ảnh bản đồ màu nền.
Name
metallic
Type
string
Description
URL có thể tải về cho hình ảnh bản đồ kim loại.
Nếu nhiệm vụ được tạo với enable_pbr: false, thuộc tính này sẽ bị loại bỏ.
Name
normal
Type
string
Description
URL có thể tải về cho hình ả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ị loại bỏ.
Name
roughness
Type
string
Description
URL có thể tải về cho hình ảnh bản đồ độ nhám.
Nếu nhiệm vụ được tạo với enable_pbr: false, thuộc tính này sẽ bị loại bỏ.
Name
emission
Type
string
Description
URL có thể tải về cho hình ảnh bản đồ phát sáng.
Nếu nhiệm vụ được tạo với enable_pbr: false, hoặc ai_model là meshy-5, thuộc tính này sẽ bị loại bỏ.
Name
preceding_tasks
Type
integer
Description
Số lượng các nhiệm vụ trước đây.
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 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. Hiện diện 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 trả khi thất bại).