Creative Lab — 可折叠指尖玩具 API

将一张源照片转变为可原地打印的可折叠指尖玩具：主体的轮廓变成一组嵌套的同心环， 可以折叠平整也可以再次拉伸展开，一体打印，无需组装。

  • POST /openapi/creative-lab/fidget-collapsible/v1

与其他 Creative Lab endpoint 不同，此 endpoint 没有原型/构建阶段这一对流程—— 不存在需要从中选择的中间候选项，因此一个任务会将图像一直处理到 3D 模型。web 应用中 暴露的 geometry 控制选项（尺寸、层数、间隙宽度、壁厚、挤出深度、凸起程度）也不 属于请求的一部分：每个任务都使用相同的服务器端默认值构建。

POST/openapi/creative-lab/fidget-collapsible/v1

创建可折叠指尖玩具任务

根据源照片生成一个可折叠指尖玩具模型。响应的具体结构请参阅 可折叠指尖玩具任务对象。

每个任务花费 6 credits，且需要付费方案。

参数

  • Name
    image_url
    Type
    string
    必选
    Description

    Meshy 用于生成可折叠指尖玩具的源照片。目前支持 .jpg、.jpeg、.png 和 .webp 格式。

    提供图片有两种方式：

    • 可公开访问的 URL：可从公共互联网访问的 URL。
    • Data URI：图片的 base64 编码 data URI。data URI 示例：data:image/jpeg;base64,<your base64-encoded image data>。

    主体轮廓清晰、封闭效果最佳——轮廓将成为环状结构。背景杂乱、存在多个独立主体，或形状过薄，都可能导致嵌套壁面所需的面积不足，从而使任务失败并返回任务错误。

  • Name
    name
    Type
    string
    Description

    可选的任务名称，用于展示。最多 100 个字符。这仅是任务标签，不会刻印在模型上。

返回值

响应中的 result 属性包含新创建的可折叠指尖玩具任务的任务 id。轮询 获取任务 endpoint，或订阅 流式接口，直到任务达到 SUCCEEDED 状态，然后从 model_urls.stl 下载可打印的 STL 文件（如果存在，也可从 model_urls.glb 下载 GLB 文件以先行预览）。

失败模式

  • Name
    400 - Bad Request
    Description

    请求内容不可接受。常见原因：

    • 缺少参数：image_url 为必填项。
    • 图片格式无效：提供的 image_url 不是受支持的格式（.jpg、.jpeg、.png、.webp）。
    • 图片尺寸超出范围：图片过小、超过最大文件大小或超过最大像素数。
    • URL 无法访问：无法下载 image_url（404 或 timeout）。
    • Data URI 无效：base64 字符串格式有误。
    • 内容被标记：输入图片被 NSFW moderation 标记。
  • Name
    401 - Unauthorized
    Description

    Authentication 失败。请检查你的 API key。

  • Name
    402 - Payment Required
    Description

    你的账户为免费方案（此 endpoint 的任务创建需要付费方案），或者你的 credits 不足。

  • Name
    403 - Forbidden
    Description

    输入图片因涉及知识产权侵权被标记。

  • Name
    429 - Too Many Requests
    Description

    你已超出速率限制。

Request

POST
/openapi/creative-lab/fidget-collapsible/v1
curl https://api.meshy.ai/openapi/creative-lab/fidget-collapsible/v1 \
  -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"
}
GET/openapi/creative-lab/fidget-collapsible/v1/:id

获取一个可折叠玩具（Collapsible Fidget）任务

根据有效的任务 id 获取一个可折叠玩具任务。此处仅能访问通过该 endpoint 创建的任务——通过其他 Creative Lab endpoint 创建的任务，或在网页应用中创建的任务，将返回 404。

有关响应结构，请参阅可折叠玩具任务对象。

参数

  • Name
    id
    Type
    path
    Description

    要获取的可折叠玩具任务的唯一标识符。

返回值

响应中包含可折叠玩具任务对象。

Request

GET
/openapi/creative-lab/fidget-collapsible/v1/018a210d-8ba4-705c-b111-1f1776f7f578
curl https://api.meshy.ai/openapi/creative-lab/fidget-collapsible/v1/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-fidget-collapsible",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123512000,
  "expires_at": 1729382712000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  }
}
DELETE/openapi/creative-lab/fidget-collapsible/v1/:id

删除可折叠指尖玩具任务

取消一个可折叠指尖玩具任务。如果任务仍处于 PENDING 状态，创建时消耗的 credits 将被退还。已处于 IN_PROGRESS 状态的任务会被取消但不予退款 （工作进程可能已经在消耗资源）。已经达到终止状态 （SUCCEEDED、FAILED、CANCELED）的任务无法被取消。

路径参数

  • Name
    id
    Type
    path
    Description

    要取消的可折叠指尖玩具任务的唯一标识符。

返回值

成功时返回 204 No Content，响应体为空。

失败模式

  • Name
    400 - Bad Request
    Description

    该任务已处于终止状态，无法取消。

  • Name
    404 - Not Found
    Description

    该任务不存在、属于其他用户，或未通过此 endpoint 创建。

Request

DELETE
/openapi/creative-lab/fidget-collapsible/v1/018a210d-8ba4-705c-b111-1f1776f7f578
curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/fidget-collapsible/v1/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 204 No Content on success (empty body).
GET/openapi/creative-lab/fidget-collapsible/v1/:id/stream

流式获取可折叠玩具任务

通过服务器发送事件（SSE）流式获取可折叠玩具任务的实时更新。如果任务不存在，或不是通过此 endpoint 创建的，将发出单个 event: error payload，其中包含 status_code: 404，随后关闭流。

参数

  • Name
    id
    Type
    path
    Description

    要进行流式传输的可折叠玩具任务的唯一标识符。

返回值

以 Server-Sent Events 的形式返回一个 可折叠玩具 任务对象流。每一帧都携带该阶段的完整任务对象——与 Get endpoint 返回的结构相同——因此当任务处于 PENDING 或 IN_PROGRESS 状态时， 输出字段只是尚未填充（为 null、[] 或 {}），且 finished_at 为 null。

Request

GET
/openapi/creative-lab/fidget-collapsible/v1/018a210d-8ba4-705c-b111-1f1776f7f578/stream
curl -N https://api.meshy.ai/openapi/creative-lab/fidget-collapsible/v1/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example (task not found, or not created through this endpoint)
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// Every frame is the full task object; fields not yet populated are null / empty.
// The PENDING frame below is abbreviated to the fields that change.
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-fidget-collapsible",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123512000,
  "expires_at": 1729382712000,
  "task_error": null,
  "consumed_credits": 6,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  }
}
GET/openapi/creative-lab/fidget-collapsible/v1

获取可折叠指尖玩具任务列表

获取您的可折叠指尖玩具任务的分页列表。仅包含通过该 endpoint 创建的任务。

查询参数

  • Name
    page_num
    Type
    integer
    默认值 1
    Description

    用于分页的页码。

  • Name
    page_size
    Type
    integer
    默认值 10
    Description

    每页数量限制。最大允许值为 100 项。

  • Name
    sort_by
    Type
    string
    默认值 -created_at
    Description

    用于排序的字段。可用值：

    • +created_at：按创建时间升序排序。
    • -created_at：按创建时间降序排序。

返回值

返回可折叠指尖玩具任务对象的分页列表。

Request

GET
/openapi/creative-lab/fidget-collapsible/v1
curl https://api.meshy.ai/openapi/creative-lab/fidget-collapsible/v1?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-fidget-collapsible",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729123456000,
    "started_at": 1729123460000,
    "finished_at": 1729123512000,
    "expires_at": 1729382712000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
      "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
    }
  }
]

可折叠指尖玩具任务对象

可折叠指尖玩具任务对象是 Meshy 用来跟踪的工作单元，用于将一张源照片转换为可原地打印的可折叠指尖玩具模型。这是一个单阶段任务：没有可供链式调用的原型，中间轮廓也不属于响应内容的一部分。

属性

  • Name
    id
    Type
    string
    Description

    任务的唯一标识符。虽然我们在实现细节中使用 k-可排序的 UUID 作为任务 id，但你不应对 id 的格式做任何假设。

  • Name
    type
    Type
    string
    Description

    任务的类型。该值为 creative-lab-fidget-collapsible。

  • Name
    name
    Type
    string
    Description

    创建任务时提供的任务名称。如果未提供名称，则为空字符串。

  • Name
    status
    Type
    string
    Description

    任务的状态。可能的值为 PENDING、IN_PROGRESS、SUCCEEDED、FAILED、CANCELED 之一。

  • Name
    progress
    Type
    integer
    Description

    任务的进度。如果任务尚未开始，此属性将为 0。一旦任务成功，该值将变为 100。

  • Name
    created_at
    Type
    timestamp
    Description

    任务创建时间的时间戳，单位为毫秒。

    时间戳表示自 1970 年 1 月 1 日 UTC 起经过的毫秒数，遵循 RFC 3339 标准。 例如，格林尼治标准时间 2023 年 9 月 1 日星期五中午 12:00:00 表示为 1693569600000。这适用于 Meshy API 中的所有时间戳。

  • Name
    started_at
    Type
    timestamp
    Description

    任务开始时间的时间戳，单位为毫秒。如果任务尚未开始，此属性将为 null。

  • Name
    finished_at
    Type
    timestamp
    Description

    任务完成时间的时间戳，单位为毫秒。如果任务尚未完成，此属性将为 null。

  • Name
    expires_at
    Type
    timestamp
    Description

    任务结果过期时间的时间戳，单位为毫秒。

  • Name
    preceding_tasks
    Type
    integer
    Description

    排在前面的任务数量。

    此字段的值仅在任务状态为 PENDING 时才有意义。

  • Name
    task_error
    Type
    object
    Description

    失败任务的错误详情。完整的 task_error 对象参考请参见错误。

  • Name
    consumed_credits
    Type
    integer
    Description

    此任务消耗的 credits 数量。当任务状态为 PENDING、IN_PROGRESS 或 SUCCEEDED 时会出现该字段。对于 FAILED 任务，返回 0（失败时会退还 credits）。

  • Name
    model_urls
    Type
    object
    Description

    生成的 3D 模型的可下载 URL。一旦任务SUCCEEDED即会填充：stl 始终存在，glb 仅在预览渲染成功时才存在。

    • Name
      stl
      Type
      string
      Description

      指向 STL 文件的可下载 URL。这是可打印的交付物——可直接发送给 slicer。

    • Name
      glb
      Type
      string
      Description

      指向 GLB 文件的可下载 URL，用于在 3D 查看器中预览模型。其颜色仅用于预览：STL 不携带颜色信息，打印出的指尖玩具的颜色取决于所用的耗材。GLB 是尽力而为提供的：当预览渲染不可用时，该键会从 model_urls 中完全省略，因此读取时应做好防御性处理——stl 才是交付物，在 SUCCEEDED 任务中始终存在。

Example Collapsible Fidget Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-fidget-collapsible",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123512000,
  "expires_at": 1729382712000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  }
}