Reference
API-reference
Hvor den hostede OpenAPI-reference ligger, hvordan du autentificerer, hvordan hvert svar ser ud, og rate limits.
Den komplette Polylane-API-reference genereres ud fra den OpenAPI-specifikation, platformen serverer, så den matcher altid det, der er deployet.
Autentificering
Send en API-nøgle til arbejdsområdet i headeren x-api-key eller et OAuth-adgangstoken i Authorization: Bearer. Opret begge i konsollen; se API-nøgler og OAuth-klienter.
Terminal
curl https://api.polylane.com/v1/workspaces \
-H "x-api-key: $POLYLANE_API_KEY"
Svarformat
Hvert JSON-svar bruger den samme konvolut.
| Felt | Beskrivelse |
|---|---|
success | true når anmodningen lykkedes, false når den fejlede. |
message | Ved succes et objekt, hvis message beskriver statussen. null ved fejl. |
error | null ved succes. Ved fejl et objekt med en message, en valgfri detail og valgfri metadata. |
result | Payloaden ved succes. Fraværende ved fejl. |
{
"success": true,
"message": { "message": "Successful request" },
"error": null,
"result": { "items": [], "count": 0 }
}
Rate limits
| Overflade | Grænse |
|---|---|
| REST-API | 5,000 anmodninger pr. 60 sekunder pr. legitimation |
| Platformens MCP-server | 600 anmodninger pr. 60 sekunder pr. legitimation |
Svar annoncerer politikken i headerne RateLimit-Limit og RateLimit-Policy. Over grænsen svarer API'et 429 med en Retry-After-header, der bærer vinduet i sekunder; hold igen, indtil det er udløbet, og prøv så igen.
Hver operation kan også kaldes fra CLI'en, som genereres ud fra den samme specifikation.
Relateret
- API-nøgler og OAuth-klienter for at oprette de legitimationsoplysninger, disse anmodninger bruger.
- CLI for at kalde API'et fra en terminal eller et script.
- Platformens MCP-server for at nå de samme data fra en editoragent.