{ "openapi": "3.1.0", "info": { "title": "Multilarm device API", "version": "1.2026", "description": "The local HTTP API of a Multilarm device, served by its built-in web console. All paths are relative to http://:6580. When console credentials are set, every endpoint uses HTTP Basic auth; when they are blank the console binds to loopback only.", "license": { "name": "Proprietary - free for personal, non-commercial use", "url": "https://multilarm.com/pricing.html" } }, "servers": [ { "url": "http://{host}:{port}", "variables": { "host": { "default": "multilarm.local" }, "port": { "default": "6580" } } } ], "components": { "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "basicAuth": [] } ], "paths": { "/api/alarm-folders": { "get": { "summary": "/api/alarm-folders", "description": "", "operationId": "get_alarm_folders", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/automations": { "get": { "summary": "/api/automations", "description": "", "operationId": "get_automations", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } }, "post": { "summary": "/api/automations", "description": "", "operationId": "post_automations", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/config": { "get": { "summary": "Read settings", "description": "Every configuration field and its current value.", "operationId": "get_config", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } }, "post": { "summary": "Write settings", "description": "Updates the fields present in the body. Fields you omit are left alone.", "operationId": "post_config", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/config/schema": { "get": { "summary": "Describe settings", "description": "Label, help text, group, kind, range and restart-required for every setting. Also names the string mini-language a field uses, if any.", "operationId": "get_config_schema", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/diagnostics/check": { "post": { "summary": "/api/diagnostics/check", "description": "", "operationId": "post_diagnostics_check", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/diagnostics/faults": { "get": { "summary": "/api/diagnostics/faults", "description": "", "operationId": "get_diagnostics_faults", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/diagnostics/run": { "post": { "summary": "/api/diagnostics/run", "description": "", "operationId": "post_diagnostics_run", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/display": { "get": { "summary": "/api/display", "description": "", "operationId": "get_display", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/files": { "get": { "summary": "/api/files", "description": "", "operationId": "get_files", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/files/delete": { "post": { "summary": "/api/files/delete", "description": "", "operationId": "post_files_delete", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/files/roots": { "get": { "summary": "/api/files/roots", "description": "", "operationId": "get_files_roots", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/files/upload": { "post": { "summary": "/api/files/upload", "description": "", "operationId": "post_files_upload", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/hardware/bell": { "post": { "summary": "/api/hardware/bell", "description": "", "operationId": "post_hardware_bell", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/hardware/emergency/reset": { "post": { "summary": "/api/hardware/emergency/reset", "description": "", "operationId": "post_hardware_emergency_reset", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/hardware/emergency/test": { "post": { "summary": "/api/hardware/emergency/test", "description": "", "operationId": "post_hardware_emergency_test", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/hardware/status": { "get": { "summary": "/api/hardware/status", "description": "", "operationId": "get_hardware_status", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/intercom/start": { "post": { "summary": "/api/intercom/start", "description": "", "operationId": "post_intercom_start", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/intercom/status": { "get": { "summary": "/api/intercom/status", "description": "", "operationId": "get_intercom_status", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/intercom/stop": { "post": { "summary": "/api/intercom/stop", "description": "", "operationId": "post_intercom_stop", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/listen/status": { "get": { "summary": "/api/listen/status", "description": "", "operationId": "get_listen_status", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/logs": { "get": { "summary": "Recent log lines", "description": "The device's in-memory log buffer.", "operationId": "get_logs", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/packs": { "get": { "summary": "List use-case packs", "description": "Ready-made starter scene sets for a kind of site.", "operationId": "get_packs", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/packs/apply": { "post": { "summary": "Apply a pack", "description": "Adds a pack's scenes. Purely additive: never replaces an existing scene, never touches any other setting.", "operationId": "post_packs_apply", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/presence": { "get": { "summary": "/api/presence", "description": "", "operationId": "get_presence", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/recording/status": { "get": { "summary": "/api/recording/status", "description": "", "operationId": "get_recording_status", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/scenario/fire": { "post": { "summary": "/api/scenario/fire", "description": "", "operationId": "post_scenario_fire", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/scenario/reset": { "post": { "summary": "/api/scenario/reset", "description": "", "operationId": "post_scenario_reset", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/scenarios": { "get": { "summary": "/api/scenarios", "description": "", "operationId": "get_scenarios", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/scenes": { "get": { "summary": "List scenes", "description": "Named one-tap composite actions defined for this device.", "operationId": "get_scenes", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } }, "post": { "summary": "Replace scenes", "description": "Replaces the whole scenes file. All-or-nothing: rejected if the JSON is malformed or two scenes share an id.", "operationId": "post_scenes", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/scenes/run": { "post": { "summary": "Run a scene", "description": "Starts a scene by id. Refused if another scene is already running.", "operationId": "post_scenes_run", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/scenes/status": { "get": { "summary": "Scene run state", "description": "Whether a scene is running, which one, and how many are defined.", "operationId": "get_scenes_status", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/scenes/stop": { "post": { "summary": "Stop the running scene", "description": "Stops the scene currently running, if any.", "operationId": "post_scenes_stop", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/schedule": { "get": { "summary": "Today's schedule", "description": "The events resolved for today.", "operationId": "get_schedule", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/schedule-range": { "get": { "summary": "/api/schedule-range", "description": "", "operationId": "get_schedule_range", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/shutdown": { "post": { "summary": "/api/shutdown", "description": "", "operationId": "post_shutdown", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/skip": { "post": { "summary": "Skip track", "description": "Skips the current background track.", "operationId": "post_skip", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/speak": { "post": { "summary": "Speak text", "description": "Speaks a line through the speakers. English only.", "operationId": "post_speak", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/status": { "get": { "summary": "Device status", "description": "What is playing, what is next, volume, radio state, uptime and health.", "operationId": "get_status", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/test-alarm": { "post": { "summary": "Test a scheduled sound", "description": "Plays a random scheduled sound, as a test.", "operationId": "post_test_alarm", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/test-radio": { "post": { "summary": "Test background audio", "description": "Plays a short sample of the background source.", "operationId": "post_test_radio", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/tts/dict": { "get": { "summary": "/api/tts/dict", "description": "", "operationId": "get_tts_dict", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } }, "post": { "summary": "/api/tts/dict", "description": "", "operationId": "post_tts_dict", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/tts/dict/delete": { "post": { "summary": "/api/tts/dict/delete", "description": "", "operationId": "post_tts_dict_delete", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/tts/dict/preview": { "post": { "summary": "/api/tts/dict/preview", "description": "", "operationId": "post_tts_dict_preview", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/tts/dict/resolve": { "get": { "summary": "/api/tts/dict/resolve", "description": "", "operationId": "get_tts_dict_resolve", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/tts/fill": { "post": { "summary": "/api/tts/fill", "description": "", "operationId": "post_tts_fill", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/tts/voices": { "get": { "summary": "/api/tts/voices", "description": "", "operationId": "get_tts_voices", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/volume": { "post": { "summary": "Set volume", "description": "Sets the master output level, 0.0 to 1.0.", "operationId": "post_volume", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/webhooks/status": { "get": { "summary": "/api/webhooks/status", "description": "", "operationId": "get_webhooks_status", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } } } }, "/api/webhooks/test": { "post": { "summary": "/api/webhooks/test", "description": "", "operationId": "post_webhooks_test", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Console credentials required or incorrect" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } } } }