Saltar al contenido principal
POST
/
project
/
preview
/
{projectId}
Iniciar despliegue 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>"
}

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 para la cual crear un despliegue de vista previa.

Minimum string length: 1

Respuesta

Despliegue de vista previa puesto en cola correctamente

​
statusId
string

El ID de estado del despliegue de vista previa activado. Úsalo con el endpoint Obtener el estado del despliegue para consultar el progreso.

​
previewUrl
string

La URL donde se podrá acceder al despliegue de vista previa.