Skip to content

Commit ea9cb27

Browse files
committed
Fix the image generation docs telling users things that are not true
Users configure ComfyUI correctly, then look for a "Generate Image" button under messages that was removed in v0.7.0, and conclude the integration is broken. The docs made this worse: the usage page claimed native function calling needs no per-chat toggle, when every mode requires it, and no page said what has to be true before an image can be generated at all. The usage page now lists the real preconditions (global setting, permission, model capability, per-chat Image toggle) and explains what Native and Legacy each do. The ComfyUI page says the button is gone and points there. The troubleshooting checklist gained the same checks. While in there, corrected what did not match the UI or the code: engine option strings, Base URL and API Key field labels, the Image Prompt Generation location and its Legacy-only scope, image editing being off by default with its own ComfyUI URL and key, the Gemini endpoint method, and the v0.6.44 button removal date.
1 parent 59a55bd commit ea9cb27

9 files changed

Lines changed: 81 additions & 75 deletions

File tree

docs/features/chat-conversations/image-generation-and-editing/automatic1111.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ docker run -d -p 3000:8080 --add-host=host.docker.internal:host-gateway -e AUTOM
2727
### Setting Up Open WebUI with AUTOMATIC1111
2828

2929
1. In Open WebUI, navigate to the **Settings** > **Admin** > **Experience** > **Images** menu.
30-
2. Set the `Image Generation Engine` field to `Default (Automatic1111)`.
31-
3. In the API URL field, enter the address where AUTOMATIC1111's API is accessible:
30+
2. Set the `Image Generation Engine` field to `Automatic1111`.
31+
3. In the `Base URL` field, enter the address where AUTOMATIC1111's API is accessible:
3232

33-
![Screenshot of the Open WebUI Images settings page with Default (Automatic1111) selected and the API URL field highlighted.](/images/image-generation-and-editing/automatic1111-settings.png)
33+
![Screenshot of the Open WebUI Images settings page configured for AUTOMATIC1111.](/images/image-generation-and-editing/automatic1111-settings.png)
3434

3535
```txt
3636
http://<your_automatic1111_address>:7860/

docs/features/chat-conversations/image-generation-and-editing/comfyui.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ Once you have ComfyUI installed and running, you can connect it to Open WebUI fr
4040

4141
## Image Prompt Generation
4242

43-
This feature uses a language model to automatically generate more detailed and creative prompts based on your initial input, which can lead to better image results.
43+
This feature uses a language model to automatically generate more detailed and creative prompts based on your initial input, which can lead to better image results. It only applies to Legacy function calling; in the default Native mode the model writes the prompt itself when it calls the tool.
4444

45-
The **Image Prompt Generation** toggle is located in **Settings > Admin > Experience > Images** under the "Image Generation" section, **before** selecting the image generation engine.
45+
The **Image Prompt Generation** toggle is located in the **Create Image** section of **Settings > Admin > Experience > Images**.
4646

47-
To customize the prompt template used for generation, go to **Settings > Admin > Experience > Interface > Tasks**.
47+
To customize the prompt template used for generation, go to **Settings > Admin > Experience > Interface**, in the **Generation** section.
4848

4949
![Screenshot showing the Image Prompt Generation toggle location in Images settings](/images/image-generation-and-editing/image-prompt-generation-toggle.png)
5050

@@ -58,9 +58,9 @@ To customize the prompt template used for generation, go to **Settings > Admin >
5858
- **Model**: Select the base model to be used for generating the image.
5959
- **Image Size**: Defines the resolution of the generated image (e.g., 512x512, 1024x1024).
6060
- **Steps**: The number of sampling steps; higher values can improve image quality but take longer to process.
61-
- In the **ComfyUI Base URL** field, enter the address of your running ComfyUI instance (e.g., `http://host.docker.internal:8188/`).
61+
- In the **Base URL** field, enter the address of your running ComfyUI instance (e.g., `http://host.docker.internal:8188/`).
6262
- Click the **refresh icon** (🔄) next to the URL field to verify the connection. A success message should appear.
63-
- If your ComfyUI instance requires an API key, enter it in the **ComfyUI API Key** field.
63+
- If your ComfyUI instance requires an API key, enter it in the **API Key** field.
6464

6565
![Screenshot of the Open WebUI Images settings page with ComfyUI selected for image generation.](/images/image-generation-and-editing/comfyui-generation-settings.png)
6666

@@ -112,17 +112,22 @@ To customize the prompt template used for generation, go to **Settings > Admin >
112112

113113
![Screenshot of an image being generated in the chat using ComfyUI.](/images/image-generation-and-editing/comfyui-create-image-in-chat.png)
114114

115+
:::info
116+
There is no "Generate Image" button underneath messages any more. Generation happens from the chat itself: switch **Image** on in the **Integrations** menu of the message input, then ask for the image. See [Usage](/features/chat-conversations/image-generation-and-editing/usage) for the conditions that have to be met and for the community action that brings the old button back.
117+
:::
118+
115119
## Edit Image
116120

117121
Open WebUI also supports image editing through ComfyUI, allowing you to modify existing images.
118122

119123
1. **Navigate to Image Settings:** In Open WebUI, go to the **Settings** > **Admin** > **Experience** > **Images**.
120124

121125
2. **Configure Image Editing:**
122-
- Under the **Edit Image** section, set the **Image Edit Engine** to `ComfyUI`.
126+
- Under the **Edit Image** section, switch **Image Edit** on. It is off by default, and without it the edit engine is never used.
127+
- Set the **Image Edit Engine** to `ComfyUI`.
123128
- **Model**: Select the model to be used for the editing task.
124129
- **Image Size**: Specify the desired resolution for the output image.
125-
- **ComfyUI Base URL** and **API Key**: These fields are shared with the image generation settings.
130+
- **Base URL** and **API Key**: The **Edit Image** section has its own fields for these. They do not fall back to the generation settings, so fill them in even when the same ComfyUI instance serves both.
126131
- **ComfyUI Workflow**: Upload a separate workflow file specifically designed for image editing tasks. The process is the same as for image generation.
127132
- **Map Workflow Nodes**: Image editing has five configurable parameters with different defaults than generation:
128133

@@ -370,9 +375,9 @@ This section provides a supplementary guide on setting up the FLUX.1 models for
370375

371376
## Configuring with SwarmUI
372377

373-
SwarmUI utilizes ComfyUI as its backend. In order to get Open WebUI to work with SwarmUI you will have to append `ComfyBackendDirect` to the `ComfyUI Base URL`. Additionally, you will want to setup SwarmUI with LAN access. After aforementioned adjustments, setting up SwarmUI to work with Open WebUI will be the same as the steps for ComfyUI image generation outlined above.
378+
SwarmUI utilizes ComfyUI as its backend. In order to get Open WebUI to work with SwarmUI you will have to append `ComfyBackendDirect` to the `Base URL`. Additionally, you will want to setup SwarmUI with LAN access. After aforementioned adjustments, setting up SwarmUI to work with Open WebUI will be the same as the steps for ComfyUI image generation outlined above.
374379
![Install SwarmUI with LAN Access](https://github.com/user-attachments/assets/a6567e13-1ced-4743-8d8e-be526207f9f6)
375380

376381
### SwarmUI API URL
377382

378-
The address you will input as the ComfyUI Base URL will look like: `http://<your_swarmui_address>:7801/ComfyBackendDirect`
383+
The address you will input as the **Base URL** will look like: `http://<your_swarmui_address>:7801/ComfyBackendDirect`

docs/features/chat-conversations/image-generation-and-editing/gemini.mdx

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ Alternatively, if you are using Vertex AI, you can create an API key in Google C
2626

2727
1. In Open WebUI, navigate to the **Settings** > **Admin** > **Experience** > **Images** menu.
2828
2. Set the `Image Generation Engine` field to `Gemini`.
29-
3. Set the `API Base URL` to `https://generativelanguage.googleapis.com/v1beta`.
29+
3. Set the `Base URL` to `https://generativelanguage.googleapis.com/v1beta`.
3030
4. Enter your Google AI Studio [API key](https://aistudio.google.com/api-keys).
31-
5. Enter the model you wish to use from these [available models](https://ai.google.dev/gemini-api/docs/imagen#model-versions).
32-
6. Set the image size to one of the available [image sizes](https://ai.google.dev/gemini-api/docs/image-generation#aspect_ratios).
31+
5. Enter the model you wish to use, either an [Imagen model](https://ai.google.dev/gemini-api/docs/imagen#model-versions) or a [Gemini model](https://ai.google.dev/gemini-api/docs/image-generation).
32+
6. Set the `Gemini Endpoint Method` to match that model: `predict` for Imagen, `generateContent` for Gemini.
3333

3434
import Tabs from '@theme/Tabs';
3535
import TabItem from '@theme/TabItem';
@@ -40,63 +40,62 @@ import TabItem from '@theme/TabItem';
4040
<TabItem value="gemini-3-pro" label="Gemini 3.0 Pro (aka Nano Banana Pro)" default>
4141

4242
**Create Image**
43-
- **Create Image Model**: `gemini-3-pro-image-preview`
44-
- **Image Size**: `2816x1536`
45-
- **Image Prompt Generation**: on
43+
- **Model**: `gemini-3-pro-image-preview`
44+
- **Image Size**: (not sent to Gemini, can be left empty)
45+
- **Image Prompt Generation**: on (Legacy function calling only)
4646
- **Image Generation Engine**: `Gemini`
47-
- **Gemini Base URL**: `https://generativelanguage.googleapis.com/v1beta`
48-
- **Gemini API Key**: Enter your API Key
47+
- **Base URL**: `https://generativelanguage.googleapis.com/v1beta`
48+
- **API Key**: Enter your API Key
4949
- **Gemini Endpoint Method**: `generateContent`
5050

5151
**Edit Image**
52+
- **Image Edit**: on
5253
- **Image Edit Engine**: `Gemini`
5354
- **Model**: `gemini-3-pro-image-preview`
54-
- **Image Size**: (can be left empty)
55-
- **Gemini Base URL**: `https://generativelanguage.googleapis.com/v1beta`
56-
- **Gemini API Key**: Enter your API Key
55+
- **Image Size**: (not sent to Gemini, can be left empty)
56+
- **Base URL**: `https://generativelanguage.googleapis.com/v1beta`
57+
- **API Key**: Enter your API Key
5758

5859
</TabItem>
5960
<TabItem value="gemini-2.5-flash" label="Gemini 2.5 Flash (aka Nano Banana)">
6061

6162
**Create Image**
62-
- **Create Image Model**: `gemini-2.5-flash-image`
63-
- **Image Size**: `2816x1536`
64-
- **Image Prompt Generation**: on
63+
- **Model**: `gemini-2.5-flash-image`
64+
- **Image Size**: (not sent to Gemini, can be left empty)
65+
- **Image Prompt Generation**: on (Legacy function calling only)
6566
- **Image Generation Engine**: `Gemini`
66-
- **Gemini Base URL**: `https://generativelanguage.googleapis.com/v1beta`
67-
- **Gemini API Key**: Enter your API Key
67+
- **Base URL**: `https://generativelanguage.googleapis.com/v1beta`
68+
- **API Key**: Enter your API Key
6869
- **Gemini Endpoint Method**: `generateContent`
6970

7071
**Edit Image**
72+
- **Image Edit**: on
7173
- **Image Edit Engine**: `Gemini`
7274
- **Model**: `gemini-2.5-flash-image`
73-
- **Image Size**: (can be left empty)
74-
- **Gemini Base URL**: `https://generativelanguage.googleapis.com/v1beta`
75-
- **Gemini API Key**: Enter your API Key
75+
- **Image Size**: (not sent to Gemini, can be left empty)
76+
- **Base URL**: `https://generativelanguage.googleapis.com/v1beta`
77+
- **API Key**: Enter your API Key
7678

7779
</TabItem>
7880
</Tabs>
7981

80-
![Screenshot of the Open WebUI Images settings page with Gemini selected and the API key, model, and image size fields highlighted.](/images/image-generation-and-editing/gemini-settings.png)
82+
![Screenshot of the Open WebUI Images settings page with Gemini selected.](/images/image-generation-and-editing/gemini-settings.png)
8183

8284
:::info
8385

84-
This feature appears to only work for models supported with this endpoint: `https://generativelanguage.googleapis.com/v1beta/models/<MODEL_NAME>:predict`.
85-
This is the OpenAI **BETA** endpoint, which Google provides for experimental OpenAI compatibility.
86-
87-
Google Imagen models use this endpoint while Gemini models use a different endpoint ending with `:generateContent`
86+
Imagen and Gemini models are served from different endpoints, so **Gemini Endpoint Method** has to match the model you entered.
8887

89-
Imagen model endpoint example:
88+
Imagen models use `predict`:
9089

9190
- `https://generativelanguage.googleapis.com/v1beta/models/imagen-4.0-generate-001:predict`.
9291
- [Documentation for Imagen models](https://ai.google.dev/gemini-api/docs/imagen)
9392

94-
Gemini model endpoint example:
93+
Gemini models use `generateContent`:
9594

9695
- `https://generativelanguage.googleapis.com/v1beta/models/gemini-3-pro-image-preview:generateContent`.
9796
- [Documentation for Gemini models](https://ai.google.dev/gemini-api/docs/image-generation)
9897

99-
Trying to call a Gemini model, such as `gemini-3-pro-image-preview` would result in an error due to the difference in supported endpoints for Image Generation.
98+
Leaving the method empty falls back to `predict`, so a Gemini model such as `gemini-3-pro-image-preview` fails until you switch it to `generateContent`.
10099

101100
`400: [ERROR: models/gemini-3-pro-image-preview is not found for API version v1beta, or is not supported for predict. Call ListModels to see the list of available models and their supported methods.]`
102101

@@ -107,8 +106,8 @@ Trying to call a Gemini model, such as `gemini-3-pro-image-preview` would result
107106
Image generation with a LiteLLM proxy using Gemini or Imagen endpoints is supported with Open WebUI. Configure the Image Generation as follows:
108107

109108
1. In Open WebUI, navigate to the **Settings** > **Admin** > **Experience** > **Images** menu.
110-
2. Set the `Image Generation Engine` field to `Open AI`.
111-
3. Change the API endpoint URL to `https://<your-litellm-url>:<port>/v1`.
109+
2. Set the `Image Generation Engine` field to `Default (Open AI)`.
110+
3. Change the `API Base URL` to `https://<your-litellm-url>:<port>/v1`.
112111
4. Enter your LiteLLM API key.
113112
5. The API version can be left blank.
114113
6. Enter the image model name as it appears in your LiteLLM configuration.

docs/features/chat-conversations/image-generation-and-editing/image-router.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ Open WebUI also supports image generation through the **Image Router APIs**. Ima
1616
### Configuring Open WebUI
1717

1818
1. In Open WebUI, navigate to the **Settings** > **Admin** > **Experience** > **Images** menu.
19-
2. Set the `Image Generation Engine` field to `Open AI` (Image Router uses the same syntax as OpenAI).
20-
3. Change the API endpoint URL to `https://api.imagerouter.io/v1/openai`
19+
2. Set the `Image Generation Engine` field to `Default (Open AI)` (Image Router uses the same syntax as OpenAI).
20+
3. Change the `API Base URL` to `https://api.imagerouter.io/v1/openai`
2121
4. Enter your Image Router API key.
2222
5. Enter the model you wish to use. Do not use the dropdown to select models, enter the model name instead. For more information, [see all models](https://imagerouter.io/models).
2323

24-
![Screenshot of the Open WebUI Images settings page with Open AI selected and the API endpoint URL, API key, and model fields highlighted for Image Router configuration.](/images/image-generation-and-editing/image-router-settings.png)
24+
![Screenshot of the Open WebUI Images settings page with Open AI selected and the API Base URL, API key and model fields highlighted for Image Router configuration.](/images/image-generation-and-editing/image-router-settings.png)

docs/features/chat-conversations/image-generation-and-editing/lumenfall.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ Open WebUI also supports image generation through [Lumenfall](https://lumenfall.
1717
### Configuring Image Generation
1818

1919
1. In Open WebUI, navigate to the **Settings** > **Admin** > **Experience** > **Images** menu.
20-
2. Set the `Image Generation Engine` field to `Open AI` (Lumenfall uses the same syntax as OpenAI).
21-
3. Change the API endpoint URL to `https://api.lumenfall.ai/openai/v1`.
20+
2. Set the `Image Generation Engine` field to `Default (Open AI)` (Lumenfall uses the same syntax as OpenAI).
21+
3. Change the `API Base URL` to `https://api.lumenfall.ai/openai/v1`.
2222
4. Enter your Lumenfall API key.
2323
5. The API version can be left blank.
2424
6. Enter the model you wish to use. For example: `gemini-3-pro-image`, `gpt-image-1.5`, or `flux.2-max`. See all available models at [lumenfall.ai/models](https://lumenfall.ai/models).
@@ -32,8 +32,8 @@ Lumenfall also supports image editing through the same API:
3232

3333
1. On the same **Images** settings page, scroll to the **Edit Image** section.
3434
2. Toggle **Image Edit** to on.
35-
3. Set the `Image Edit Engine` to `Open AI`.
36-
4. Enter the same API endpoint URL: `https://api.lumenfall.ai/openai/v1`.
35+
3. Set the `Image Edit Engine` to `Default (Open AI)`.
36+
4. Enter the same `API Base URL`: `https://api.lumenfall.ai/openai/v1`.
3737
5. Enter your Lumenfall API key.
3838
6. Choose a model that supports editing (e.g. `gpt-image-1.5`).
3939

docs/features/chat-conversations/image-generation-and-editing/openai.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Open WebUI also supports image generation through the **OpenAI APIs**. This opti
1616
### Configuring Open WebUI
1717

1818
1. In Open WebUI, navigate to the **Settings** > **Admin** > **Experience** > **Images** menu.
19-
2. Set the `Image Generation Engine` field to `Open AI`.
19+
2. Set the `Image Generation Engine` field to `Default (Open AI)`.
2020
3. Enter your OpenAI API key.
2121
4. Choose the model you wish to use. Note that image size options will depend on the selected model:
2222
- **DALL·E 2**: Supports `256x256`, `512x512`, or `1024x1024` images.
@@ -30,12 +30,12 @@ Open WebUI also supports image generation through the **OpenAI APIs**. This opti
3030
Image generation with Azure OpenAI (DALL·E or GPT-Image) is supported. Configure the Image Generation as follows:
3131

3232
1. In Open WebUI, navigate to the **Settings** > **Admin** > **Experience** > **Images** menu.
33-
2. Set the `Image Generation Engine` field to `Open AI` (Azure OpenAI uses the same syntax as OpenAI).
34-
3. Change the API endpoint URL to `https://<instance-id>.cognitiveservices.azure.com/openai/deployments/<model>/`. Set the instance and model id as you find it in the settings of the Azure AI Foundry.
33+
2. Set the `Image Generation Engine` field to `Default (Open AI)` (Azure OpenAI uses the same syntax as OpenAI).
34+
3. Change the `API Base URL` to `https://<instance-id>.cognitiveservices.azure.com/openai/deployments/<model>/`. Set the instance and model id as you find it in the settings of the Azure AI Foundry.
3535
4. Configure the API version to the value you find in the settings of the Azure AI Foundry.
3636
5. Enter your Azure OpenAI API key.
3737

38-
![Screenshot of the Open WebUI Images settings page with Open AI selected and the API endpoint URL, API version, and API key fields highlighted for Azure OpenAI configuration.](/images/image-generation-and-editing/azure-openai-settings.png)
38+
![Screenshot of the Open WebUI Images settings page with Open AI selected and the API Base URL, API version and API key fields highlighted for Azure OpenAI configuration.](/images/image-generation-and-editing/azure-openai-settings.png)
3939

4040
:::tip Azure GPT-Image-1.5 Configuration
4141
For Azure OpenAI **gpt-image-1.5**, use the following settings for successful generation:
@@ -48,18 +48,18 @@ If you encounter the error `[ERROR: azure-openai error: Unknown parameter: 'resp
4848
:::
4949

5050
:::tip
51-
Alternative API endpoint URL tutorial: `https://<endpoint name>.openai.azure.com/openai/deployments/<model name>/` - you can find your endpoint name on https://ai.azure.com/resource/overview, and model name on https://ai.azure.com/resource/deployments.
51+
Alternative `API Base URL` tutorial: `https://<endpoint name>.openai.azure.com/openai/deployments/<model name>/` - you can find your endpoint name on https://ai.azure.com/resource/overview, and model name on https://ai.azure.com/resource/deployments.
5252
You can also copy Target URI from your deployment detailed page, but remember to delete strings after model name.
53-
For example, if your Target URI is `https://test.openai.azure.com/openai/deployments/gpt-image-1/images/generations?api-version=2025-04-01-preview`, the API endpoint URL in Open WebUI should be `https://test.openai.azure.com/openai/deployments/gpt-image-1/`.
53+
For example, if your Target URI is `https://test.openai.azure.com/openai/deployments/gpt-image-1/images/generations?api-version=2025-04-01-preview`, the `API Base URL` in Open WebUI should be `https://test.openai.azure.com/openai/deployments/gpt-image-1/`.
5454
:::
5555

5656
### LiteLLM Proxy with OpenAI Endpoints
5757

5858
Image generation with a LiteLLM proxy using OpenAI endpoints is supported with Open WebUI. Configure the Image Generation as follows:
5959

6060
1. In Open WebUI, navigate to the **Settings** > **Admin** > **Experience** > **Images** menu.
61-
2. Set the `Image Generation Engine` field to `Open AI`.
62-
3. Change the API endpoint URL to `https://<your-litellm-url>:<port>/v1`.
61+
2. Set the `Image Generation Engine` field to `Default (Open AI)`.
62+
3. Change the `API Base URL` to `https://<your-litellm-url>:<port>/v1`.
6363
4. Enter your LiteLLM API key.
6464
5. The API version can be left blank.
6565
6. Enter the image model name as it appears in your LiteLLM configuration.

0 commit comments

Comments
 (0)