Документация

Справочник API

Размещённый справочник OpenAPI для платформы Polylane с каждой операцией, формой запроса и формой ответа.

Полный справочник API Polylane размещён рядом с самой платформой:

Открыть справочник API

Каждая операция, форма запроса и ответа и готовые к копированию фрагменты запросов. Генерируется из спецификации OpenAPI, которую отдаёт платформа, поэтому остаётся синхронизированным с каждым релизом.

Аутентификация

Аутентифицируйте запросы одним из способов:

x-api-key: <api-key> для API-ключей рабочего пространства.
Authorization: Bearer <access-token> для OAuth access-токенов.

Создавайте API-ключи и регистрируйте OAuth-клиенты в консоли. См. API-ключи и OAuth.

Terminal

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. Каждый ответ объявляет политику через заголовки RateLimit из проекта IETF:

RateLimit-Limit: 5000
RateLimit-Policy: 5000;w=60

При превышении лимита API отвечает 429 и заголовком Retry-After с длиной окна в секундах. Подождите, пока оно не пройдёт, затем повторите.

У MCP-сервера платформы свой бюджет в 600 запросов за 60 секунд на учётные данные, и он объявляет его теми же заголовками.

Из командной строки

Каждая операция API вызывается из интерфейса командной строки Polylane (CLI), включая операции без полноценной команды:

Terminal

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.

llms.txt

Документация Polylane публикуется как машиночитаемые текстовые файлы и маршруты сырого markdown, чтобы языковые модели и кодинг-агенты могли потреблять её напрямую.