参考

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调用，它从同一份规范生成。