change_config
Dynamically update the integration’s connection settings — API key, Base URL, provider, and more — without restarting Home Assistant. The new values are validated against the API before being saved.Parameters
| Parameter | Required | Description |
|---|---|---|
config_entry | ✅ | The Extended OpenAI Conversation config entry to update |
api_key | New API key | |
base_url | New Base URL (e.g. http://localhost:11434/v1) | |
api_version | Azure API version (e.g. 2024-12-01-preview) | |
organization | OpenAI organization ID | |
skip_authentication | Skip auth verification — useful for local providers with no key | |
api_provider | openai or azure |
At least one optional parameter must be provided. Calling the service with only
config_entry does nothing.Examples
How to find config_entry
- Go to Settings → Devices & Services
- Click Extended OpenAI Conversation
- The entry ID is in the browser URL:
.../config/integrations/integration/extended_openai_conversation#ENTRY_ID
Behavior notes
- Validation first: The service connects to the API with the new credentials before saving. If the connection fails, the existing config is preserved and an error is raised.
- OpenAI default URL: Setting
base_urltohttps://api.openai.com/v1is treated as “no custom URL” — the integration uses OpenAI’s default endpoint, which is resilient to future URL changes by OpenAI. - Partial updates: Only the fields you provide are changed. Unspecified fields keep their current values.
query_image
Send an image (local file or public URL) to a vision-capable model and get a text response back. The service returns the full API response object.Parameters
| Parameter | Required | Default | Description |
|---|---|---|---|
config_entry | ✅ | Config entry to use for the API call | |
model | ✅ | gpt-4.1-mini | Vision-capable model name |
prompt | ✅ | Question or instruction for the image | |
images | ✅ | List of image objects: [{url: "..."}] | |
max_tokens | 300 | Maximum tokens in the response |
Examples
For local file paths, the path must be allowed in
allowlist_external_dirs in your configuration.yaml.Return value
The service returns the full OpenAI chat completion response:reload_skills
Reload all skills from the skills directory without restarting Home Assistant. Use this after manually adding or editing skill files.Parameters
None.Example
Return value
The
download_skill service automatically reloads skills after downloading, so a manual reload is only needed when you edit skill files directly.download_skill
Download a skill from the official GitHub repository and install it to your skills directory. Skills are reloaded automatically after download.Parameters
| Parameter | Required | Description |
|---|---|---|
skill_name | ✅ | Name of the skill (e.g. crypto) |