Passer au contenu principal
POST
Déclencher le webhook Autopilot
Utilisez cet endpoint pour lancer une exécution d’Autopilot depuis vos propres outils. Chaque requête met en file d’attente une exécution qui suit le prompt du corps de la requête, avec le même contexte, les mêmes compétences et les mêmes paramètres de revue que les autres exécutions d’Autopilot. Autopilot doit être activé pour le projet.

Cas d’usage

  • Scripts de publication : Indiquez à Autopilot ce qui a été publié lorsque vous créez un tag ou publiez une nouvelle version d’un SDK.
  • Pipelines CI/CD : Demandez à Autopilot de vérifier la documentation après un déploiement ou une fusion dans main.
  • Outils internes : Envoyez des demandes de documentation depuis des tableaux de bord internes, des outils de support ou des tâches planifiées que vous exécutez déjà.

Obtenir l’URL du webhook et l’en-tête d’authentification

Ouvrez la page Autopilot de votre tableau de bord. La section Webhook affiche l’URL complète du webhook et une action Copy auth header pour le modèle d’en-tête Authorization: Bearer <api-key>. Remplacez <api-key> par une clé d’API d’organisation non expirée disposant d’un accès en écriture. Créez ou gérez vos clés sur la page API keys.

Exemple

Demandez à Autopilot de documenter chaque publication depuis une GitHub Action :
.github/workflows/autopilot-release.yml

Ce qui se passe après une requête

Autopilot traite le prompt comme n’importe quelle autre exécution. Lorsqu’il ouvre ou met à jour une pull request, il assigne des relecteurs et notifie votre équipe de la même manière que pour les modifications de code. Chaque exécution apparaît comme son propre fil sur la page Autopilot. Si Autopilot est en pause, l’exécution attend que vous repreniez Autopilot.

Limites de débit et crédits

Cet endpoint partage une limite de débit avec Déclencher un déploiement, Déclencher une automatisation et Déclencher un webhook d’automatisation : jusqu’à 10 requêtes toutes les 10 secondes par organisation. Une exécution coûte 250 crédits lorsqu’elle ouvre ou met à jour une pull request. Consultez Crédits Autopilot.

Autorisations

Authorization
string
header
requis

L'en-tête Authorization requiert un jeton Bearer. Utilisez une clé d'API administrateur. Il s'agit d'une clé secrète côté serveur. Générez-en une depuis la page des clés d'API de votre Dashboard.

Paramètres de chemin

projectId
string
requis

L'ID de votre projet. Copiez-le depuis la page API keys de votre tableau de bord.

Corps

application/json
prompt
string
requis

Instructions pour Autopilot, comme ce qui a changé et ce qu'il faut mettre à jour dans votre documentation.

Maximum string length: 20000

Réponse

Exécution d'Autopilot mise en file d'attente avec succès.

success
boolean

Toujours true lorsque l'exécution est en file d'attente.

runId
string

L'ID de l'exécution d'Autopilot mise en file d'attente.