Caricamento in corso...
Caricamento in corso...
Last synced: Today, 22:00
Technical reference for the OpenClaw framework. Real-time synchronization with the official documentation engine.
Use this file to discover all available pages before exploring further.
OpenClaw ships a bundled
comfysizeaspectRatioresolutiondurationSeconds| Property | Detail |
|---|---|
| Provider | text comfy |
| Models | text comfy/workflow |
| Shared surfaces | text image_generatetext video_generatetext music_generate |
| Auth | None for local ComfyUI; text COMFY_API_KEYtext COMFY_CLOUD_API_KEY |
| API | ComfyUI text /prompttext /historytext /viewtext /api/* |
music_generateChoose between running ComfyUI on your own machine or using Comfy Cloud.
text<Steps> <Step title="Start ComfyUI locally"> Make sure your local ComfyUI instance is running (defaults to `http://127.0.0.1:8188`). </Step> <Step title="Prepare your workflow JSON"> Export or create a ComfyUI workflow JSON file. Note the node IDs for the prompt input node and the output node you want OpenClaw to read from. </Step> <Step title="Configure the provider"> Set `mode: "local"` and point at your workflow file. Here is a minimal image example: ```json5} { plugins: { entries: { comfy: { config: { mode: "local", baseUrl: "http://127.0.0.1:8188", image: { workflowPath: "./workflows/flux-api.json", promptNodeId: "6", outputNodeId: "9", }, }, }, }, }, } ``` </Step> <Step title="Set the default model"> Point OpenClaw at the `comfy/workflow` model for the capability you configured: ```json5} { agents: { defaults: { imageGenerationModel: { primary: "comfy/workflow", }, }, }, } ``` </Step> <Step title="Verify"> ```bash} openclaw models list --provider comfy ``` </Step> </Steps>
text<Steps> <Step title="Get an API key"> Sign up at [comfy.org](https://comfy.org) and generate an API key from your account dashboard. </Step> <Step title="Set the API key"> Provide your key through one of these methods: ```bash} # Environment variable (preferred) export COMFY_API_KEY="your-key" # Alternative environment variable export COMFY_CLOUD_API_KEY="your-key" # Or inline in config openclaw config set plugins.entries.comfy.config.apiKey "your-key" ``` </Step> <Step title="Prepare your workflow JSON"> Export or create a ComfyUI workflow JSON file. Note the node IDs for the prompt input node and the output node. </Step> <Step title="Configure the provider"> Set `mode: "cloud"` and point at your workflow file: ```json5} { plugins: { entries: { comfy: { config: { mode: "cloud", image: { workflowPath: "./workflows/flux-api.json", promptNodeId: "6", outputNodeId: "9", }, }, }, }, }, } ``` <Tip> Cloud mode defaults `baseUrl` to `https://cloud.comfy.org`. You only need to set `baseUrl` if you use a custom cloud endpoint. </Tip> </Step> <Step title="Set the default model"> ```json5} { agents: { defaults: { imageGenerationModel: { primary: "comfy/workflow", }, }, }, } ``` </Step> <Step title="Verify"> ```bash} openclaw models list --provider comfy ``` </Step> </Steps>
Comfy supports shared top-level connection settings plus per-capability workflow sections (
imagevideomusicjson5{ 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", }, }, }, }, }, }
| Key | Type | Description |
|---|---|---|
text mode | text "local"text "cloud" | Connection mode. |
text baseUrl | string | Defaults to text http://127.0.0.1:8188text https://cloud.comfy.org |
text apiKey | string | Optional inline key, alternative to text COMFY_API_KEYtext COMFY_CLOUD_API_KEY |
text allowPrivateNetwork | boolean | Allow a private/LAN text baseUrl |
These keys apply inside the
imagevideomusic| Key | Required | Default | Description |
|---|---|---|---|
text workflowtext workflowPath | Yes | -- | Path to the ComfyUI workflow JSON file. |
text promptNodeId | Yes | -- | Node ID that receives the text prompt. |
text promptInputName | No | text "text" | Input name on the prompt node. |
text outputNodeId | No | -- | Node ID to read output from. If omitted, all matching output nodes are used. |
text pollIntervalMs | No | -- | Polling interval in milliseconds for job completion. |
text timeoutMs | No | -- | Timeout in milliseconds for the workflow run. |
The
imagevideo| Key | Required | Default | Description |
|---|---|---|---|
text inputImageNodeId | Yes (when passing a reference image) | -- | Node ID that receives the uploaded reference image. |
text inputImageInputName | No | text "image" | Input name on the image node. |
Image generation tool configuration and usage.
Video generation tool configuration and usage.
Music and audio generation tool setup.
Overview of all providers and model refs.
Full config reference including agent defaults.
© 2024 TaskFlow Mirror
Powered by TaskFlow Sync Engine