Saltar al contenido principal
POST
Activar webhook de Autopilot
Usa este endpoint para iniciar una ejecución de Autopilot desde tus propias herramientas. Cada solicitud pone en cola una ejecución que sigue el prompt del cuerpo de la solicitud, con el mismo contexto, las mismas habilidades y la misma configuración de revisión que las demás ejecuciones de Autopilot. Autopilot debe estar habilitado para el proyecto.

Casos de uso

  • Scripts de publicación: Indica a Autopilot qué se publicó cuando creas una etiqueta o publicas una nueva versión de un SDK.
  • Pipelines CI/CD: Pide a Autopilot que revise la documentación después de un despliegue o de una fusión a main.
  • Herramientas internas: Envía solicitudes de documentación desde dashboards internos, herramientas de soporte o tareas programadas que ya ejecutas.

Obtén la URL del webhook y el encabezado de autenticación

Abre la página Autopilot de tu dashboard. La sección Webhook muestra la URL completa del webhook y una acción Copy auth header para la plantilla del encabezado Authorization: Bearer <api-key>. Sustituye <api-key> por una clave de API de organización sin caducar con acceso de escritura. Crea o gestiona claves en la página API keys.

Ejemplo

Pide a Autopilot que documente cada publicación desde una GitHub Action:
.github/workflows/autopilot-release.yml

Qué ocurre después de una solicitud

Autopilot trabaja en el prompt como en cualquier otra ejecución. Cuando abre o actualiza una solicitud de extracción, asigna revisores y notifica a tu equipo de la misma forma que lo hace con los cambios de código. Cada ejecución aparece como su propio hilo en la página de Autopilot. Si Autopilot está en pausa, la ejecución espera hasta que reanudes Autopilot.

Límites de tasa y créditos

Este endpoint comparte un límite de tasa con Trigger update, Activar automatización y Activar webhook de automatización: hasta 10 solicitudes cada 10 segundos por organización. Una ejecución cuesta 250 créditos cuando abre o actualiza una solicitud de extracción. Consulta Créditos de Autopilot.

Autorizaciones

Authorization
string
header
requerido

El encabezado Authorization requiere un token de tipo Bearer. Usa una clave de API de administrador. Esta es una clave secreta del lado del servidor. Genera una en la página de claves de API de tu dashboard.

Parámetros de ruta

projectId
string
requerido

El ID de tu proyecto. Cópialo desde la página API keys de tu dashboard.

Cuerpo

application/json
prompt
string
requerido

Instrucciones para Autopilot, como qué cambió y qué actualizar en tu documentación.

Maximum string length: 20000

Respuesta

La ejecución de Autopilot se puso en cola correctamente.

success
boolean

Siempre es true cuando la ejecución está en cola.

runId
string

El ID de la ejecución de Autopilot en cola.