Adam SmithandClaude Opus 5
117780dd68
async_setup_entry does entry.data[CONF_BASE_URL] as a hard index, but base_url is this fork's own addition: an entry created by a build from before the base_url commits (48195c9 era, version 2 minor 7) has no such key. On restart, setup raises KeyError: 'base_url' and the integration fails to load -- reproduced in test first, where async_setup returns False with that KeyError in the log. Fixed with a migration step rather than a defensive .get(), matching the pattern the rest of async_migrate_entry already uses, so the invariant "a loaded entry has base_url" holds for every caller instead of each call site guarding itself: - new step 2.7 -> 2.8 backfills DEFAULT_BASE_URL via dict.setdefault, so an entry that already has a base_url keeps its own endpoint and only a missing one is filled. An install from before this feature was implicitly using api.openai.com, which is exactly DEFAULT_BASE_URL, so the backfill preserves existing behavior rather than repointing anyone. - config_flow MINOR_VERSION 7 -> 8, otherwise the step never runs. test_client_built_with_base_url now also covers the preserve path, since its entry starts at minor 7 with a base_url set and must still reach the client unchanged after migrating. Also updated test_form's `minor_version == 7` assertion to 8; it pins the version new entries are created at, so the bump is expected. The reauth test's MockConfigEntry stays at minor 7 on purpose -- it stands in for an already-existing entry. Local: 138 passed. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NxJYWgGJtCw13qUHZtG8ki
OpenAI Compatible for Home Assistant
Home Assistant's built-in OpenAI integration, with one change that matters: the
API base URL is configurable. Point Home Assistant's conversation agent, AI Task,
speech-to-text and text-to-speech at any OpenAI-compatible endpoint — LiteLLM, vLLM,
OpenRouter, a gateway of your own — instead of only api.openai.com.
Everything else is upstream Home Assistant code, vendored unmodified, so behavior and options match the core integration you already know.
Why this exists
Core's openai_conversation hardcodes OpenAI's endpoint. If you run a proxy for cost
control, routing, key management or privacy, or you self-host models, there is no way to
tell the core integration about it. This fork adds a Base URL field to the config
flow and threads it to every client it creates.
What you get
Everything the core integration provides, as config subentries you can add more than one of:
- Conversation agent — an Assist conversation entity, with the LLM Assist API, tool calling, and the full upstream option set (model, temperature, top-p, max tokens, reasoning effort, verbosity, web search, code interpreter, service tier, …)
- AI Task — for
ai_task.generate_data/ image generation - Speech-to-text — an STT entity
- Text-to-speech — a TTS entity, with speed control
- Actions —
openai_compatible.generate_contentandopenai_compatible.generate_image
Requirements
- Home Assistant 2026.9.0 or newer
- An OpenAI-compatible endpoint (see Endpoint compatibility)
Installation
HACS (custom repository)
- HACS → ⋮ → Custom repositories
- Add
https://github.com/adamjs83/ha-openai-compatible, category Integration - Find OpenAI Compatible in HACS, download it, and restart Home Assistant
- Settings → Devices & services → Add integration → OpenAI Compatible
Manual
Copy custom_components/openai_compatible/ into your Home Assistant
config/custom_components/ directory and restart.
Configuration
The initial dialog asks for two things:
| Field | Notes |
|---|---|
| Base URL | Full URL including any version path, e.g. https://api.openai.com/v1. Passed to the OpenAI SDK as-is. |
| API key | Optional — leave blank for an endpoint that does not authenticate. |
Then add one subentry per capability you want (conversation, AI Task, STT, TTS), each with its own model and options.
Base URL rules
- Only
httpandhttpsare accepted; the URL must include a host. - Whitespace and trailing slashes are stripped.
- Include the version path if your server expects one. Most do:
/v1. - Credentials embedded in the URL (
https://user:pass@host/v1) are rejected. Put the token in the API key field — it is stored as a secret and kept out of logs, while a base URL is echoed back in error and log messages. - Re-authenticating (rotating the API key) keeps your configured base URL.
Empty API keys
Local endpoints often require no auth. Leave the API key blank and the integration sends
the placeholder not-required — the OpenAI SDK refuses to build a client with no key at
all, so something has to be sent, and servers that ignore auth ignore it.
Endpoint examples
| Server | Typical base URL |
|---|---|
| OpenAI | https://api.openai.com/v1 |
| LiteLLM | http://litellm.local:4000/v1 |
| vLLM | http://vllm.local:8000/v1 |
| OpenRouter | https://openrouter.ai/api/v1 |
| Azure OpenAI (via a proxy) | your proxy's URL |
Endpoint compatibility
This is the important caveat. Upstream uses OpenAI's Responses API, not Chat
Completions, so a server that only implements /v1/chat/completions will not work
for conversation or AI Task.
| Feature | Endpoint the server must implement |
|---|---|
| Setup / connection test | GET /v1/models |
| Conversation, AI Task | POST /v1/responses |
| Text-to-speech | POST /v1/audio/speech |
| Speech-to-text | POST /v1/audio/transcriptions |
generate_image action |
POST /v1/images/generations |
You only need the endpoints for the subentries you actually add. Check your server's docs for Responses API support before filing a bug — LiteLLM and vLLM have it in recent versions; several popular local servers still do not.
Model names
The default and "recommended" model names come from upstream and are OpenAI's
(gpt-4o-mini, gpt-4o-mini-tts, gpt-4o-mini-transcribe, …). Set the model your
endpoint actually serves in each subentry's options. Upstream's lists of models that
don't support web search, image generation, and so on are also keyed to OpenAI names, so
they won't match a third-party model string — the endpoint's own error is what you'll
see if you ask for something it can't do.
Relationship to Home Assistant core
custom_components/openai_compatible/ is derived from
homeassistant/components/openai_conversation/ at core tag 2026.9.2
(commit recorded in UPSTREAM_COMMIT),
with the domain renamed to openai_compatible and the base URL made configurable.
Base-URL handling lives in its own module,
url_util.py, deliberately separate
from the vendored files so re-syncing with core stays a clean merge.
Installing this alongside core's OpenAI integration is fine — different domain, separate config entries. This is not an official Home Assistant integration and is not affiliated with or endorsed by OpenAI.
Development
Requires Python 3.14+ (Home Assistant 2026.9's floor).
pip install -r requirements_test.txt
pytest tests/ -v
The suite is core's openai_conversation test suite, ported as a regression net, plus
tests for the base-URL behavior this fork adds.
License
Apache-2.0, inherited from Home Assistant core. See NOTICE for attribution.