Biến một ảnh nguồn thành tượng 3D sưu tầm phong cách chibi qua hai giai đoạn:
prototype tạo ra một ảnh ý tưởng đã được tạo phong cách từ ảnh đầu vào của bạn, sau đó
build biến ảnh ý tưởng đó thành một mô hình 3D có bản đồ vật liệu. Hai giai đoạn
được liên kết thông qua input_task_id.
Tạo một ảnh concept duy nhất theo phong cách chibi từ ảnh nguồn. ID tác vụ
được trả về là giá trị bạn truyền dưới dạng input_task_id cho endpoint
build. Tham khảo
Đối tượng tác vụ nguyên mẫu tượng
để 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 phong cách thành tượng chibi. Hiện chúng tôi hỗ trợ các định dạng .jpg, .jpeg, .png và .webp.
Có hai cách để cung cấp ảnh:
URL có thể truy cập công khai: URL có thể truy cập từ internet công cộng.
Data URI: Data URI của ảnh được mã hóa base64. Ví dụ về Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
Tên tác vụ tùy chọn để phục vụ mục đích hiển thị. Tối đa 100 ký tự.
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ụ nguyên mẫu tượng vừa được tạo. Poll endpoint Get a Task hoặc đăng ký stream cho đến khi tác vụ đạt SUCCEEDED, sau đó truyền ID đó đến endpoint build dưới dạng input_task_id.
Các trường hợp lỗi
Name
400 - Bad Request
Description
Yêu cầu không được chấp nhận. Nguyên nhân phổ biến:
Thiếu tham số: image_url là bắt buộc.
Đị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, .webp).
Kích thước ảnh ngoài phạm vi: Ả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: Không thể tải xuống image_url (404 hoặc timeout).
Data URI không hợp lệ: Chuỗi base64 bị sai định dạng.
Nội dung bị gắn cờ: Ảnh đầu vào bị gắn cờ bởi moderation NSFW hoặc sở hữu trí tuệ.
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 độ của mình.
Request
POST
/openapi/creative-lab/figure/v1/prototype
# Stage 1: generate a chibi-style concept imagecurl https://api.meshy.ai/openapi/creative-lab/figure/v1/prototype \ -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>" }'
Response
{"result":"018a210d-8ba4-705c-b111-1f1776f7f578"}
Ví dụ nguyên mẫu
Bắt đầu với một ảnh chân dung nguồn, sau đó tạo ảnh nguyên mẫu được dùng bởi giai đoạn build.
Tạo tượng 3D cuối cùng đã áp texture từ một tác vụ nguyên mẫu đã thành công.
Quá trình dựng chạy cùng pipeline ảnh-sang-3D như
Ảnh sang 3D, vì vậy định dạng đối tượng phản hồi và
danh sách URL đầu ra khớp hoàn toàn. Tham khảo
Đối tượng tác vụ dựng tượng để biết
cấu trúc phản hồi.
Tham số
Name
input_task_id
Type
string
Bắt buộc
Description
ID tác vụ của một tác vụ nguyên mẫu được tạo qua cùng endpoint OpenAPI này. Nguyên mẫu phải được tạo bằng cùng khóa API, phải đã đạt SUCCEEDED, và phải tạo ra đúng một ảnh ứng viên.
Các tác vụ nguyên mẫu được tạo thông qua webapp không được chấp nhận — endpoint dựng chỉ chấp nhận các tác vụ nguyên mẫu được tạo bởi POST /openapi/creative-lab/figure/v1/prototype và từ chối mọi nguồn khác với 404.
Name
name
Type
string
Description
Tên tác 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 tác vụ của tác vụ dựng tượng mới được tạo. Poll endpoint Lấy một tác vụ hoặc đăng ký stream cho đến khi tác vụ đạt SUCCEEDED, sau đó tải xuống GLB đã áp texture từ model_urls.glb (hoặc cặp OBJ + MTL từ model_urls.obj và model_urls.mtl nếu pipeline phía sau của bạn ưu tiên OBJ).
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 thường gặp:
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ệ.
Tác vụ cha chưa thành công: Tác vụ nguyên mẫu được tham chiếu chưa đạt SUCCEEDED.
Không có ứng viên: Tác vụ nguyên mẫu đã thành công nhưng không tạo ra ả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 tác vụ này.
Name
404 - Not Found
Description
Tác vụ nguyên mẫu được 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 webapp (chỉ các tác vụ nguyên mẫu ở mode API mới có thể nối chuỗi sang 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/figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurl https://api.meshy.ai/openapi/creative-lab/figure/v1/build \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578" }'
Response
{"result":"019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"}
Build example
The build task turns the selected prototype image into a downloadable textured 3D model.
Truy xuất một tác vụ prototype hoặc build bằng id tác vụ hợp lệ. Đường dẫn URL
phải khớp với giai đoạn của tác vụ — một tác vụ build được lấy thông qua
/prototype/:id sẽ trả về 404, và ngược lại.
Hủy một tác vụ tượng. Nếu tác vụ vẫn đang PENDING, tín dụng
đã tiêu thụ tại thời điểm tạo sẽ được hoàn lại. Các tác vụ đã
IN_PROGRESS sẽ bị hủy mà không được hoàn tín dụng (worker có thể đã
đang tiêu tốn tài nguyên). Các tác vụ đã đạt đến 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 tác vụ — DELETE trên
/prototype/:buildId trả về 404.
Tham số đường dẫn
Name
id
Type
path
Description
Định danh duy nhất của tác vụ tượng cần hủy.
Trả về
Trả về 204 No Content khi thành công với phần thân trống.
Chế độ lỗi
Name
400 - Bad Request
Description
Tác vụ đã ở trạng thái cuối và không thể bị hủy.
Name
404 - Not Found
Description
Tác vụ không tồn tại, thuộc về người dùng khác, hoặc giai đoạn của tác vụ không khớp với đường dẫn URL.
Phát trực tuyến các cập nhật theo thời gian thực cho một tác vụ tượng thông qua Server-Sent Events (SSE).
Đường dẫn URL phải khớp với giai đoạn của tác vụ — mở một luồng tại
/prototype/:buildId/stream sẽ phát ra một payload event: error duy nhất với
status_code: 404 và đóng luồng.
Tham số
Name
id
Type
path
Description
Mã định danh duy nhất của tác vụ tượng cần phát trực tuyến.
Trả về
Trả về một luồng các đối tượng tác vụ Nguyên mẫu tượng
hoặc Bản dựng tượng 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.
Truy xuất danh sách được phân trang các tác vụ tượng của bạn cho một giai đoạn. Đường dẫn
URL chọn giai đoạn — /prototype trả về các tác vụ prototype; /build
trả về các tác vụ build. Các tác vụ từ giai đoạn khác không được bao gồm trong
phản hồi nào.
Tham số đường dẫn
Name
stage
Type
path
Bắt buộc
Description
Hoặc prototype hoặc build. Bộ sưu tập chỉ trả về các tác vụ
có giai đoạn khớp với URL — việc lấy /prototype không bao giờ trả về
tác vụ build 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 được phép là 50 mục.
Name
sort_by
Type
string
mặc định -created_at
Description
Trường để sắp xếp theo. 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 Tác vụ Nguyên mẫu tượng là một đơn vị công việc mà Meshy theo dõi để
tạo một hình ảnh concept phong cách chibi từ ảnh nguồn. Đầu ra của
giai đoạn này được nối tiếp vào giai đoạn dựng
thông qua input_task_id.
Thuộc tính
Name
id
Type
string
Description
Mã định danh duy nhất cho tác vụ. Mặc dù chúng tôi sử dụng UUID có thể sắp xếp theo k cho id tác 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 tác vụ. Giá trị là creative-lab-figure-prototype.
Name
name
Type
string
Description
Tên tác vụ được cung cấp khi tác 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 tác vụ. Các giá trị có thể là một trong PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
progress của tác vụ. Nếu tác vụ chưa được bắt đầu, thuộc tính này sẽ là 0. Khi tác vụ đã thành công, giá trị này sẽ trở thành 100.
Name
created_at
Type
timestamp
Description
Dấu thời gian khi tác vụ được tạo, tính bằng mili giây.
Một dấu thời gian biểu thị số mili giây đã trôi qua kể từ ngày 1 tháng 1 năm 1970 UTC, tuân 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
started_at
Type
timestamp
Description
Dấu thời gian khi tác vụ được bắt đầu, tính bằng mili giây. Nếu tác vụ chưa được bắt đầu, thuộc tính này sẽ là 0.
Name
finished_at
Type
timestamp
Description
Dấu thời gian khi tác vụ được hoàn tất, tính bằng mili giây. Nếu tác vụ chưa được hoàn tất, thuộc tính này sẽ là 0.
Name
expires_at
Type
timestamp
Description
Dấu thời gian khi kết quả tác vụ hết hạn, tính bằng mili giây.
Name
preceding_tasks
Type
integer
Description
Số lượng tác vụ đứng trước.
Giá trị của trường này chỉ có ý nghĩa nếu trạng thái tác vụ là PENDING.
Name
task_error
Type
object
Description
Chi tiết lỗi cho các tác vụ thất bại. Xem Lỗi để biết tham chiếu đầy đủ về đối tượng task_error.
Name
consumed_credits
Type
integer
Description
Số tín dụng được tiêu thụ bởi tác vụ này. Có mặt khi trạng thái tác vụ là PENDING, IN_PROGRESS, hoặc SUCCEEDED. Trả về 0 cho các tác 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 những ứng viên hình ảnh ý tưởng được tạo bởi tác vụ nguyên mẫu này. Hiện tại API luôn trả về đúng một ứng viên; trường này là một mảng để các bản sửa đổi trong tương lai có thể hiển thị nhiều ứng viên mà không gây thay đổi phá vỡ tương thích.
Đối tượng Tác vụ Xây dựng tượng là một đơn vị công việc mà Meshy theo dõi để
tạo một tượng 3D có texture từ một tác vụ nguyên mẫu đã thành công. Nó
chạy cùng 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 tác vụ của endpoint đó.
Thuộc tính
Name
id
Type
string
Description
Mã định danh duy nhất cho tác vụ.
Name
type
Type
string
Description
Loại tác vụ. Giá trị là creative-lab-figure-build.
Name
name
Type
string
Description
Tên tác vụ được cung cấp khi tác 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 tác vụ. Các giá trị có thể là một trong PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
progress của tác vụ. Nếu tác vụ chưa được bắt đầu, thuộc tính này sẽ là 0. Khi tác vụ đã thành công, giá trị này sẽ trở thành 100.
Name
created_at
Type
timestamp
Description
Dấu thời gian khi tác vụ được tạo, tính bằng mili giây.
Name
started_at
Type
timestamp
Description
Dấu thời gian khi tác vụ được bắt đầu, tính bằng mili giây.
Name
finished_at
Type
timestamp
Description
Dấu thời gian khi tác vụ hoàn tất, tính bằng mili giây.
Name
expires_at
Type
timestamp
Description
Dấu thời gian khi kết quả tác vụ hết hạn, tính bằng mili giây.
Name
preceding_tasks
Type
integer
Description
Số lượng tác vụ đứng 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 tác vụ thất bại. Xem Lỗi để biết tham chiếu đầy đủ về đối tượng task_error.
Name
consumed_credits
Type
integer
Description
Số tín dụng được tác vụ này tiêu thụ. Trả về 0 cho các tác 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 đối với dựng tượng. Có mặt để tương thích giữa các endpoint với cấu trúc V2ImageTo3DTaskResponse dùng chung được sử dụng bởi Ảnh sang 3D.
Name
negative_prompt
Type
string
Description
Luôn rỗng đối với dựng tượng. Có mặt để tương thích giữa các endpoint.
Name
texture_prompt
Type
string
Description
Luôn rỗng đối với dựng tượng. Có mặt để tương thích giữa các endpoint.
Name
texture_image_url
Type
string
Description
Luôn rỗng đối với dựng tượng. Có mặt để tương thích giữa các endpoint.
Name
model_urls
Type
object
Description
Các URL có thể tải xuống cho mô hình 3D được tạo. Dựng tượng xuất ra một GLB có texture cùng cặp OBJ + MTL cho các pipeline ưu tiên Wavefront OBJ. Cấu trúc trường khớp với đối tượng model_urls của Ảnh sang 3D, nhờ đó các định dạng được bổ sung trong tương lai có thể được thêm vào mà không gây thay đổi phá vỡ tương thích.
Name
glb
Type
string
Description
URL có thể tải xuống đến tệp GLB có texture.
Name
obj
Type
string
Description
URL có thể tải xuống đến tệp Wavefront OBJ (hình học + UV).
Name
mtl
Type
string
Description
URL có thể tải xuống đến 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 đến ả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 bởi tác vụ này. Hiện chứa một đối tượng duy nhất với bản đồ màu cơ sở.