Providers

ComfyUI

OpenClaw inclut un Plugin comfy intégré pour exécuter des workflows ComfyUI. Le Plugin repose entièrement sur les workflows : OpenClaw ne transpose pas de contrôles génériques tels que size, aspectRatio, resolution, durationSeconds ou des contrôles de type TTS dans votre graphe.

Propriété Détail
Fournisseur comfy
Modèle comfy/workflow
Outils partagés image_generate, video_generate, music_generate
Authentification Aucune pour ComfyUI local ; COMFY_API_KEY ou COMFY_CLOUD_API_KEY pour Comfy Cloud
API ComfyUI /prompt / /history / /view ; Comfy Cloud /api/*

Fonctionnalités prises en charge

  • Génération et modification d’images à partir d’un workflow JSON (la modification accepte 1 image de référence téléversée)
  • Génération de vidéos à partir d’un workflow JSON, de texte en vidéo ou d’image en vidéo (1 image de référence)
  • Génération de musique ou d’audio au moyen de l’outil partagé music_generate, avec 1 image de référence facultative
  • Téléchargement de la sortie depuis un Node configuré, ou depuis tous les Nodes de sortie correspondants lorsqu’aucun n’est configuré

Prise en main

Choisissez entre l’exécution de ComfyUI sur votre propre machine et l’utilisation de Comfy Cloud.

Local

Idéal pour : exécuter votre propre instance ComfyUI sur votre machine ou votre réseau local.

  • Start ComfyUI locally

    Vérifiez que votre instance ComfyUI locale est en cours d’exécution (adresse par défaut : http://127.0.0.1:8188).

  • Prepare your workflow JSON

    Exportez ou créez un fichier JSON de workflow ComfyUI. Notez les identifiants des Nodes correspondant au Node d’entrée de l’invite et au Node de sortie depuis lequel OpenClaw doit lire.

  • Configure the provider

    Définissez mode: "local" et indiquez le chemin de votre fichier de workflow. Exemple minimal pour les images :

    json5
    {  plugins: {    entries: {      comfy: {        config: {          mode: "local",          baseUrl: "http://127.0.0.1:8188",          image: {            workflowPath: "./workflows/flux-api.json",            promptNodeId: "6",            outputNodeId: "9",          },        },      },    },  },}
  • Set the default model

    Configurez OpenClaw pour utiliser le modèle comfy/workflow pour la fonctionnalité que vous avez configurée :

    json5
    {  agents: {    defaults: {      imageGenerationModel: {        primary: "comfy/workflow",      },    },  },}
  • Verify

    bash
    openclaw models list --provider comfy
  • Comfy Cloud

    Idéal pour : exécuter des workflows sur Comfy Cloud sans gérer de ressources GPU locales.

  • Get an API key

    Inscrivez-vous sur comfy.org et générez une clé API depuis le tableau de bord de votre compte.

  • Set the API key

    Fournissez votre clé à l’aide de l’une des méthodes suivantes :

    bash
    # Onboarding flagopenclaw onboard --comfy-api-key "your-key" # Environment variable (preferred for daemons)export COMFY_API_KEY="your-key" # Alternative environment variableexport COMFY_CLOUD_API_KEY="your-key" # Or inline in configopenclaw config set plugins.entries.comfy.config.apiKey "your-key"
  • Prepare your workflow JSON

    Exportez ou créez un fichier JSON de workflow ComfyUI. Notez les identifiants des Nodes correspondant au Node d’entrée de l’invite et au Node de sortie.

  • Configure the provider

    Définissez mode: "cloud" et indiquez le chemin de votre fichier de workflow :

    json5
    {  plugins: {    entries: {      comfy: {        config: {          mode: "cloud",          image: {            workflowPath: "./workflows/flux-api.json",            promptNodeId: "6",            outputNodeId: "9",          },        },      },    },  },}
  • Set the default model

    json5
    {  agents: {    defaults: {      imageGenerationModel: {        primary: "comfy/workflow",      },    },  },}
  • Verify

    bash
    openclaw models list --provider comfy
  • Configuration

    Comfy prend en charge des paramètres de connexion partagés au niveau supérieur ainsi que des sections de workflow propres à chaque fonctionnalité (image, video, music) :

    json5
    {  plugins: {    entries: {      comfy: {        config: {          mode: "local",          baseUrl: "http://127.0.0.1:8188",          image: {            workflowPath: "./workflows/flux-api.json",            promptNodeId: "6",            outputNodeId: "9",          },          video: {            workflowPath: "./workflows/video-api.json",            promptNodeId: "12",            outputNodeId: "21",          },          music: {            workflowPath: "./workflows/music-api.json",            promptNodeId: "3",            outputNodeId: "18",          },        },      },    },  },}

    Clés partagées

    Clé Type Description
    mode "local" ou "cloud" Mode de connexion. Valeur par défaut : "local".
    baseUrl chaîne Valeur par défaut : http://127.0.0.1:8188 en local ou https://cloud.comfy.org dans le cloud.
    apiKey chaîne Clé intégrée facultative, en remplacement des variables d’environnement COMFY_API_KEY / COMFY_CLOUD_API_KEY.
    allowPrivateNetwork booléen Autorise une baseUrl privée ou sur le réseau local en mode cloud, ou un nom de domaine complet DNS privé local.

    Clés propres à chaque fonctionnalité

    Ces clés s’appliquent dans les sections image, video ou music :

    Clé Obligatoire Valeur par défaut Description
    workflow ou workflowPath Oui -- Workflow JSON intégré ou chemin du fichier JSON de workflow ComfyUI.
    promptNodeId Oui -- Identifiant du Node qui reçoit l’invite textuelle.
    promptInputName Non "text" Nom de l’entrée sur le Node d’invite.
    outputNodeId Non -- Identifiant du Node depuis lequel lire la sortie. S’il est omis, tous les Nodes de sortie correspondants sont utilisés.
    pollIntervalMs Non 1500 Intervalle d’interrogation en millisecondes pour vérifier l’achèvement de la tâche.
    timeoutMs Non 300000 Délai d’expiration en millisecondes pour l’exécution du workflow.

    Les sections image et video prennent également en charge un Node d’entrée pour l’image de référence :

    Clé Obligatoire Valeur par défaut Description
    inputImageNodeId Oui (lorsqu’une image de référence est transmise) -- Identifiant du Node qui reçoit l’image de référence téléversée.
    inputImageInputName Non "image" Nom de l’entrée sur le Node d’image.

    apiKey accepte soit une chaîne littérale, soit un objet de référence de secret.

    Détails des workflows

    Image workflows

    Définissez le modèle d’image par défaut sur comfy/workflow :

    json5
    {  agents: {    defaults: {      imageGenerationModel: {        primary: "comfy/workflow",      },    },  },}

    Exemple de modification avec une image de référence :

    Pour permettre la modification d’une image à l’aide d’une image de référence téléversée, ajoutez inputImageNodeId à votre configuration d’image :

    json5
    {  plugins: {    entries: {      comfy: {        config: {          image: {            workflowPath: "./workflows/edit-api.json",            promptNodeId: "6",            inputImageNodeId: "7",            inputImageInputName: "image",            outputNodeId: "9",          },        },      },    },  },}
    Video workflows

    Définissez le modèle vidéo par défaut sur comfy/workflow :

    json5
    {  agents: {    defaults: {      videoGenerationModel: {        primary: "comfy/workflow",      },    },  },}

    Les workflows vidéo Comfy prennent en charge la génération de texte en vidéo et d’image en vidéo au moyen du graphe configuré.

    Music workflows

    Le Plugin intégré enregistre un fournisseur de génération musicale pour les sorties audio ou musicales définies par un workflow, accessible au moyen de l’outil partagé music_generate. Il accepte une image de référence facultative (1 au maximum) :

    text
    /tool music_generate prompt="Warm ambient synth loop with soft tape texture"

    Utilisez la section de configuration music pour indiquer le fichier JSON de votre workflow audio et le Node de sortie.

    Backward compatibility

    La configuration d’image existante au niveau supérieur (sans section image imbriquée) continue de fonctionner :

    json5
    {  plugins: {    entries: {      comfy: {        config: {          workflowPath: "./workflows/flux-api.json",          promptNodeId: "6",          outputNodeId: "9",        },      },    },  },}

    OpenClaw traite cette ancienne structure comme la configuration du workflow d’image. Vous n’avez pas besoin d’effectuer une migration immédiatement, mais les sections imbriquées image / video / music sont recommandées pour les nouvelles installations. Si vous utilisez uniquement la génération d’images, l’ancienne configuration à plat et la nouvelle section image imbriquée sont fonctionnellement équivalentes.

    Live tests

    Une couverture de tests en conditions réelles, activable explicitement, est disponible pour le Plugin intégré :

    bash
    OPENCLAW_LIVE_TEST=1 COMFY_LIVE_TEST=1 pnpm test:live -- extensions/comfy/comfy.live.test.ts

    Le test en conditions réelles ignore les cas individuels d’image, de vidéo ou de musique, sauf si la section correspondante du flux de travail Comfy est configurée.

    Pages connexes

    Was this useful?
    On this page

    On this page