Référence de l'API
La référence complète de l'API Polylane est générée à partir de la spécification OpenAPI que la plateforme sert, donc elle correspond toujours à ce qui est déployé.
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.
Authentification
Envoie une clé API d'espace de travail dans l'en-tête x-api-key, ou un token d'accès OAuth dans Authorization: Bearer. Crée l'un ou l'autre dans la console ; voir Clés API et clients OAuth.
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.
| Champ | Description |
|---|---|
success | true quand la requête a réussi, false quand elle a échoué. |
message | En cas de succès, un objet dont le message décrit l'état. null en cas d'échec. |
error | null en cas de succès. En cas d'échec, un objet avec un message, un detail facultatif et des metadata facultatives. |
result | La charge utile en cas de succès. Absent en cas d'échec. |
{
"success": true,
"message": { "message": "Successful request" },
"error": null,
"result": { "items": [], "count": 0 }
}
Limites de débit
| Surface | Limite |
|---|---|
| API REST | 5,000 requêtes par 60 secondes par identifiant |
| Serveur MCP de la plateforme | 600 requêtes par 60 secondes par identifiant |
Les réponses annoncent la politique dans les en-têtes RateLimit-Limit et RateLimit-Policy. Au-delà de la limite, l'API répond 429 avec un en-tête Retry-After portant la fenêtre en secondes ; attends qu'elle s'écoule, puis réessaie.
Chaque opération peut aussi être appelée depuis la CLI, qui est générée à partir de la même spécification.
Voir aussi
- Clés API et clients OAuth pour créer les identifiants que ces requêtes utilisent.
- CLI pour appeler l'API depuis un terminal ou un script.
- Serveur MCP de la plateforme pour atteindre les mêmes données depuis un agent d'éditeur.