Dokumentacja API
Kompletna dokumentacja API Polylane jest generowana ze specyfikacji OpenAPI serwowanej przez platformę, więc zawsze odpowiada temu, co jest wdrożone.
Otwórz dokumentację API
Każda operacja, kształt żądania i odpowiedzi oraz gotowe do skopiowania fragmenty żądań.
Uwierzytelnianie
Wysyłaj klucz API obszaru roboczego w nagłówku x-api-key albo token dostępu OAuth w Authorization: Bearer. Oba tworzysz w konsoli; zobacz Klucze API i klienci OAuth.
curl https://api.polylane.com/v1/workspaces \
-H "x-api-key: $POLYLANE_API_KEY"
Format odpowiedzi
Każda odpowiedź JSON używa tej samej koperty.
| Pole | Opis |
|---|---|
success | true, gdy żądanie się powiodło, false, gdy nie. |
message | Przy sukcesie obiekt, którego message opisuje status. null przy niepowodzeniu. |
error | null przy sukcesie. Przy niepowodzeniu obiekt z message, opcjonalnym detail i opcjonalnymi metadata. |
result | Ładunek przy sukcesie. Nieobecny przy niepowodzeniu. |
{
"success": true,
"message": { "message": "Successful request" },
"error": null,
"result": { "items": [], "count": 0 }
}
Limity żądań
| Powierzchnia | Limit |
|---|---|
| REST API | 5,000 żądań na 60 sekund na poświadczenie |
| Serwer MCP platformy | 600 żądań na 60 sekund na poświadczenie |
Odpowiedzi ogłaszają politykę w nagłówkach RateLimit-Limit i RateLimit-Policy. Po przekroczeniu limitu API odpowiada 429 z nagłówkiem Retry-After niosącym okno w sekundach; odczekaj, aż upłynie, i spróbuj ponownie.
Każdą operację można też wywołać z CLI, które jest generowane z tej samej specyfikacji.
Powiązane
- Klucze API i klienci OAuth: utwórz poświadczenia, których używają te żądania.
- CLI: wywołuj API z terminala albo skryptu.
- Serwer MCP platformy: sięgaj do tych samych danych z agenta edytora.