Referenz
API-Referenz
Wo die gehostete OpenAPI-Referenz liegt, wie du dich authentifizierst, wie jede Antwort aussieht und die Rate-Limits.
Die vollständige Polylane-API-Referenz wird aus der OpenAPI-Spezifikation generiert, die die Plattform ausliefert, sodass sie immer zu dem passt, was deployt ist.
Authentifizierung
Sende einen Workspace-API-Schlüssel im Header x-api-key oder einen OAuth-Access-Token in Authorization: Bearer. Erstelle beides in der Konsole; siehe API-Schlüssel und OAuth-Clients.
Terminal
curl https://api.polylane.com/v1/workspaces \
-H "x-api-key: $POLYLANE_API_KEY"
Antwortformat
Jede JSON-Antwort nutzt dieselbe Hülle.
| Feld | Beschreibung |
|---|---|
success | true, wenn die Anfrage erfolgreich war, false, wenn sie fehlgeschlagen ist. |
message | Bei Erfolg ein Objekt, dessen message den Status beschreibt. null bei Fehlschlag. |
error | null bei Erfolg. Bei Fehlschlag ein Objekt mit einer message, einem optionalen detail und optionalen metadata. |
result | Die Payload bei Erfolg. Fehlt bei Fehlschlag. |
{
"success": true,
"message": { "message": "Successful request" },
"error": null,
"result": { "items": [], "count": 0 }
}
Rate-Limits
| Oberfläche | Limit |
|---|---|
| REST-API | 5,000 Anfragen pro 60 Sekunden pro Schlüssel oder Token |
| Plattform-MCP-Server | 600 Anfragen pro 60 Sekunden pro Schlüssel oder Token |
Antworten geben die Richtlinie in den Headern RateLimit-Limit und RateLimit-Policy bekannt. Über dem Limit antwortet die API mit 429 und einem Header Retry-After, der das Fenster in Sekunden trägt; warte, bis es abgelaufen ist, und versuche es dann erneut.
Jede Operation lässt sich auch aus der CLI aufrufen, die aus derselben Spezifikation generiert wird.
Verwandt
- API-Schlüssel und OAuth-Clients, um die Zugangsdaten zu erstellen, die diese Anfragen nutzen.
- CLI, um die API aus einem Terminal oder einem Skript aufzurufen.
- Plattform-MCP-Server, um dieselben Daten aus einem Editor-Agent zu erreichen.