Docs

Référence de l'API

La référence OpenAPI hébergée de la plateforme Polylane, avec chaque opération, chaque forme de requête et chaque forme de réponse.

La référence complète de l'API Polylane est hébergée à côté de la plateforme elle-même :

Ouvrir la référence de l'API

Chaque opération, chaque forme de requête et de réponse, et des extraits de requêtes à copier. Générée à partir de la spécification OpenAPI que la plateforme sert, donc elle reste synchronisée avec chaque version.

Authentification

Authentifie les requêtes avec l'un de ces en-têtes :

x-api-key: <api-key> pour les clés API d'espace de travail.
Authorization: Bearer <access-token> pour les tokens d'accès OAuth.

Crée des clés API et enregistre des clients OAuth dans la console. Voir Clés API et OAuth.

Terminal

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

Format des réponses

Chaque réponse JSON utilise la même enveloppe. Les réponses réussies mettent success: true et placent la charge utile sous result :

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

Les réponses d'erreur mettent success: false et décrivent l'échec sous error :

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

Limites de débit

Chaque identifiant (clé API, token OAuth ou IP du client pour les routes non authentifiées) est limité à 5,000 requêtes par 60 secondes sur l'ensemble de l'API REST. Chaque réponse annonce la politique avec les en-têtes RateLimit du brouillon IETF :

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

Quand la limite est dépassée, l'API répond avec 429 et un en-tête Retry-After portant la longueur de la fenêtre en secondes. Attends qu'elle s'écoule, puis réessaie.

Le serveur MCP de la plateforme a son propre budget de 600 requêtes par 60 secondes par identifiant et l'annonce avec les mêmes en-têtes.

Depuis la ligne de commande

Chaque opération de l'API peut être appelée depuis l'interface en ligne de commande Polylane (CLI), y compris les opérations sans commande à part entière :

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 accepte --body '<json>' pour les corps de requête, --body-file <path> pour lire un corps depuis un fichier, et --query '<json>' pour les paramètres de requête.

Le client CLI est généré à partir de la même spécification OpenAPI que la référence hébergée, donc chaque opération que tu y trouves peut être appelée directement. Authentifie-le avec une clé API via polylane auth login --api-key sk_..., ou exécute polylane auth login pour le flux navigateur. Voir Authentification de la CLI.

llms.txt

La documentation de Polylane est publiée sous forme de fichiers texte lisibles par machine et de routes markdown brutes pour que les modèles de langage et les agents de codage puissent la consommer directement.