Biến một bức ảnh nguồn thành một tượng nhỏ 3D phong cách gạch sưu tập qua hai giai đoạn:
nguyên mẫu tạo ra một hình ảnh khái niệm có phong cách từ bức ảnh đầu vào của bạn, sau đó
xây dựng biến hình ảnh khái niệm đó thành một mô hình 3D có texture. Hai giai đoạn này
được liên kết qua input_task_id.
POST /openapi/creative-lab/brick-figure/v1/prototype
Tạo một hình ảnh khái niệm kiểu gạch từ ảnh nguồn. ID nhiệm vụ trả về là những gì bạn truyền dưới dạng input_task_id đến endpoint xây dựng. Tham khảo Đối Tượng Nhiệm Vụ Nguyên Mẫu Tượng Gạch để biết cấu trúc phản hồi.
Tham Số
Name
image_url
Type
string
Bắt buộc
Description
Ảnh nguồn để Meshy tạo kiểu thành tượng gạch. Hiện tại chúng tôi hỗ trợ các định dạng .jpg, .jpeg, .png, và .webp.
Có hai cách để cung cấp hình ảnh:
URL công khai: 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 hình ảnh. Ví dụ về một Data URI: data:image/jpeg;base64,<dữ liệu hình ảnh mã hóa base64 của bạn>.
Name
name
Type
string
Description
Tên nhiệm vụ tùy chọn cho mục đích hiển thị. Tối đa 100 ký tự.
Name
remove_background
Type
boolean
mặc định false
Description
Khi được đặt thành true, hình ảnh nguyên mẫu được trả về dưới dạng PNG RGBA trong suốt với nền đã bị loại bỏ, vì vậy bạn có thể ghép đối tượng lên bất kỳ nền nào.
Trả Về
Thuộc tính result của phản hồi chứa ID nhiệm vụ của nhiệm vụ nguyên mẫu tượng gạch mới được tạo. Kiểm tra endpoint Lấy Nhiệm Vụ hoặc đăng ký luồng cho đến khi nhiệm vụ đạt trạng thái SUCCEEDED, sau đó truyền ID đó đến endpoint xây dựng dưới dạng input_task_id.
Các Chế Độ Thất Bại
Name
400 - Bad Request
Description
Yêu cầu không chấp nhận được. Các nguyên nhân phổ biến:
Thiếu tham số: image_url là bắt buộc.
Định dạng hình ả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, .webp).
Kích thước hình ảnh ngoài phạm vi: Hình ảnh quá nhỏ, vượt quá kích thước tệp tối đa, hoặc vượt quá số lượng pixel tối đa.
URL không thể truy cập: image_url không thể tải xuống (404 hoặc timeout).
Data URI không hợp lệ: Chuỗi base64 bị lỗi.
Nội dung bị gắn cờ: Hình ảnh đầu vào bị gắn cờ bởi moderation NSFW.
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
403 - Forbidden
Description
Hình ảnh đầu vào bị gắn cờ vì vi phạm sở hữu trí tuệ.
Name
429 - Too Many Requests
Description
Bạn đã vượt quá giới hạn tốc độ của mình.
Yêu Cầu
POST
/openapi/creative-lab/brick-figure/v1/prototype
# Stage 1: generate a brick-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_url": "<your publicly accessible image url or base64-encoded data URI>" }'
Tạo tượng gạch 3D cuối cùng có dán texture từ một nhiệm vụ nguyên mẫu đã thành công. Quá trình xây dựng chạy cùng một quy trình ảnh-sang-3D như Ảnh sang 3D, vì vậy định dạng đối tượng phản hồi và danh sách các URL đầu ra hoàn toàn khớp nhau. Tham khảo Đối Tượng Nhiệm Vụ Xây Dựng Tượng Gạch để biết hình dạng phản hồi.
Tham Số
Name
input_task_id
Type
string
Bắt buộc
Description
ID nhiệm vụ của một nhiệm vụ nguyên mẫu được tạo thông qua endpoint OpenAPI này. Nguyên mẫu phải được tạo với cùng khóa API, phải đạt SUCCEEDED, và phải tạo ra chính xác một hình ảnh ứng viên.
Các nhiệm vụ nguyên mẫu được tạo thông qua ứng dụng web không được chấp nhận — endpoint xây dựng chỉ chấp nhận các nhiệm vụ nguyên mẫu được tạo bởi POST /openapi/creative-lab/brick-figure/v1/prototype và từ chối bất kỳ nguồn nào khác với 404.
Name
name
Type
string
Description
Tên nhiệm vụ tùy chọn để hiển thị. Tối đa 100 ký tự.
Trả Về
Thuộc tính result của phản hồi chứa id nhiệm vụ của nhiệm vụ xây dựng tượng gạch mới được tạo. Kiểm tra endpoint Lấy Nhiệm Vụ hoặc đăng ký luồng cho đến khi nhiệm vụ đạt SUCCEEDED, sau đó tải xuống GLB có dán texture từ model_urls.glb (hoặc cặp OBJ + MTL từ model_urls.obj và model_urls.mtl nếu quy trình hạ nguồn của bạn ưu tiên OBJ).
Các Chế Độ Thất Bại
Name
400 - Bad Request
Description
Yêu cầu không chấp nhận được. Các nguyên nhân phổ biến:
Thiếu tham số: input_task_id là bắt buộc.
UUID không hợp lệ: input_task_id không phải là UUID hợp lệ.
Cha không thành công: Nhiệm vụ nguyên mẫu tham chiếu chưa đạt SUCCEEDED.
Không có ứng viên: Nhiệm vụ nguyên mẫu đã thành công nhưng không tạo ra hình ảnh ứng viên nào.
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
404 - Not Found
Description
Nhiệm vụ nguyên mẫu tham chiếu không tồn tại, thuộc về người dùng khác, hoặc được tạo thông qua ứng dụng web (chỉ các nhiệm vụ nguyên mẫu ở chế độ API mới được nối vào xây dựng).
Name
429 - Too Many Requests
Description
Bạn đã vượt quá giới hạn tốc độ của mình.
Request
POST
/openapi/creative-lab/brick-figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578" }'
Truy xuất một nhiệm vụ nguyên mẫu hoặc xây dựng với một id nhiệm vụ hợp lệ. Đường dẫn URL
phải khớp với giai đoạn của nhiệm vụ — một nhiệm vụ xây dựng được truy xuất qua
/prototype/:id sẽ trả về 404, và ngược lại.
Hủy một nhiệm vụ tượng gạch. Nếu nhiệm vụ vẫn đang PENDING, các tín dụng tiêu thụ khi tạo sẽ được hoàn lại. Các nhiệm vụ đã IN_PROGRESS sẽ bị hủy mà không hoàn lại (người thực hiện có thể đã đang tiêu tốn tài nguyên). Các nhiệm vụ đã đạt trạng thái cuối (SUCCEEDED, FAILED, CANCELED) không thể bị hủy.
Đường dẫn URL phải khớp với giai đoạn của nhiệm vụ — DELETE trên
/prototype/:buildId trả về 404.
Tham số Đường dẫn
Name
id
Type
path
Description
Định danh duy nhất cho nhiệm vụ tượng gạch cần hủy.
Trả về
Trả về 204 No Content khi thành công với nội dung trống.
Chế độ Lỗi
Name
400 - Bad Request
Description
Nhiệm vụ đã ở trạng thái cuối và không thể bị hủy.
Name
404 - Not Found
Description
Nhiệm vụ không tồn tại, thuộc về người dùng khác, hoặc giai đoạn của nó không khớp với đường dẫn URL.
Truyền tải cập nhật thời gian thực cho một nhiệm vụ tượng gạch qua Server-Sent Events (SSE).
Đường dẫn URL phải khớp với giai đoạn của nhiệm vụ — mở một luồng tại
/prototype/:buildId/stream sẽ phát ra một event: error payload duy nhất với
status_code: 404 và đóng luồng.
Tham số
Name
id
Type
path
Description
Định danh duy nhất cho nhiệm vụ tượng gạch để truyền tải.
Trả về
Trả về một luồng các đối tượng nhiệm vụ Prototype Tượng Gạch
hoặc Xây dựng Tượng Gạch 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 cần thiết progress và status.
Lấy danh sách phân trang các nhiệm vụ tượng gạch của bạn cho một giai đoạn duy nhất. Đường dẫn URL
chọn giai đoạn — /prototype trả về các nhiệm vụ nguyên mẫu; /build
trả về các nhiệm vụ xây dựng. Nhiệm vụ từ giai đoạn khác không được bao gồm trong cả hai
phản hồi.
Tham số Đường dẫn
Name
stage
Type
path
Bắt buộc
Description
Hoặc là prototype hoặc build. Bộ sưu tập chỉ trả về các nhiệm vụ
có giai đoạn khớp với URL — lấy /prototype không bao giờ trả về
nhiệm vụ xây dựng và ngược lại.
Tham số Truy vấn
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à 100 mục.
Name
sort_by
Type
string
mặc định -created_at
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.
Đối tượng Nhiệm vụ Nguyên mẫu Tượng Gạch là một đơn vị công việc mà Meshy theo dõi để tạo ra một hình ảnh khái niệm kiểu gạch từ một bức ảnh nguồn. Kết quả đầu ra của giai đoạn này được liên kết vào giai đoạn xây dựng thông qua input_task_id.
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 của nhiệm vụ. Giá trị là creative-lab-brick-figure-prototype.
Name
name
Type
string
Description
Tên nhiệm vụ được cung cấp khi nhiệm vụ được tạo. Chuỗi rỗng nếu không có tên nào được cung cấp.
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
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
created_at
Type
timestamp
Description
Dấu thời gian khi nhiệm vụ được tạo, tính bằng mili giây.
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
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à null.
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à null.
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
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ó 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).
Name
image_urls
Type
array of strings
Description
Các URL có thể tải xuống cho các ứng viên hình ảnh khái niệm được tạo ra bởi nhiệm vụ nguyên mẫu này. Hiện tại API luôn trả về chính xác một ứng viên; trường này là một mảng để các phiên bản tương lai có thể hiển thị nhiều ứng viên mà không gây ra thay đổi phá vỡ.
Đối tượng Nhiệm vụ Xây dựng Tượng Gạch là một đơn vị công việc mà Meshy theo dõi để tạo ra một tượng gạch 3D có texture từ một nhiệm vụ nguyên mẫu đã thành công. Nó chạy cùng một quy trình ảnh-sang-3D được sử dụng bởi Ảnh sang 3D, vì vậy các trường đầu ra phản ánh đối tượng nhiệm vụ của endpoint đó đối tượng nhiệm vụ.
Thuộc tính
Name
id
Type
string
Description
Định danh duy nhất cho nhiệm vụ.
Name
type
Type
string
Description
Loại của nhiệm vụ. Giá trị là creative-lab-brick-figure-build.
Name
name
Type
string
Description
Tên nhiệm vụ được cung cấp khi nhiệm vụ được tạo. Chuỗi rỗng nếu không có tên nào được cung cấp.
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
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, nó sẽ trở thành 100.
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
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.
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.
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
preceding_tasks
Type
integer
Description
Số lượng nhiệm vụ trước đó. Chỉ có ý nghĩa khi trạng thái 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. Trả về 0 cho các nhiệm vụ FAILED (tín dụng được hoàn lại khi thất bại).
Name
prompt
Type
string
Description
Luôn rỗng cho xây dựng tượng gạch. Có mặt để tương thích giữa các endpoint với hình dạng V2ImageTo3DTaskResponse được chia sẻ sử dụng bởi Ảnh sang 3D.
Name
negative_prompt
Type
string
Description
Luôn rỗng cho xây dựng tượng gạch. Có mặt để tương thích giữa các endpoint.
Name
texture_prompt
Type
string
Description
Luôn rỗng cho xây dựng tượng gạch. Có mặt để tương thích giữa các endpoint.
Name
texture_image_url
Type
string
Description
Luôn rỗng cho xây dựng tượng gạch. Có mặt để tương thích giữa các endpoint.
Name
model_urls
Type
object
Description
URL có thể tải xuống cho mô hình 3D được tạo ra. Xây dựng tượng gạch phát ra một GLB có texture cộng với cặp OBJ + MTL cho các quy trình thích Wavefront OBJ. Hình dạng trường khớp với đối tượng model_urls Ảnh sang 3D để các bổ sung định dạng trong tương lai không gây ra thay đổi phá vỡ.
Name
glb
Type
string
Description
URL có thể tải xuống cho tệp GLB có texture.
Name
obj
Type
string
Description
URL có thể tải xuống cho tệp Wavefront OBJ (hình học + UV).
Name
mtl
Type
string
Description
URL có thể tải xuống cho tệp vật liệu MTL đi kèm OBJ. Ghép với obj và mục từ texture_urls[0].base_color.
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
texture_urls
Type
array
Description
Một mảng các đối tượng URL texture được tạo ra bởi nhiệm vụ này. Hiện tại chứa một đối tượng duy nhất với bản đồ màu cơ bản.
Name
base_color
Type
string
Description
URL có thể tải xuống cho hình ảnh bản đồ màu cơ bản.