Referencia de la API
La referencia completa de la API de Polylane se genera a partir de la especificación OpenAPI que sirve la plataforma, así que siempre coincide con lo que está desplegado.
Abrir la referencia de la API
Cada operación, la forma de cada petición y respuesta, y fragmentos de petición para copiar.
Autenticación
Envía una clave de API del espacio de trabajo en la cabecera x-api-key, o un token de acceso OAuth en Authorization: Bearer. Crea cualquiera de los dos en la consola; consulta Claves de API y clientes OAuth.
curl https://api.polylane.com/v1/workspaces \
-H "x-api-key: $POLYLANE_API_KEY"
Formato de respuesta
Cada respuesta JSON usa el mismo sobre.
| Campo | Descripción |
|---|---|
success | true cuando la petición tuvo éxito, false cuando falló. |
message | En caso de éxito, un objeto cuyo message describe el estado. null en caso de fallo. |
error | null en caso de éxito. En caso de fallo, un objeto con un message, un detail opcional y metadata opcional. |
result | La carga útil en caso de éxito. Ausente en caso de fallo. |
{
"success": true,
"message": { "message": "Successful request" },
"error": null,
"result": { "items": [], "count": 0 }
}
Límites de tasa
| Superficie | Límite |
|---|---|
| API REST | 5,000 peticiones por 60 segundos por credencial |
| Servidor MCP de la plataforma | 600 peticiones por 60 segundos por credencial |
Las respuestas anuncian la política en las cabeceras RateLimit-Limit y RateLimit-Policy. Por encima del límite, la API responde 429 con una cabecera Retry-After que lleva la ventana en segundos; espera hasta que transcurra y después reintenta.
Cada operación también se puede llamar desde la CLI, que se genera a partir de la misma especificación.
Relacionado
- Claves de API y clientes OAuth para crear las credenciales que usan estas peticiones.
- CLI para llamar a la API desde una terminal o un script.
- Servidor MCP de la plataforma para llegar a los mismos datos desde el agente de un editor.