Home Connect (BSH appliances) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Home Connect Programs API

17 actions 17 updates phrasing extends openapi/home-connect-programs-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Home Connect (BSH appliances)'s API. It is a proposal applied on top of the contract, not a document Home Connect (BSH appliances) publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 17 · first 16 shown; the file carries all of them

$.info
$.paths['/homeappliances/{haId}/programs'].get
$.paths['/homeappliances/{haId}/programs/available'].get
$.paths['/homeappliances/{haId}/programs/available/{programkey}'].get
$.paths['/homeappliances/{haId}/programs/active'].get
$.paths['/homeappliances/{haId}/programs/active'].put
$.paths['/homeappliances/{haId}/programs/active'].delete
$.paths['/homeappliances/{haId}/programs/active/options'].get
$.paths['/homeappliances/{haId}/programs/active/options'].put
$.paths['/homeappliances/{haId}/programs/active/options/{optionkey}'].get
$.paths['/homeappliances/{haId}/programs/active/options/{optionkey}'].put
$.paths['/homeappliances/{haId}/programs/selected'].get
$.paths['/homeappliances/{haId}/programs/selected'].put
$.paths['/homeappliances/{haId}/programs/selected/options'].get
$.paths['/homeappliances/{haId}/programs/selected/options'].put
$.paths['/homeappliances/{haId}/programs/selected/options/{optionkey}'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Home Connect Programs API
  version: 1.0.0
extends: openapi/home-connect-programs-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-19'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 16
- target: $.paths['/homeappliances/{haId}/programs'].get
  update:
    x-apievangelist-phrasing:
      intent: List all programs of a home appliance
      effect: read
      questions:
      - What programs does my washing machine support?
      - Can I see every program a home appliance can run?
      instructions:
      - text: List all programs of home appliance {haId}.
        slots:
          haId: path.haId
      - text: Show every program available on {haId}.
        slots:
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/programs/available'].get
  update:
    x-apievangelist-phrasing:
      intent: List programs currently available on a home appliance
      effect: read
      questions:
      - Which programs can I start right now on my oven?
      - Are there any programs currently available on a home appliance?
      instructions:
      - text: List the programs currently available on {haId}.
        slots:
          haId: path.haId
      - text: Show only the programs I can start on {haId} now.
        slots:
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/programs/available/{programkey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one program available on a home appliance
      effect: read
      questions:
      - What are the settings of a specific program on my dishwasher?
      - Can I look up one program by its key on a home appliance?
      instructions:
      - text: Get program {programkey} on home appliance {haId}.
        slots:
          programkey: path.programkey
          haId: path.haId
      - text: Show the available program {programkey} for {haId}.
        slots:
          programkey: path.programkey
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/programs/active'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the program currently running on a home appliance
      effect: read
      questions:
      - Which program is my oven currently running?
      - What is the active program on a home appliance right now?
      instructions:
      - text: Get the active program on home appliance {haId}.
        slots:
          haId: path.haId
      - text: Tell me which program {haId} is running.
        slots:
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/programs/active'].put
  update:
    x-apievangelist-phrasing:
      intent: Start a program on a home appliance
      effect: write
      questions:
      - How do I start a program on my washing machine?
      - What preconditions must be met before a program can be started?
      instructions:
      - text: Start program {data} on home appliance {haId}.
        slots:
          data: requestBody.data
          haId: path.haId
      - text: Run {data} on {haId} if the appliance is connected and remote control is allowed.
        slots:
          data: requestBody.data
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/programs/active'].delete
  update:
    x-apievangelist-phrasing:
      intent: Stop the program running on a home appliance
      effect: destructive
      questions:
      - How do I stop a program that is already running on my oven?
      - Can I halt the active program on a home appliance?
      instructions:
      - text: Stop the active program on home appliance {haId}.
        slots:
          haId: path.haId
      - text: Halt the running program on {haId}.
        slots:
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/programs/active/options'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the options of the running program
      effect: read
      questions:
      - What options are set on the program my oven is currently running?
      - Can I read the active program's options on a home appliance?
      instructions:
      - text: Get the options of the active program on home appliance {haId}.
        slots:
          haId: path.haId
      - text: Show which settings the program running on {haId} has.
        slots:
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/programs/active/options'].put
  update:
    x-apievangelist-phrasing:
      intent: Set all options of the running program
      effect: write
      questions:
      - How do I change every option of a program that is already running?
      - Do I have to send all active program options at once?
      instructions:
      - text: Set all options of the active program on {haId} to {data}.
        slots:
          haId: path.haId
          data: requestBody.data
      - text: Update every setting of the program running on {haId} to {data}.
        slots:
          haId: path.haId
          data: requestBody.data
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/programs/active/options/{optionkey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one option of the running program
      effect: read
      questions:
      - What value is a specific option of the program my oven is running set to?
      - Can I read one active program option by its key?
      instructions:
      - text: Get option {optionkey} of the active program on {haId}.
        slots:
          optionkey: path.optionkey
          haId: path.haId
      - text: Show the value of {optionkey} for the program running on {haId}.
        slots:
          optionkey: path.optionkey
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/programs/active/options/{optionkey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a running program's option
      effect: write
      questions:
      - How do I extend a program that is already running by an extra 5 minutes?
      - Can I change the selected oven program's options while it runs?
      instructions:
      - text: Set option {key} of the active program on appliance {haId} to {value}.
        slots:
          key: path.optionkey
          haId: path.haId
          value: requestBody.data
      - text: Extend the running program on {haId} by changing option {key} to {value}.
        slots:
          haId: path.haId
          key: path.optionkey
          value: requestBody.data
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/programs/selected'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the program shown on the home appliance display
      effect: read
      questions:
      - Which program is currently selected on my washing machine display?
      - What program is my oven showing on its control panel?
      instructions:
      - text: Get the selected program on home appliance {haId}.
        slots:
          haId: path.haId
      - text: Tell me which program {haId} is showing on its display.
        slots:
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/programs/selected'].put
  update:
    x-apievangelist-phrasing:
      intent: Select a program on the home appliance display
      effect: write
      questions:
      - How do I choose a program on my oven's display without starting it?
      - Can I select a program on a home appliance before starting it?
      instructions:
      - text: Select program {data} on home appliance {haId}.
        slots:
          data: requestBody.data
          haId: path.haId
      - text: Set the program shown on {haId} to {data}.
        slots:
          haId: path.haId
          data: requestBody.data
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/programs/selected/options'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the options of the selected program
      effect: read
      questions:
      - What options are available for the program my oven is currently showing?
      - Can I see the constraints of the program selected on a home appliance?
      instructions:
      - text: Get the options of the selected program on {haId}.
        slots:
          haId: path.haId
      - text: Show which settings the program selected on {haId} allows.
        slots:
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/programs/selected/options'].put
  update:
    x-apievangelist-phrasing:
      intent: Set all options of the selected program
      effect: write
      questions:
      - How do I change every option of the program my oven is showing?
      - Do I have to send all selected program options at once?
      instructions:
      - text: Set all options of the selected program on {haId} to {data}.
        slots:
          haId: path.haId
          data: requestBody.data
      - text: Update every setting of the program selected on {haId} to {data}.
        slots:
          haId: path.haId
          data: requestBody.data
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/programs/selected/options/{optionkey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a selected program's option
      effect: read
      questions:
      - What value is set for a particular option of the program I just selected?
      - Can I read one program option without knowing which program is selected?
      instructions:
      - text: Get option {key} of the selected program on appliance {haId}.
        slots:
          key: path.optionkey
          haId: path.haId
      - text: Show the value of program option {key} on {haId}.
        slots:
          key: path.optionkey
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/programs/selected/options/{optionkey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change one option of the selected program
      effect: write
      questions:
      - How do I change a single option of the program my oven is showing?
      - Can I adjust one setting of the program selected on a home appliance?
      instructions:
      - text: Set option {optionkey} of the selected program on {haId} to {data}.
        slots:
          optionkey: path.optionkey
          haId: path.haId
          data: requestBody.data
      - text: Change {optionkey} on the program selected on {haId} to {data}.
        slots:
          optionkey: path.optionkey
          haId: path.haId
          data: requestBody.data
      method: generated
      generated: '2026-11-19'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/home-connect-programs-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.