OpenClawDocs
View as MarkdownView this page as plain textOpen in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this page

Providers

ComfyUI

OpenClaw enthält ein gebündeltes comfy-Plugin für workflowgesteuerte ComfyUI-Ausführungen. Das Plugin wird vollständig durch Workflows gesteuert: OpenClaw bildet generische Einstellungen wie size, aspectRatio, resolution, durationSeconds oder TTS-ähnliche Steuerelemente nicht auf Ihren Graphen ab.

Eigenschaft Details
Provider comfy
Modell comfy/workflow
Gemeinsame Tools image_generate, video_generate, music_generate
Authentifizierung Keine für lokales ComfyUI; COMFY_API_KEY oder COMFY_CLOUD_API_KEY für Comfy Cloud
API ComfyUI /prompt / /history / /view; Comfy Cloud /api/*

Unterstützte Funktionen

  • Bildgenerierung und -bearbeitung anhand einer Workflow-JSON-Datei (für die Bearbeitung ist 1 hochgeladenes Referenzbild erforderlich)
  • Videogenerierung anhand einer Workflow-JSON-Datei, Text-zu-Video oder Bild-zu-Video (1 Referenzbild)
  • Musik-/Audiogenerierung über das gemeinsame Tool music_generate mit optional 1 Referenzbild
  • Herunterladen der Ausgabe von einer konfigurierten Node oder von allen passenden Ausgabe-Nodes, wenn keine konfiguriert ist

Erste Schritte

Wählen Sie zwischen der Ausführung von ComfyUI auf Ihrem eigenen Computer und der Verwendung von Comfy Cloud.

Lokal

Am besten geeignet für: die Ausführung Ihrer eigenen ComfyUI-Instanz auf Ihrem Computer oder im LAN.

  • ComfyUI lokal starten

    Stellen Sie sicher, dass Ihre lokale ComfyUI-Instanz ausgeführt wird (Standard: http://127.0.0.1:8188).

  • Workflow-JSON vorbereiten

    Exportieren oder erstellen Sie eine ComfyUI-Workflow-JSON-Datei. Notieren Sie die Node-IDs der Prompt-Eingabe-Node und der Ausgabe-Node, aus der OpenClaw lesen soll.

  • Provider konfigurieren

    Legen Sie mode: "local" fest und verweisen Sie auf Ihre Workflow-Datei. Minimales Bildbeispiel:

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

  • Standardmodell festlegen

    Verweisen Sie OpenClaw für die konfigurierte Funktion auf das Modell comfy/workflow:

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

  • Überprüfen

    bash
    openclaw models list --provider comfy

    • Comfy Cloud

    Am besten geeignet für: die Ausführung von Workflows in Comfy Cloud, ohne lokale GPU-Ressourcen verwalten zu müssen.

  • API-Schlüssel abrufen

    Registrieren Sie sich unter comfy.org und erzeugen Sie über Ihr Konto-Dashboard einen API-Schlüssel.

  • API-Schlüssel festlegen

    Stellen Sie Ihren Schlüssel mit einer der folgenden Methoden bereit:

    bash
    # Onboarding-Flagopenclaw onboard --comfy-api-key "your-key" # Umgebungsvariable (für Daemons bevorzugt)export COMFY_API_KEY="your-key" # Alternative Umgebungsvariableexport COMFY_CLOUD_API_KEY="your-key" # Oder direkt in der Konfigurationopenclaw config set plugins.entries.comfy.config.apiKey "your-key"

  • Workflow-JSON vorbereiten

    Exportieren oder erstellen Sie eine ComfyUI-Workflow-JSON-Datei. Notieren Sie die Node-IDs der Prompt-Eingabe-Node und der Ausgabe-Node.

  • Provider konfigurieren

    Legen Sie mode: "cloud" fest und verweisen Sie auf Ihre Workflow-Datei:

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

  • Standardmodell festlegen

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

  • Überprüfen

    bash
    openclaw models list --provider comfy

    • Konfiguration

    Comfy unterstützt gemeinsame Verbindungseinstellungen auf oberster Ebene sowie Workflow-Abschnitte für einzelne Funktionen (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",          },        },      },    },  },}

    Gemeinsame Schlüssel

    Schlüssel Typ Beschreibung
    mode "local" oder "cloud" Verbindungsmodus. Standardmäßig "local".
    baseUrl Zeichenfolge Standardmäßig http://127.0.0.1:8188 für lokal oder https://cloud.comfy.org für die Cloud.
    apiKey Zeichenfolge Optionaler direkt angegebener Schlüssel, alternativ zu den Umgebungsvariablen COMFY_API_KEY / COMFY_CLOUD_API_KEY.
    allowPrivateNetwork boolesch Erlaubt eine private/LAN-baseUrl im Cloud-Modus oder einen lokalen privaten DNS-FQDN.

    Funktionsspezifische Schlüssel

    Diese Schlüssel gelten innerhalb der Abschnitte image, video oder music:

    Schlüssel Erforderlich Standard Beschreibung
    workflow oder workflowPath Ja -- Direkt angegebene Workflow-JSON oder Pfad zur ComfyUI-Workflow-JSON-Datei.
    promptNodeId Ja -- Node-ID, die den Text-Prompt empfängt.
    promptInputName Nein "text" Eingabename an der Prompt-Node.
    outputNodeId Nein -- Node-ID, von der die Ausgabe gelesen wird. Bei Auslassung werden alle passenden Ausgabe-Nodes verwendet.
    pollIntervalMs Nein 1500 Abfrageintervall in Millisekunden für den Abschluss des Auftrags.
    timeoutMs Nein 300000 Zeitüberschreitung in Millisekunden für die Workflow-Ausführung.

    Die Abschnitte image und video unterstützen außerdem eine Eingabe-Node für Referenzbilder:

    Schlüssel Erforderlich Standard Beschreibung
    inputImageNodeId Ja (bei Übergabe eines Referenzbildes) -- Node-ID, die das hochgeladene Referenzbild empfängt.
    inputImageInputName Nein "image" Eingabename an der Bild-Node.

    apiKey akzeptiert entweder eine literale Zeichenfolge oder ein Secret-Referenzobjekt.

    Workflow-Details

    Bild-Workflows

    Legen Sie das Standardbildmodell auf comfy/workflow fest:

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

    Beispiel für die Bearbeitung mit Referenzbild:

    Um die Bildbearbeitung mit einem hochgeladenen Referenzbild zu aktivieren, fügen Sie Ihrer Bildkonfiguration inputImageNodeId hinzu:

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

    Legen Sie das Standardvideomodell auf comfy/workflow fest:

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

    Comfy-Video-Workflows unterstützen Text-zu-Video und Bild-zu-Video über den konfigurierten Graphen.

    Musik-Workflows

    Das gebündelte Plugin registriert einen Provider zur Musikgenerierung für workflowdefinierte Audio- oder Musikausgaben, der über das gemeinsame Tool music_generate verfügbar ist. Es akzeptiert ein optionales Referenzbild (bis zu 1):

    text
    /tool music_generate prompt="Warmer Ambient-Synthesizer-Loop mit sanfter Bandtextur"

    Verwenden Sie den Konfigurationsabschnitt music, um auf Ihre Audio-Workflow-JSON und die Ausgabe-Node zu verweisen.

    Abwärtskompatibilität

    Die vorhandene Bildkonfiguration auf oberster Ebene (ohne den verschachtelten Abschnitt image) funktioniert weiterhin:

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

    OpenClaw behandelt diese Legacy-Struktur als Bild-Workflow-Konfiguration. Sie müssen nicht sofort migrieren, für neue Einrichtungen werden jedoch die verschachtelten Abschnitte image / video / music empfohlen. Wenn Sie ausschließlich die Bildgenerierung verwenden, sind die flache Legacy-Konfiguration und der neue verschachtelte Abschnitt image funktional gleichwertig.

    Live-Tests

    Für das gebündelte Plugin ist eine optionale Live-Testabdeckung verfügbar:

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

    Der Live-Test überspringt einzelne Bild-, Video- oder Musikfälle, sofern der entsprechende Abschnitt des Comfy-Workflows nicht konfiguriert ist.

    Verwandte Themen

    Bildgenerierung

    Konfiguration und Verwendung des Bildgenerierungs-Tools.
    Videogenerierung

    Konfiguration und Verwendung des Videogenerierungs-Tools.
    Musikgenerierung

    Einrichtung des Tools zur Musik- und Audiogenerierung.
    Provider-Verzeichnis

    Übersicht über alle Provider und Modellreferenzen.
    Konfigurationsreferenz

    Vollständige Konfigurationsreferenz einschließlich der Agent-Standardeinstellungen.
    Was this useful?
    On this page

    On this page