Passer au contenu principal
POST
/
project
/
preview
/
{projectId}
Déclencher un déploiement de prévisualisation
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>"
}
Les déploiements de prévisualisation sont disponibles avec les offres Pro et Enterprise.
Utilisez cet endpoint pour créer ou mettre à jour de manière programmatique un déploiement de prévisualisation pour une branche Git. Si une prévisualisation existe déjà pour la branche spécifiée, l’endpoint déclenche un redéploiement au lieu de créer un doublon. La réponse inclut un statusId que vous pouvez transmettre à Get deployment status pour suivre la progression du déploiement.

​
Cas d’utilisation

  • Pipelines CI/CD : Créez automatiquement des déploiements de prévisualisation lorsque des pull requests sont ouvertes ou mises à jour.
  • Prévisualisations planifiées : Générez des prévisualisations de branches de fonctionnalités de longue durée selon un calendrier.
  • Outillage personnalisé : Intégrez la création de prévisualisations dans des workflows internes ou des bots Slack.

​
Limites de débit

Cet endpoint autorise jusqu’à 5 requêtes par minute et par organisation.

Autorisations

​
Authorization
string
header
requis

L’en-tête Authorization requiert un jeton Bearer. Utilisez une clé d’API administrateur (préfixée par mint_). Il s’agit d’une clé secrète utilisée côté serveur. Générez-en une depuis la page API keys de votre Dashboard.

Paramètres de chemin

​
projectId
string
requis

Identifiant de votre projet. Vous pouvez le copier à partir de la page API keys de votre Dashboard.

Corps

application/json
​
branch
string
requis

Le nom de la branche Git pour laquelle créer un déploiement de prévisualisation.

Minimum string length: 1

Réponse

Déploiement de prévisualisation mis en file d'attente avec succès.

​
statusId
string

L'identifiant de statut pour suivre le déploiement de prévisualisation. Utilisez-le avec l'endpoint Get deployment status.

​
previewUrl
string

L'URL à laquelle le déploiement de prévisualisation est hébergé.