开发者平台

开发者平台是运行、监控和配置你的 Meshy API 集成的一切所在——它提供了一个无需编写代码即可试用 endpoint 的 Playground、涵盖你账户所有 API 请求的仪表盘,以及 API key 和 webhook 管理功能。

免费账户只能通过一个专用的内置测试 key,在 Playground 中试用 Image to 3D endpoint——免费账户无法创建或管理自己的 API key,也没有 Usage dashboard 或 Request Logs。Pro、Premium、Ultra、Studio 和 Enterprise 套餐可使用 Playground 中的每一个 endpoint,并可完整访问 Usage dashboard 和 Request Logs,以及拥有自己的 API key。

概览

从 web app 中打开开发者平台。其侧边栏分为以下几个部分:

Build（构建）——Playground,用于交互式试用 endpoint。
Monitor（监控）——Usage dashboard 和 Request Logs。
Configure（配置）——API Keys 和 Webhooks。

概览页面本身会引导新账户完成以下三个步骤(创建一个 key、在 Playground 中试用一个请求、在 Request Logs 中查看结果),随后展示你账户自身活动的 7 天使用情况快照,以及 Meshy API 更新日志中的最新条目。

开发者平台的概览页面,显示了三步入门卡片、7 天使用情况快照,以及最新的 Meshy API 更新日志更新

刚接触该 API？从快速开始开始吧。

Playground

Playground 是一个交互式控制台,可让你无需编写任何代码即可试用 endpoint。选择一个 endpoint,根据内嵌说明填写参数,然后提交——任务会通过与 API 相同的异步管道运行,因此你可以观察任务从 PENDING 变为 SUCCEEDED 的过程,并查看完整的响应及生成的模型。

正在运行 Image to 3D 请求的 Playground,展示了实时模型预览以及 Preview、Request 和 Response 标签页

在任务运行期间,Preview 标签页会流式传输实时状态更新——无需轮询。

Playground 的 Preview 标签页日志,在任务进行中流式传输实时状态更新

切换到 Request 标签页,可获取 cURL、Python 或 JavaScript 格式的可直接运行代码片段;切换到 Response 标签页则可查看完整的 JSON——这正是 Playground 相较于 webapp workspace 的价值所在:你构建的每一个请求,只需复制粘贴,即可在你自己的代码中运行。

Request and Response tabs

The same task, viewed two ways: the equivalent cURL request, and the raw JSON response.

The Playground's Request tab showing the equivalent cURL command for the current request — Request

The Playground's Response tab showing the raw JSON response — Response

Usage dashboard

Usage dashboard 会将你账户所有的 API 活动可视化——无论是直接通过 API 发起的请求,还是通过 Playground 发起的请求。它显示生成成功率、请求总数、平均处理时间和已消耗的 credits,以及随时间变化的请求量,和按 endpoint 划分的成功率与延迟明细。

Usage dashboard,显示生成成功率、随时间变化的请求量,以及按 endpoint 划分的成功率和延迟

Request logs

Request Logs 会列出你账户上每一个 API 任务——无论是直接的 API 调用还是 Playground 请求——并显示状态、时间信息,以及发起请求所使用的 API key。选择一个任务即可查看其完整的输入和输出、请求体,以及所消耗的 credits——这对于调试某个特定调用而无需重新查询 API 非常有用——或者你也可以直接跳转到 Playground 中查看该任务。使用 Export CSV 可导出完整列表,用于报告或对账。

Request Logs,详情 panel 中显示了所选任务的状态、输入/输出预览和请求体——Export CSV 和 Open in Playground 按钮被高亮显示

API management

API Keys——创建、命名和撤销 key,为每个 key 设置每月的 credit 限额,并查看每个 key 的使用情况。
Webhooks——在你的 API 任务状态发生变化时获取实时更新,而无需轮询。有关设置步骤、投递要求和示例负载,请参阅 Webhooks 指南。

Feedback

开发者平台的每个页面右下角都有一个 Feedback 按钮——你可以用它来报告 bug、请求新功能,或告诉我们哪里让你感到困惑。我们会阅读每一条反馈。

Authentication & credits

请求通过在 Authorization: Bearer 头中传递的 API key 进行授权,与直接调用 API 完全相同。Playground 是基于你自己的账户运行的,因此每个请求都会消耗你套餐中的 credits,并计入你的速率限制,与其他任何 API 调用完全一样。有关 key 格式和安全性的详细信息,请参阅authentication指南。