Справочник
Справочник 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-сервер платформы: получите те же данные из агента редактора.