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

Providers

ComfyUI

O OpenClaw inclui um plugin comfy integrado para execuções do ComfyUI orientadas por fluxos de trabalho. O plugin é totalmente orientado por fluxos de trabalho: o OpenClaw não mapeia controles genéricos de size, aspectRatio, resolution, durationSeconds ou semelhantes aos de TTS para o seu grafo.

Propriedade Detalhes
Provedor comfy
Modelo comfy/workflow
Ferramentas comuns image_generate, video_generate, music_generate
Autenticação Nenhuma para o ComfyUI local; COMFY_API_KEY ou COMFY_CLOUD_API_KEY para o Comfy Cloud
API ComfyUI /prompt / /history / /view; Comfy Cloud /api/*

O que é compatível

  • Geração e edição de imagens a partir de um JSON de fluxo de trabalho (a edição aceita 1 imagem de referência enviada)
  • Geração de vídeo a partir de um JSON de fluxo de trabalho, de texto para vídeo ou de imagem para vídeo (1 imagem de referência)
  • Geração de música/áudio por meio da ferramenta compartilhada music_generate, com 1 imagem de referência opcional
  • Download da saída de um Node configurado ou de todos os Nodes de saída correspondentes quando nenhum estiver configurado

Primeiros passos

Escolha entre executar o ComfyUI na sua própria máquina ou usar o Comfy Cloud.

Local

Ideal para: executar sua própria instância do ComfyUI na sua máquina ou LAN.

  • Inicie o ComfyUI localmente

    Certifique-se de que sua instância local do ComfyUI esteja em execução (o padrão é http://127.0.0.1:8188).

  • Prepare o JSON do fluxo de trabalho

    Exporte ou crie um arquivo JSON de fluxo de trabalho do ComfyUI. Anote os IDs dos Nodes referentes ao Node de entrada do prompt e ao Node de saída que você deseja que o OpenClaw leia.

  • Configure o provedor

    Defina mode: "local" e indique o arquivo do seu fluxo de trabalho. Exemplo mínimo para imagens:

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

  • Defina o modelo padrão

    Aponte o OpenClaw para o modelo comfy/workflow na funcionalidade que você configurou:

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

  • Verifique

    bash
    openclaw models list --provider comfy

    • Comfy Cloud

    Ideal para: executar fluxos de trabalho no Comfy Cloud sem gerenciar recursos locais de GPU.

  • Obtenha uma chave de API

    Cadastre-se em comfy.org e gere uma chave de API no painel da sua conta.

  • Defina a chave de API

    Forneça sua chave usando qualquer um destes métodos:

    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 o JSON do fluxo de trabalho

    Exporte ou crie um arquivo JSON de fluxo de trabalho do ComfyUI. Anote os IDs dos Nodes referentes ao Node de entrada do prompt e ao Node de saída.

  • Configure o provedor

    Defina mode: "cloud" e indique o arquivo do seu fluxo de trabalho:

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

  • Defina o modelo padrão

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

  • Verifique

    bash
    openclaw models list --provider comfy

    • Configuração

    O Comfy aceita configurações de conexão compartilhadas no nível superior e seções de fluxo de trabalho por funcionalidade (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",          },        },      },    },  },}

    Chaves compartilhadas

    Chave Tipo Descrição
    mode "local" ou "cloud" Modo de conexão. O padrão é "local".
    baseUrl string O padrão é http://127.0.0.1:8188 para o modo local ou https://cloud.comfy.org para o modo de nuvem.
    apiKey string Chave embutida opcional, alternativa às variáveis de ambiente COMFY_API_KEY / COMFY_CLOUD_API_KEY.
    allowPrivateNetwork boolean Permite uma baseUrl privada/LAN no modo de nuvem ou um FQDN de DNS privado local.

    Chaves por funcionalidade

    Estas chaves são aplicadas nas seções image, video ou music:

    Chave Obrigatória Padrão Descrição
    workflow ou workflowPath Sim -- JSON embutido do fluxo de trabalho ou caminho para o arquivo JSON de fluxo de trabalho do ComfyUI.
    promptNodeId Sim -- ID do Node que recebe o prompt de texto.
    promptInputName Não "text" Nome da entrada no Node do prompt.
    outputNodeId Não -- ID do Node do qual a saída será lida. Se omitido, todos os Nodes de saída correspondentes serão usados.
    pollIntervalMs Não 1500 Intervalo de consulta, em milissegundos, para a conclusão do trabalho.
    timeoutMs Não 300000 Tempo limite, em milissegundos, para a execução do fluxo de trabalho.

    As seções image e video também aceitam um Node de entrada para a imagem de referência:

    Chave Obrigatória Padrão Descrição
    inputImageNodeId Sim (ao fornecer uma imagem de referência) -- ID do Node que recebe a imagem de referência enviada.
    inputImageInputName Não "image" Nome da entrada no Node da imagem.

    apiKey aceita uma string literal ou um objeto de referência de segredo.

    Detalhes do fluxo de trabalho

    Fluxos de trabalho de imagem

    Defina o modelo de imagem padrão como comfy/workflow:

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

    Exemplo de edição com imagem de referência:

    Para habilitar a edição de imagens com uma imagem de referência enviada, adicione inputImageNodeId à configuração de imagem:

    json5
    {  plugins: {    entries: {      comfy: {        config: {          image: {            workflowPath: "./workflows/edit-api.json",            promptNodeId: "6",            inputImageNodeId: "7",            inputImageInputName: "image",            outputNodeId: "9",          },        },      },    },  },}
    Fluxos de trabalho de vídeo

    Defina o modelo de vídeo padrão como comfy/workflow:

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

    Os fluxos de trabalho de vídeo do Comfy são compatíveis com texto para vídeo e imagem para vídeo por meio do grafo configurado.

    Fluxos de trabalho de música

    O plugin integrado registra um provedor de geração de música para saídas de áudio ou música definidas pelo fluxo de trabalho, disponibilizado por meio da ferramenta compartilhada music_generate. Ele aceita uma imagem de referência opcional (até 1):

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

    Use a seção de configuração music para indicar o JSON do seu fluxo de trabalho de áudio e o Node de saída.

    Compatibilidade com versões anteriores

    A configuração de imagem existente no nível superior (sem a seção image aninhada) continua funcionando:

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

    O OpenClaw trata esse formato legado como a configuração do fluxo de trabalho de imagem. Não é necessário migrar imediatamente, mas as seções aninhadas image / video / music são recomendadas para novas configurações. Se você usa somente a geração de imagens, a configuração plana legada e a nova seção image aninhada são funcionalmente equivalentes.

    Testes em tempo real

    Há cobertura opcional de testes em tempo real para o plugin integrado:

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

    O teste em ambiente real ignora casos individuais de imagem, vídeo ou música, a menos que a seção correspondente do fluxo de trabalho do Comfy esteja configurada.

    Relacionado

    Geração de imagens

    Configuração e uso da ferramenta de geração de imagens.
    Geração de vídeos

    Configuração e uso da ferramenta de geração de vídeos.
    Geração de música

    Configuração da ferramenta de geração de música e áudio.
    Diretório de provedores

    Visão geral de todos os provedores e referências de modelos.
    Referência de configuração

    Referência completa da configuração, incluindo os padrões dos agentes.
    Was this useful?
    On this page

    On this page