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