Docs

Referencia de la API

La referencia OpenAPI alojada de la plataforma Polylane, con cada operación, forma de petición y forma de respuesta.

La referencia completa de la API de Polylane se aloja junto a la propia plataforma:

Abrir la referencia de la API

Cada operación, la forma de cada petición y respuesta, y fragmentos de petición para copiar. Generada a partir de la especificación OpenAPI que sirve la plataforma, así que se mantiene sincronizada con cada versión.

Autenticación

Autentica las peticiones con una de estas opciones:

x-api-key: <api-key> para las claves de API del espacio de trabajo.
Authorization: Bearer <access-token> para los tokens de acceso OAuth.

Crea claves de API y registra clientes OAuth en la consola. Consulta Claves de API y OAuth.

Terminal

curl https://api.polylane.com/v1/workspaces \
  -H "x-api-key: $POLYLANE_API_KEY"

Formato de respuesta

Todas las respuestas JSON usan la misma envoltura. Las respuestas correctas establecen success: true y colocan la carga bajo result:

{
  "success": true,
  "message": { "message": "Successful request" },
  "error": null,
  "result": { "items": [], "count": 0 }
}

Las respuestas de error establecen success: false y describen el fallo bajo error:

{
  "success": false,
  "message": null,
  "error": { "message": "Unauthorized", "detail": "Invalid API key" }
}

Límites de tasa

Cada credencial (clave de API, token OAuth o IP del cliente para las rutas sin autenticación) está limitada a 5,000 peticiones por 60 segundos en toda la API REST. Cada respuesta anuncia la política con las cabeceras RateLimit del borrador de la IETF:

RateLimit-Limit: 5000
RateLimit-Policy: 5000;w=60

Cuando se supera el límite, la API responde con 429 y una cabecera Retry-After que lleva la duración de la ventana en segundos. Espera hasta que transcurra, y luego reintenta.

El servidor MCP de la plataforma tiene su propio presupuesto de 600 peticiones por 60 segundos por credencial y lo anuncia con las mismas cabeceras.

Desde la línea de comandos

Todas las operaciones de la API se pueden llamar desde la interfaz de línea de comandos de Polylane (CLI), incluidas las operaciones sin un comando de primera clase:

Terminal

polylane api list                         # every operation
polylane api describe workspaces.list     # request and response shape
polylane api call issues.list --query '{"active":true,"severity":"critical"}'

polylane api call acepta --body '<json>' para los cuerpos de petición, --body-file <path> para leer un cuerpo desde un archivo y --query '<json>' para los parámetros de consulta.

El cliente de la CLI se genera a partir de la misma especificación OpenAPI que la referencia alojada, así que cada operación que encuentres allí se puede llamar directamente. Autentícalo con una clave de API mediante polylane auth login --api-key sk_..., o ejecuta polylane auth login para el flujo del navegador. Consulta Autenticación de la CLI.

llms.txt

La documentación de Polylane se publica como archivos de texto legibles por máquina y rutas de markdown en bruto para que los modelos de lenguaje y los agentes de programación puedan consumirla directamente.