Saltar al contenido principal
POST
/
project
/
preview
/
{projectId}
Activar implementación de vista previa
curl --request POST \
  --url https://api.mintlify.com/v1/project/preview/{projectId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "branch": "<string>"
}
'
{
  "statusId": "<string>",
  "previewUrl": "<string>"
}
Las implementaciones de vista previa están disponibles en los planes Pro y Enterprise.
Usa este endpoint para crear o actualizar de forma programática una implementación de vista previa para una rama de Git. Si ya existe una vista previa para la rama especificada, el endpoint activa una reimplementación en lugar de crear un duplicado. La respuesta incluye un statusId que puedes pasar a Get deployment status para rastrear el progreso de la implementación.

​
Casos de uso

  • Pipelines CI/CD: Crea automáticamente implementaciones de vista previa cuando se abren o actualizan solicitudes de extracción.
  • Vistas previas programadas: Genera vistas previas de ramas de funcionalidades de larga duración de forma programada.
  • Herramientas personalizadas: Integra la creación de vistas previas en flujos de trabajo internos o bots de Slack.

​
Límites de tasa

Este endpoint permite hasta 5 solicitudes por minuto por organización.

Autorizaciones

​
Authorization
string
header
requerido

El encabezado Authorization espera un token de tipo Bearer. Usa una clave de API de administrador (con el prefijo mint_). 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. Puedes copiarlo de la página de API keys de tu dashboard.

Cuerpo

application/json
​
branch
string
requerido

El nombre de la rama de Git para la cual crear una implementación de vista previa.

Minimum string length: 1

Respuesta

Implementación de vista previa puesta en cola correctamente.

​
statusId
string

El ID de estado para hacer seguimiento de la implementación de vista previa. Úsalo con el endpoint Get deployment status.

​
previewUrl
string

La URL donde se aloja la implementación de vista previa.