Skip to main content
La exportación estática está en beta privada y requiere un acuerdo empresarial. Contacta con sales@mintlify.com para más información.
Usa la API de exportación estática para prerenderizar tu sitio de forma programática en un conjunto autocontenido de archivos estáticos y descargar el resultado como un único paquete. El paquete exportado es HTML, CSS y JavaScript puros, sin dependencias en tiempo de ejecución, por lo que puedes alojarlo en cualquier almacenamiento de archivos estáticos o CDN.

URLs de página en paquetes estáticos

Las exportaciones estáticas usan URLs .html que coinciden con los archivos del paquete. Por ejemplo, /guides/getting-started se convierte en /guides/getting-started.html. Esto sucede de forma automática y no requiere configuración.
Las URLs canónicas y las del sitemap siguen sin extensión. CloudFront resuelve estas URLs automáticamente, pero otros hostings estáticos pueden requerir reglas de reescritura.

Cómo funciona la exportación estática

Una exportación estática se ejecuta como un trabajo asíncrono. Inicias el trabajo para un proyecto y luego consultas su estado hasta que el paquete esté listo para descargar.
1

Iniciar un trabajo de exportación estática

Llama a Iniciar trabajo de exportación estática con tu ID de proyecto. La API pone el trabajo en cola y devuelve un jobId.Una implementación solo puede tener un trabajo activo a la vez. Si ya hay un trabajo queued o running para la implementación, el endpoint devuelve 409. El endpoint está limitado a 10 inicios de trabajo por organización por hora.
2

Consultar el trabajo y descargar el paquete

Consulta Obtener estado del trabajo de exportación estática con el jobId hasta que status sea completed. La respuesta completada incluye bundleUrl, un enlace de S3 prefirmado con tiempo limitado al paquete, junto con sizeBytes y una marca de tiempo expiresAt.Descarga el paquete antes de expiresAt. Una vez que caduque, vuelve a llamar al endpoint de estado para obtener un bundleUrl nuevo. Los archivos de exportación subyacentes siguen siendo reutilizables. Solo el enlace tiene tiempo limitado.

Compatibilidad de funciones por tipo de despliegue

Las funciones disponibles dependen de cómo alojes tu despliegue. Los despliegues aislados (air-gapped) no tienen acceso saliente a la red, por lo que cualquier función que dependa de los servicios en la nube de Mintlify no está disponible. Las funciones etiquetadas como Configurable tienen distinta disponibilidad según la configuración de tu entorno.

Endpoints

Autenticación

Autentica las solicitudes con tu clave de API de administrador. Genera una clave de API de administrador en la página de claves de API de tu panel. Las claves de API de administrador comienzan con el prefijo mint_ y son secretos del lado del servidor: no las expongas en código del lado del cliente. Copia tu ID de proyecto desde la misma página y úsalo como el parámetro de ruta projectId.

Desplegar el paquete en tu Helm chart de Enterprise

Mintlify autoalojado se implementa con el Helm chart del repositorio mintlify/enterprise. Una vez que un trabajo de exportación estática se completa, apuntas el chart al bundleUrl y el despliegue lo sirve desde tu propia infraestructura.
1

Añade la referencia al paquete en tus values

Configura los campos de exportación estática en tu values.yaml con el bundleUrl devuelto por Obtener estado del trabajo de exportación estática. El chart descarga el paquete al iniciarse y lo sirve como la versión activa.
values.yaml
2

Despliega el chart

Aplica los values actualizados con helm upgrade. El despliegue descarga el paquete, lo intercambia como el sitio en vivo y lo sirve desde tu clúster.
Dado que los enlaces prefirmados expiran, vuelve a consultar el estado del trabajo y a ejecutar la actualización siempre que publiques contenido nuevo, o automatiza el ciclo con GitHub Actions.

Automatizar con una GitHub Action

La siguiente plantilla de workflow ejecuta todo el ciclo de exportación de forma programada o bajo demanda. Inicia un trabajo, espera hasta que la exportación se complete y despliega el nuevo bundleUrl en el Helm chart.
.github/workflows/static-export.yml
Guarda tu clave de API de administrador como el secret de repositorio MINTLIFY_ADMIN_KEY y establece PROJECT_ID con el ID de tu proyecto. Antes de desplegar, configura las credenciales del clúster, por ejemplo con azure/setup-helm y tu archivo de configuración de Kubernetes (kubeconfig).