[PR #17147] [MERGED] feat: Azure OpenAI image generation support #24335

New Issue

GiteaMirror · 2026-04-20T05:21:02-05:00

GiteaMirror commented

2026-04-20 05:21:02 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/17147
Author: @anfuerer
Created: 9/2/2025
Status: ✅ Merged
Merged: 9/3/2025
Merged by: @tjbck

Base: dev ← Head: dev

📝 Commits (2)

bc6afc9 feature: Azure OpenAI image generation support
df0d29c style: fix formatting issues

📊 Changes

4 files changed (+55 additions, -13 deletions)

View changed files

📝 backend/open_webui/config.py (+6 -0)
📝 backend/open_webui/main.py (+2 -0)
📝 backend/open_webui/routers/images.py (+13 -1)
📝 src/lib/components/admin/Settings/Images.svelte (+34 -12)

📄 Description

The image generation API used on Azure OpenAI requires to specify the API version by appending an api-version query parameter to the endpoint URL. Added the environment variable IMAGES_OPENAI_API_VERSION with configuration functionality in the administration UI.

Pull Request Checklist

Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.

See https://github.com/open-webui/open-webui/discussions/16274

Before submitting, make sure you've checked the following:

Target branch: Please verify that the pull request targets the dev branch.
Description: Provide a concise description of the changes made in this pull request.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Have you updated relevant documentation Open WebUI Docs, or other documentation sources?
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Have you written and run sufficient tests to validate the changes?
Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Prefix: To clearly categorize this pull request, prefix the pull request title using one of the following:
- BREAKING CHANGE: Significant changes that may affect compatibility
- build: Changes that affect the build system or external dependencies
- ci: Changes to our continuous integration processes or workflows
- chore: Refactor, cleanup, or other non-functional code changes
- docs: Documentation update or addition
- feat: Introduces a new feature or enhancement to the codebase
- fix: Bug fix or error correction
- i18n: Internationalization or localization changes
- perf: Performance improvement
- refactor: Code restructuring for better maintainability, readability, or scalability
- style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
- test: Adding missing tests or correcting existing tests
- WIP: Work in progress, a temporary label for incomplete or ongoing work

Changelog Entry

Description

The image generation API used on Azure OpenAI requires to specify the API version by appending an api-version query parameter to the endpoint URL. Added the environment variable IMAGES_OPENAI_API_VERSION with configuration functionality in the administration UI.

Added

Added the environment variable IMAGES_OPENAI_API_VERSION
Extended the administration UI to configure the optional API version for OpenAI image generations

Changed

When calling the OpenAI endpoint /images/generations endpoint a query parameter is appended in case the configuration IMAGES_OPENAI_API_VERSION is defined.

Additional Information

Please note that the image generation API call automatically appends the path /images/generations to the outgoing calls to the OpenAPI endpoints. When configuring the Azure Open AI URL, make sure to only configure the necessary host and path (without the /images/generations part). This behaviour hasn't changed with this PR. I'm just emphasising the lessons learnt.

Screenshots or Videos

API version can be configured in the admin section

Contributor License Agreement

By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), and I am providing my contributions under its terms.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/open-webui/pull/17147 **Author:** [@anfuerer](https://github.com/anfuerer) **Created:** 9/2/2025 **Status:** ✅ Merged **Merged:** 9/3/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `dev` --- ### 📝 Commits (2) - [`bc6afc9`](https://github.com/open-webui/open-webui/commit/bc6afc905706afce70a235ba4ada78c7468ec360) feature: Azure OpenAI image generation support - [`df0d29c`](https://github.com/open-webui/open-webui/commit/df0d29c81c83d598aa868275e4362f30678c73a2) style: fix formatting issues ### 📊 Changes **4 files changed** (+55 additions, -13 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/config.py` (+6 -0) 📝 `backend/open_webui/main.py` (+2 -0) 📝 `backend/open_webui/routers/images.py` (+13 -1) 📝 `src/lib/components/admin/Settings/Images.svelte` (+34 -12) </details> ### 📄 Description The image generation API used on Azure OpenAI requires to specify the API version by appending an `api-version` query parameter to the endpoint URL. Added the environment variable `IMAGES_OPENAI_API_VERSION` with configuration functionality in the administration UI. # Pull Request Checklist ### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) and describe your changes before submitting a pull request. See https://github.com/open-webui/open-webui/discussions/16274 **Before submitting, make sure you've checked the following:** - [X] **Target branch:** Please verify that the pull request targets the `dev` branch. - [X] **Description:** Provide a concise description of the changes made in this pull request. - [X] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description. - [X] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources? - [X] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? - [X] **Testing:** Have you written and run sufficient tests to validate the changes? - [X] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards? - [X] **Prefix:** To clearly categorize this pull request, prefix the pull request title using one of the following: - **BREAKING CHANGE**: Significant changes that may affect compatibility - **build**: Changes that affect the build system or external dependencies - **ci**: Changes to our continuous integration processes or workflows - **chore**: Refactor, cleanup, or other non-functional code changes - **docs**: Documentation update or addition - **feat**: Introduces a new feature or enhancement to the codebase - **fix**: Bug fix or error correction - **i18n**: Internationalization or localization changes - **perf**: Performance improvement - **refactor**: Code restructuring for better maintainability, readability, or scalability - **style**: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.) - **test**: Adding missing tests or correcting existing tests - **WIP**: Work in progress, a temporary label for incomplete or ongoing work # Changelog Entry ### Description The image generation API used on Azure OpenAI requires to specify the API version by appending an `api-version` query parameter to the endpoint URL. Added the environment variable `IMAGES_OPENAI_API_VERSION` with configuration functionality in the administration UI. ### Added - Added the environment variable `IMAGES_OPENAI_API_VERSION` - Extended the administration UI to configure the optional API version for OpenAI image generations ### Changed - When calling the OpenAI endpoint `/images/generations` endpoint a query parameter is appended in case the configuration `IMAGES_OPENAI_API_VERSION` is defined. --- ### Additional Information Please note that the image generation API call automatically appends the path `/images/generations` to the outgoing calls to the OpenAPI endpoints. When configuring the Azure Open AI URL, make sure to only configure the necessary host and path (without the `/images/generations` part). This behaviour hasn't changed with this PR. I'm just emphasising the lessons learnt. ### Screenshots or Videos API version can be configured in the admin section <img width="1564" height="712" alt="image-generation-config" src="https://github.com/user-attachments/assets/7a49b226-08b0-4db8-9874-6719d06bc82e" /> ### Contributor License Agreement By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](/CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the pull-request label 2026-04-20 05:21:02 -05:00

GiteaMirror closed this issue

2026-04-20 05:21:03 -05:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/open-webui#24335