參考

API參考

託管的OpenAPI參考在哪裡、如何驗證、每個回應長什麼樣子，以及速率限制。

完整的Polylane API參考從平台提供的OpenAPI規格產生，所以它永遠與已部署的版本一致。

開啟API參考

每個操作、請求與回應形狀，以及可複製的請求片段。

驗證

在x-api-key標頭中送出工作區API金鑰，或在Authorization: Bearer中送出OAuth存取權杖。兩者都在主控台建立；請見API金鑰與OAuth客戶端。

Terminal

curl https://api.polylane.com/v1/workspaces \
  -H "x-api-key: $POLYLANE_API_KEY"

每個JSON回應都使用同一個信封。

欄位	說明
`success`	請求成功時為`true`，失敗時為`false`。
`message`	成功時，是一個其`message`描述狀態的物件。失敗時為`null`。
`error`	成功時為`null`。失敗時，是一個帶有`message`、選填的`detail`與選填的`metadata`的物件。
`result`	成功時的內容。失敗時不存在。

{
  "success": true,
  "message": { "message": "Successful request" },
  "error": null,
  "result": { "items": [], "count": 0 }
}

介面	限制
REST API	每個憑證每60秒5,000個請求
平台MCP伺服器	每個憑證每60秒600個請求

回應在RateLimit-Limit與RateLimit-Policy標頭中公告政策。超過限制時，API以429回應，並在Retry-After標頭中帶上以秒為單位的時間窗；等它過去後再重試。

每個操作也都可以從CLI呼叫，CLI從同一份規格產生。