Довідник API
Повний довідник API Polylane розміщено разом із самою платформою:
Відкрити довідник API
Кожна операція, форма запиту та відповіді, а також фрагменти запитів для копіювання. Генерується зі специфікації OpenAPI, яку надає платформа, тому залишається синхронізованим із кожним релізом.
Автентифікація
Автентифікуйте запити одним із способів:
x-api-key: <api-key>для ключів API робочого простору.Authorization: Bearer <access-token>для токенів доступу OAuth.
Створюйте ключі API та реєструйте клієнти OAuth у консолі. Див. Ключі API та OAuth.
curl https://api.polylane.com/v1/workspaces \
-H "x-api-key: $POLYLANE_API_KEY"
Формат відповіді
Кожна відповідь JSON використовує той самий конверт. Успішні відповіді задають success: true і розміщують дані в result:
{
"success": true,
"message": { "message": "Successful request" },
"error": null,
"result": { "items": [], "count": 0 }
}
Відповіді з помилкою задають success: false і описують збій в error:
{
"success": false,
"message": null,
"error": { "message": "Unauthorized", "detail": "Invalid API key" }
}
Обмеження частоти запитів
Кожні облікові дані (ключ API, токен OAuth або IP клієнта для неавтентифікованих маршрутів) обмежені 5,000 запитами за 60 секунд у межах REST API. Кожна відповідь оголошує політику за допомогою чернеткових заголовків IETF RateLimit:
RateLimit-Limit: 5000
RateLimit-Policy: 5000;w=60
Коли ліміт перевищено, API відповідає 429 і заголовком Retry-After із довжиною вікна в секундах. Зачекайте, доки воно мине, і повторіть спробу.
MCP-сервер платформи має власний бюджет у 600 запитів за 60 секунд на облікові дані та оголошує його тими самими заголовками.
З командного рядка
Кожну операцію API можна викликати з інтерфейсу командного рядка Polylane (CLI), включно з операціями без повноправної команди:
polylane api list # every operation
polylane api describe workspaces.list # request and response shape
polylane api call issues.list --query '{"active":true,"severity":"critical"}'
polylane api call приймає --body '<json>' для тіл запитів, --body-file <path> для читання тіла з файлу та --query '<json>' для параметрів запиту.
Клієнт CLI генерується з тієї самої специфікації OpenAPI, що й розміщений довідник, тому кожну знайдену там операцію можна викликати безпосередньо. Автентифікуйте його ключем API через polylane auth login --api-key sk_... або виконайте polylane auth login для процесу в браузері. Див. Автентифікацію CLI.