リファレンス

APIリファレンス

ホストされたOpenAPIリファレンスの場所、認証方法、すべての応答の形、レート制限。

Polylane APIの完全なリファレンスは、プラットフォームが提供するOpenAPI仕様から生成されるため、常にデプロイされているものと一致します。

APIリファレンスを開く

すべての操作、リクエストと応答の形、コピーできるリクエストのスニペット。

認証

ワークスペースのAPIキーをx-api-keyヘッダーで、またはOAuthアクセストークンをAuthorization: Bearerで送ります。どちらもコンソールで作成します。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はウィンドウの秒数を持つRetry-Afterヘッダー付きで429を返します。それが経過するまで待ってから再試行してください。

すべての操作は、同じ仕様から生成されるCLIからも呼び出せます。