Riferimento API
Il riferimento completo dell'API di Polylane è generato dalla specifica OpenAPI che la piattaforma serve, quindi corrisponde sempre a ciò che è deployato.
Apri il riferimento API
Ogni operazione, la forma di richiesta e risposta, e snippet di richiesta copiabili.
Autenticazione
Invia una chiave API del workspace nell'header x-api-key, oppure un access token OAuth in Authorization: Bearer. Crea l'una o l'altro nella console; vedi Chiavi API e client OAuth.
curl https://api.polylane.com/v1/workspaces \
-H "x-api-key: $POLYLANE_API_KEY"
Formato della risposta
Ogni risposta JSON usa la stessa busta.
| Campo | Descrizione |
|---|---|
success | true quando la richiesta è riuscita, false quando è fallita. |
message | In caso di successo, un oggetto il cui message descrive lo stato. null in caso di fallimento. |
error | null in caso di successo. In caso di fallimento, un oggetto con un message, un detail facoltativo e metadata facoltativi. |
result | Il payload in caso di successo. Assente in caso di fallimento. |
{
"success": true,
"message": { "message": "Successful request" },
"error": null,
"result": { "items": [], "count": 0 }
}
Rate limit
| Superficie | Limite |
|---|---|
| API REST | 5,000 richieste ogni 60 secondi per credenziale |
| Server MCP della piattaforma | 600 richieste ogni 60 secondi per credenziale |
Le risposte annunciano la policy negli header RateLimit-Limit e RateLimit-Policy. Oltre il limite, l'API risponde 429 con un header Retry-After che porta la finestra in secondi; attendi che trascorra, poi riprova.
Ogni operazione è richiamabile anche dalla CLI, che è generata dalla stessa specifica.
Correlati
- Chiavi API e client OAuth per creare le credenziali che queste richieste usano.
- CLI per chiamare l'API da un terminale o da uno script.
- Server MCP della piattaforma per raggiungere gli stessi dati dall'agente di un editor.