Home Connect (BSH appliances) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Home Connect Map API

16 actions 16 updates phrasing extends openapi/home-connect-map-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 16

$.info
$.paths['/homeappliances/{haId}/map/maps'].get
$.paths['/homeappliances/{haId}/map/maps/{mapId}'].get
$.paths['/homeappliances/{haId}/map/maps/{mapId}/occupancyGrid'].get
$.paths['/homeappliances/{haId}/map/maps/{mapId}/layout'].get
$.paths['/homeappliances/{haId}/map/maps/{mapId}/cleaningStatus'].get
$.paths['/homeappliances/{haId}/map/maps/{mapId}/cleaningStatus/objects'].get
$.paths['/homeappliances/{haId}/map/maps/{mapId}/cleaningStatus/objects/{objectId}'].get
$.paths['/homeappliances/{haId}/map/maps/{mapId}/rooms'].get
$.paths['/homeappliances/{haId}/map/maps/{mapId}/rooms/{roomId}'].get
$.paths['/homeappliances/{haId}/map/maps/{mapId}/zones'].get
$.paths['/homeappliances/{haId}/map/maps/{mapId}/zones/{zoneId}'].get
$.paths['/homeappliances/{haId}/map/robot/position'].get
$.paths['/homeappliances/{haId}/map/config/restrictions'].get
$.paths['/homeappliances/{haId}/map/cleaningSummary'].get
$.paths['/homeappliances/{haId}/map/cleaningSummary/{counter}'].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 Map API
  version: 1.0.0
extends: openapi/home-connect-map-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: 15
- target: $.paths['/homeappliances/{haId}/map/maps'].get
  update:
    x-apievangelist-phrasing:
      intent: List saved cleaning maps of a robot
      effect: read
      questions:
      - Which cleaning maps does my robot remember?
      - Can I see temporary maps that are not saved yet?
      instructions:
      - text: List cleaning maps for robot {haId}.
        slots:
          haId: path.haId
      - text: Show every map known to robot {haId}.
        slots:
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/map/maps/{mapId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a map's basic info
      effect: read
      questions:
      - What is the basic information for one map on my robot?
      - Can I fetch a single map by its ID?
      instructions:
      - text: Get map {mapId} on robot {haId}.
        slots:
          mapId: path.mapId
          haId: path.haId
      - text: Show the metadata of map {mapId} from robot {haId}.
        slots:
          mapId: path.mapId
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/map/maps/{mapId}/occupancyGrid'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a map's raw grid layout
      effect: read
      questions:
      - How do I get the raw grid layout of a robot map?
      - Is the occupancy grid delivered compressed?
      instructions:
      - text: Get the occupancy grid of map {mapId} on robot {haId}.
        slots:
          mapId: path.mapId
          haId: path.haId
      - text: Download the raw layout grid for map {mapId} from robot {haId}.
        slots:
          mapId: path.mapId
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/map/maps/{mapId}/layout'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a map's vector walls and doors
      effect: read
      questions:
      - Where are the walls and doors on my robot's map?
      - Can I get the vector-based layout of a map?
      instructions:
      - text: Get the vector layout of map {mapId} on robot {haId}.
        slots:
          mapId: path.mapId
          haId: path.haId
      - text: Show the walls and doors on map {mapId} from robot {haId}.
        slots:
          mapId: path.mapId
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/map/maps/{mapId}/cleaningStatus'].get
  update:
    x-apievangelist-phrasing:
      intent: Get how far a map is cleaned
      effect: read
      questions:
      - Which parts of the saved map have already been cleaned?
      - What cleaning progress has the robot made so far on this map?
      instructions:
      - text: Get the cleaning status of map {mapId} on robot {haId}.
        slots:
          mapId: path.mapId
          haId: path.haId
      - text: Show which path map {mapId} has already covered on robot {haId}.
        slots:
          mapId: path.mapId
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/map/maps/{mapId}/cleaningStatus/objects'].get
  update:
    x-apievangelist-phrasing:
      intent: List objects detected on a map
      effect: read
      questions:
      - What stains or pets has my robot detected on a map?
      - Can I see all detected objects on one map?
      instructions:
      - text: List detected objects on map {mapId} of robot {haId}.
        slots:
          mapId: path.mapId
          haId: path.haId
      - text: Show every object detected on map {mapId} from robot {haId}.
        slots:
          mapId: path.mapId
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/map/maps/{mapId}/cleaningStatus/objects/{objectId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one detected object on a map
      effect: read
      questions:
      - Can I look up a single detected object by its ID?
      - What does one detected object on a map look like?
      instructions:
      - text: Get detected object {objectId} on map {mapId} of robot {haId}.
        slots:
          objectId: path.objectId
          mapId: path.mapId
          haId: path.haId
      - text: Show the details of object {objectId} detected on map {mapId} from robot {haId}.
        slots:
          objectId: path.objectId
          mapId: path.mapId
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/map/maps/{mapId}/rooms'].get
  update:
    x-apievangelist-phrasing:
      intent: List rooms defined on a map
      effect: read
      questions:
      - Which rooms are defined on my robot's map?
      - Can I see all the room boundaries on a map?
      instructions:
      - text: List rooms on map {mapId} of robot {haId}.
        slots:
          mapId: path.mapId
          haId: path.haId
      - text: Show every room defined on map {mapId} from robot {haId}.
        slots:
          mapId: path.mapId
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/map/maps/{mapId}/rooms/{roomId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one room on a map
      effect: read
      questions:
      - Can I fetch a single room by its ID?
      - What are the details of one room on a map?
      instructions:
      - text: Get room {roomId} on map {mapId} of robot {haId}.
        slots:
          roomId: path.roomId
          mapId: path.mapId
          haId: path.haId
      - text: Show the details of room {roomId} from map {mapId} on robot {haId}.
        slots:
          roomId: path.roomId
          mapId: path.mapId
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/map/maps/{mapId}/zones'].get
  update:
    x-apievangelist-phrasing:
      intent: List zones and no-go areas on a map
      effect: read
      questions:
      - What no-go zones or virtual barriers are on my robot's map?
      - Can I see all zones defined on a map?
      instructions:
      - text: List zones on map {mapId} of robot {haId}.
        slots:
          mapId: path.mapId
          haId: path.haId
      - text: Show every no-go zone on map {mapId} from robot {haId}.
        slots:
          mapId: path.mapId
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/map/maps/{mapId}/zones/{zoneId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one zone on a map
      effect: read
      questions:
      - Can I fetch a single zone by its ID?
      - What are the details of one zone on a map?
      instructions:
      - text: Get zone {zoneId} on map {mapId} of robot {haId}.
        slots:
          zoneId: path.zoneId
          mapId: path.mapId
          haId: path.haId
      - text: Show the details of zone {zoneId} from map {mapId} on robot {haId}.
        slots:
          zoneId: path.zoneId
          mapId: path.mapId
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/map/robot/position'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the robot's current position
      effect: read
      questions:
      - Where is my robot right now?
      - Which map is the robot currently on?
      instructions:
      - text: Get the current position of robot {haId}.
        slots:
          haId: path.haId
      - text: Tell me where robot {haId} is located and which map it's on.
        slots:
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/map/config/restrictions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get map, room and zone limits
      effect: read
      questions:
      - What map and zone limits does my robot support?
      - Which values are allowed for rooms and zones on my robot?
      instructions:
      - text: Get the map configuration restrictions for robot {haId}.
        slots:
          haId: path.haId
      - text: Show which map, room and zone properties robot {haId} supports.
        slots:
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/map/cleaningSummary'].get
  update:
    x-apievangelist-phrasing:
      intent: List cleaning run summaries
      effect: read
      questions:
      - What cleaning runs has my robot stored?
      - Can I see summaries of past cleanings with their map data?
      instructions:
      - text: List all cleaning summaries for robot {haId}.
        slots:
          haId: path.haId
      - text: Show every cleaning run summary stored on robot {haId}.
        slots:
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/map/cleaningSummary/{counter}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a cleaning run's summary
      effect: read
      questions:
      - What does the summary of one cleaning run say?
      - Can I read the result of a specific cleaning pass?
      instructions:
      - text: Get cleaning summary {counter} for robot {haId}.
        slots:
          counter: path.counter
          haId: path.haId
      - text: Show the cleaning result for cleaning run {counter} on robot {haId}.
        slots:
          counter: path.counter
          haId: path.haId
      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-map-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.