Enterprise API

Enterprise API 是一項功能，允許你將 Meshy 的企業級能力整合到你自己的應用程式中。這些 API 功能僅面向我們企業級方案的使用者開放。在本節中，你將找到開始使用此 API 所需的所有資訊。

GET/openapi/v1/showcases

List Showcases

此 endpoint 允許你搜尋並返回可供下載的 community 展示模型。單次請求最多可返回 10 個模型，每次請求將消耗 1 個 credit。

參數

可選屬性

  • Name
    page_size
    Type
    integer
    Description

    要返回的展示模型數量。必須是介於 1 到 10（含）之間的正數。請注意，如果符合條件的模型數量不足，返回的模型數可能會少於請求的數量。如果未找到符合項目，則不會返回任何模型。如果未提供 page_size，預設返回 3 個模型。

  • Name
    sort_by
    Type
    string
    Description

    對取得的搜尋結果進行排序的方法。如果未提供，結果將按建立時間從最新到最早排序（-created_at）。

    • +created_at：按建立時間升序排序。
    • -created_at：按建立時間降序排序。
    • +updated_at：按更新時間升序排序。
    • -updated_at：按更新時間降序排序。
    • +downloads：按下載次數升序排序。
    • -downloads：按下載次數降序排序。
  • Name
    search
    Type
    string
    Description

    在已發布到 community 的（CC0）模型名稱中搜尋的文字。如果未提供，則將返回（依 sort_by）排名最靠前的 community 模型。

  • Name
    format
    Type
    string
    Description

    返回結果所需的 3D 模型格式。取得的所有模型均為指定格式。必須是以下可選值之一。如果未提供，預設為 glb。

    • glb：glb 格式。
    • fbx：fbx 格式。
    • obj：obj 格式。
    • usdz：usdz 格式。
  • Name
    showcase_type
    Type
    string
    Description

    返回結果所需的模型類型。取得的所有模型均為指定類型。必須是以下可選值之一。如果未提供，預設為 all。

    • all：所有展示模型。
    • animated：帶動畫的展示模型。
    • static：靜態展示模型。

回傳值

  • Name
    id
    Type
    string
    Description

    展示模型的唯一識別碼。雖然我們使用 k-可排序 UUID 作為任務 id 的實作細節，但你不應假設 id 具有任何特定格式。

  • Name
    result_id
    Type
    string
    Description

    返回的模型結果的唯一識別碼。此 ID 與模型相關聯，可直接用於其他 API 任務，例如 remesh。

  • Name
    model_url
    Type
    object
    Description

    帶紋理的可下載 3D 模型的 URL。預設返回 glb 格式。

  • Name
    conversion_status
    Type
    string
    Description

    返回模型的檔案類型轉換狀態。

    • <空字串>：未轉換（預設 glb）。
    • success：轉換成功。
    • failed：轉換失敗。
  • Name
    community_url
    Type
    string
    Description

    展示模型的 community 瀏覽連結。

  • Name
    author
    Type
    string
    Description

    展示模型的作者。

  • Name
    topology
    Type
    string
    Description

    展示模型的 topology（quad 或 triangle）。

  • Name
    name
    Type
    string
    Description

    展示模型的名稱。

  • Name
    object_prompt
    Type
    string
    Description

    展示模型的描述。

  • Name
    categories
    Type
    array
    Description

    展示模型的分類。

  • Name
    tags
    Type
    array
    Description

    展示模型的標籤。

  • Name
    mode
    Type
    string
    Description

    展示模型的 mode。

  • Name
    created_at
    Type
    timestamp
    Description

    展示模型建立的 timestamp（毫秒）。

  • Name
    updated_at
    Type
    timestamp
    Description

    展示模型更新的 timestamp（毫秒）。

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
    }
  ]
}