開發者平台

開發者平台是執行、監控和設定你的 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指南。