Passer au contenu principal
POST
/
workflow
/
{projectId}
/
{workflowSchemaId}
/
trigger
Déclencher une automatisation
curl --request POST \
  --url https://api.mintlify.com/v1/workflow/{projectId}/{workflowSchemaId}/trigger \
  --header 'Authorization: Bearer <token>'
{
  "schemaId": "<string>",
  "instanceId": "<string>",
  "jobId": "<string>"
}
Utilisez cet endpoint pour déclencher à la demande une automatisation planifiée, au lieu d’attendre sa prochaine exécution planifiée. L’automatisation se comporte exactement comme une exécution planifiée habituelle : elle récupère tout ce qui a changé depuis la dernière exécution terminée. Cet endpoint ne prend en charge que les automatisations configurées avec un déclencheur Calendrier personnalisé. Les requêtes pour des automatisations utilisant d’autres déclencheurs, comme Modification de code ou Mise à jour de contenu, renvoient une erreur 400.

​
Cas d’utilisation

  • Pipelines CI/CD : Exécutez l’automatisation Update from code changes à chaque fusion dans main, afin que la documentation soit mise à jour au rythme de vos versions plutôt que selon un calendrier fixe.
  • Événements de version : Exécutez l’automatisation Draft changelog lorsque vous créez un tag de version, afin que le changelog soit rédigé au moment même où la version est publiée.
  • Outillage personnalisé : Déclenchez des automatisations depuis vos outils internes, des commandes Slack ou des tâches planifiées que vous exécutez déjà.

​
Trouver vos identifiants

  • Identifiant d’automatisation (workflowSchemaId) : Copiez-le depuis le panneau de paramètres de l’automatisation sur la page Automations de votre dashboard.
  • Identifiant de projet (projectId) : Copiez-le depuis la page API keys de votre dashboard.

​
Vérifier le statut de l’exécution

Cet endpoint renvoie une réponse dès que l’exécution est mise en file d’attente et n’attend pas la fin de celle-ci. Pour suivre son avancement, consultez l’historique des exécutions de l’automatisation sur la page Automations de votre dashboard. Consultez Consulter l’historique des exécutions pour connaître les statuts par lesquels une exécution peut passer.

​
Exemple

Déclenchez une automatisation depuis une GitHub Action chaque fois que du code est fusionné dans main :
.github/workflows/trigger-docs.yml
on:
  push:
    branches: [main]

jobs:
  trigger:
    runs-on: ubuntu-latest
    steps:
      - run: |
          curl -fsS -X POST \
            "https://api.mintlify.com/v1/workflow/$PROJECT_ID/$WORKFLOW_ID/trigger" \
            -H "Authorization: Bearer ${{ secrets.MINTLIFY_API_KEY }}"
        env:
          PROJECT_ID: ${{ vars.MINTLIFY_PROJECT_ID }}
          WORKFLOW_ID: ${{ vars.MINTLIFY_WORKFLOW_ID }}

​
Limites de débit

Cet endpoint partage une limite de débit avec Trigger update : jusqu’à 10 requêtes par 10 secondes et par organisation. Les exécutions déclenchées consomment des crédits au même rythme que les exécutions planifiées.

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.

​
workflowSchemaId
string
requis

Identifiant de l'automatisation à déclencher. Vous pouvez le copier depuis le panneau de paramètres de l'automatisation sur la page Automations de votre dashboard.

Réponse

Exécution de l'automatisation mise en file d'attente avec succès.

​
schemaId
string

Identifiant de l'automatisation déclenchée.

​
instanceId
string

Identifiant de l'exécution d'automatisation mise en file d'attente. Apparaît dans l'historique des exécutions sur la page Automation Runs.

​
jobId
string

Identifiant de la tâche d'arrière-plan qui traite l'exécution.