Довідник
Довідник API
Де розміщено довідник OpenAPI, як автентифікуватися, як виглядає кожна відповідь і які діють обмеження частоти запитів.
Повний довідник API Polylane генерується зі специфікації OpenAPI, яку віддає платформа, тому він завжди відповідає тому, що розгорнуто.
Автентифікація
Надсилайте ключ 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 | 5,000 запитів за 60 секунд на облікові дані |
| MCP-сервер платформи | 600 запитів за 60 секунд на облікові дані |
Відповіді повідомляють політику в заголовках RateLimit-Limit і RateLimit-Policy. Після перевищення ліміту API відповідає 429 із заголовком Retry-After, що містить вікно в секундах; зачекайте, доки воно мине, і повторіть спробу.
Кожну операцію також можна викликати з CLI, який генерується з тієї самої специфікації.
Пов'язане
- Ключі API та OAuth-клієнти: створення облікових даних, якими користуються ці запити.
- CLI: виклик API з термінала або скрипта.
- MCP-сервер платформи: доступ до тих самих даних з агента редактора.