Referanse
API-referanse
Hvor den driftede OpenAPI-referansen ligger, hvordan du autentiserer, hvordan hvert svar ser ut, og ratebegrensningene.
Den komplette Polylane API-referansen genereres fra OpenAPI-spesifikasjonen plattformen serverer, så den stemmer alltid med det som er deployet.
Autentisering
Send en workspace-API-nøkkel i headeren x-api-key, eller et OAuth-tilgangstoken i Authorization: Bearer. Opprett begge i konsollen; se API-nøkler og OAuth-klienter.
Terminal
curl https://api.polylane.com/v1/workspaces \
-H "x-api-key: $POLYLANE_API_KEY"
Svarformat
Hvert JSON-svar bruker den samme konvolutten.
| Felt | Beskrivelse |
|---|---|
success | true når forespørselen lyktes, false når den feilet. |
message | Ved suksess et objekt der message beskriver statusen. null ved feil. |
error | null ved suksess. Ved feil et objekt med en message, en valgfri detail og valgfrie metadata. |
result | Nyttelasten ved suksess. Utelatt ved feil. |
{
"success": true,
"message": { "message": "Successful request" },
"error": null,
"result": { "items": [], "count": 0 }
}
Ratebegrensninger
| Flate | Grense |
|---|---|
| REST-API | 5,000 forespørsler per 60 sekunder per legitimasjon |
| Plattformens MCP-server | 600 forespørsler per 60 sekunder per legitimasjon |
Svar annonserer policyen i headerne RateLimit-Limit og RateLimit-Policy. Over grensen svarer API-et 429 med en Retry-After-header som bærer vinduet i sekunder; vent til det er over, og prøv så igjen.
Hver operasjon kan også kalles fra CLI-en, som genereres fra den samme spesifikasjonen.
Relatert
- API-nøkler og OAuth-klienter for å opprette legitimasjonen disse forespørslene bruker.
- CLI for å kalle API-et fra en terminal eller et skript.
- Plattformens MCP-server for å nå de samme dataene fra en editoragent.