Enterprise API

Enterprise API là một tính năng cho phép bạn tích hợp các khả năng Enterprise của Meshy vào ứng dụng của riêng bạn. Các tính năng API này chỉ khả dụng cho người dùng thuộc gói enterprise của chúng tôi. 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.

GET/openapi/v1/showcases

List Showcases

Endpoint này cho phép bạn tìm kiếm và trả về các mô hình showcase của cộng đồng có sẵn để tải xuống. Bạn có thể trả về tối đa 10 mô hình trong một yêu cầu duy nhất, và mỗi yêu cầu sẽ tốn 1 credit.

Tham số

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

  • Name
    page_size
    Type
    integer
    Description

    Số lượng mô hình showcase cần trả về. Phải là một số dương nằm trong khoảng từ 1 đến 10 (bao gồm cả hai giá trị này). Lưu ý rằng yêu cầu có thể trả về ít hơn số lượng mô hình khớp được yêu cầu nếu không tìm thấy đủ kết quả khớp. Sẽ không có mô hình nào được trả về nếu không tìm thấy kết quả khớp. Mặc định là 3 mô hình nếu không cung cấp page_size.

  • Name
    sort_by
    Type
    string
    Description

    Phương thức sắp xếp kết quả tìm kiếm thu được. Nếu không được cung cấp, kết quả sẽ được sắp xếp theo thời gian tạo từ gần đây nhất đến sớm nhất (-created_at).

    • +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.
    • +updated_at: Sắp xếp theo thời gian cập nhật theo thứ tự tăng dần.
    • -updated_at: Sắp xếp theo thời gian cập nhật theo thứ tự giảm dần.
    • +downloads: Sắp xếp theo số lượt tải xuống theo thứ tự tăng dần.
    • -downloads: Sắp xếp theo số lượt tải xuống theo thứ tự giảm dần.
  • Name
    search
    Type
    string
    Description

    Văn bản để tìm kiếm trong tên các mô hình được công khai bởi cộng đồng (CC0). Nếu không được cung cấp, thì các mô hình cộng đồng hàng đầu tổng thể (dựa trên sort_by) sẽ được trả về.

  • Name
    format
    Type
    string
    Description

    Định dạng mô hình 3D mong muốn cho kết quả trả về. Tất cả các mô hình được lấy về sẽ ở định dạng được chỉ định. Phải là một trong các giá trị tùy chọn bên dưới. Nếu không được cung cấp, mặc định sẽ là glb.

    • glb: định dạng glb.
    • fbx: định dạng fbx.
    • obj: định dạng obj.
    • usdz: định dạng usdz.
  • Name
    showcase_type
    Type
    string
    Description

    Loại mô hình mong muốn cho kết quả trả về. Tất cả các mô hình được lấy về sẽ thuộc loại được chỉ định. Phải là một trong các giá trị tùy chọn bên dưới. Nếu không được cung cấp, mặc định sẽ là all.

    • all: Tất cả các mô hình showcase.
    • animated: Các mô hình showcase có hoạt ảnh.
    • static: Các mô hình showcase tĩnh.

Kết quả trả về

  • Name
    id
    Type
    string
    Description

    Định danh duy nhất cho mô hình showcase. Mặc dù chúng tôi sử dụng k-sortable UUID làm chi tiết triển khai cho id tác vụ, bạn không nên giả định bất kỳ định dạng cụ thể nào cho id.

  • Name
    result_id
    Type
    string
    Description

    Định danh duy nhất cho kết quả mô hình được trả về. ID này được liên kết với mô hình và có thể được sử dụng trực tiếp trong các tác vụ API khác như remesh.

  • Name
    model_url
    Type
    object
    Description

    URL của mô hình 3D có thể tải xuống kèm texture. Mặc định trả về định dạng glb.

  • Name
    conversion_status
    Type
    string
    Description

    Trạng thái chuyển đổi loại tệp của các mô hình được trả về.

    • <chuỗi rỗng>: Chưa chuyển đổi (mặc định glb).
    • success: Chuyển đổi thành công.
    • failed: Chuyển đổi thất bại.
  • Name
    community_url
    Type
    string
    Description

    Liên kết duyệt xem cộng đồng của mô hình showcase.

  • Name
    author
    Type
    string
    Description

    Tác giả của mô hình showcase.

  • Name
    topology
    Type
    string
    Description

    Topology của mô hình showcase (quad hoặc triangle).

  • Name
    name
    Type
    string
    Description

    Tên của mô hình showcase.

  • Name
    object_prompt
    Type
    string
    Description

    Mô tả của mô hình showcase.

  • Name
    categories
    Type
    array
    Description

    Danh mục của mô hình showcase.

  • Name
    tags
    Type
    array
    Description

    Thẻ (tags) của mô hình showcase.

  • Name
    mode
    Type
    string
    Description

    Mode của mô hình showcase.

  • Name
    created_at
    Type
    timestamp
    Description

    Dấu thời gian tạo mô hình showcase (mili giây).

  • Name
    updated_at
    Type
    timestamp
    Description

    Dấu thời gian cập nhật mô hình showcase (mili giây).

Request

GET
/openapi/v1/showcases
curl "https://api.meshy.ai/openapi/v1/showcases?page_size=10&sort_by=-created_at&search=car&format=glb" \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "result": [
    {
      "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
      "result_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
      "model_url": "https://api.meshy.ai/v1/models/018a210d-8ba4-705c-b111-1f1776f7f578/model.glb",
      "conversion_status": "success",
      "community_url": "https://www.meshy.ai/showcase/018a210d-8ba4-705c-b111-1f1776f7f578",
      "author": "John Doe",
      "topology": "quad",
      "name": "Car",
      "object_prompt": "A car",
      "categories": ["vehicle"],
      "tags": ["car", "vehicle"],
      "mode": "3d",
      "created_at": 1717171717171,
      "updated_at": 1717171717171
    }
  ]
}