--- updatedAt: 2026-04-20T19:11:28.000Z agentTools: projectIndex: https://developers-local.nureva.com/llms.txt --- # Get room status Allows clients to get room status, including network status, Console status, USB connection status, and devices status. Minimum role required: `general` # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Nureva Developer Toolkit", "version": "v1", "description": "Nureva Developer Toolkit provides modern local APIs to securely manage and control your device and gain unique audio insights, safely, from within your network.", "contact": { "name": "Nureva Developer Toolkit", "url": "https://developers-local.nureva.com", "email": "developers@nureva.com" } }, "servers": [ { "url": "https://{nurevaDeviceIP}", "description": "Local device connection via HTTPS", "variables": { "nurevaDeviceIP": { "default": "10.0.0.1", "description": "The device IP of the Nureva device" } } } ], "tags": [ { "name": "Local Control API" } ], "paths": { "/api/v1/status": { "summary": "Allows clients to get statuses of the room, which include network status, Nureva Console status, USB connection status, and devices status.", "get": { "x-nureva": { "minimumRoleRequired": "general", "requirements": { "supportedDeviceTypes": [ "hdl200", "hdl300", "dual-hdl", "hdl310", "hdl410", "HDX" ] }, "capabilities": { "networkA": { "requirements": { "supportedDeviceTypes": [ "hdl310", "hdl410", "HDX" ] } }, "networkB": { "requirements": { "supportedDeviceTypes": [ "HDX" ] } }, "console": { "requirements": { "supportedDeviceTypes": [ "hdl200", "hdl300", "dual-hdl", "hdl310", "hdl410", "HDX" ] } }, "usb": { "requirements": { "supportedDeviceTypes": [ "hdl200", "hdl300", "dual-hdl", "hdl310", "hdl410", "HDX" ] } }, "deviceComponents": { "requirements": { "supportedDeviceTypes": [ "hdl200", "hdl300", "dual-hdl", "hdl310", "hdl410", "HDX" ] } } } }, "parameters": [ { "$ref": "#/components/parameters/NurevaClientId" }, { "$ref": "#/components/parameters/NurevaClientVersion" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetStatus" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400-missing-header" }, "401": { "$ref": "#/components/responses/401" }, "409": { "$ref": "#/components/responses/409-unsupported-device" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } }, "security": [ { "NurevaAuth": [] } ], "operationId": "get-status", "summary": "Get room status", "description": "Allows clients to get room status, including network status, Console status, USB connection status, and devices status.\n\nMinimum role required: `general`", "tags": [ "Local Control API" ] } } }, "components": { "parameters": { "NurevaClientId": { "name": "Nureva-Client-Id", "description": "Identifier for the integration application or service. This is intended for you to specify the name of your integration. Use this same value every time your integration calls into the Nureva device. There is no strict format as long as the value is limited to 500 characters. For example, \"MyCompany Integration\", \"Power API\", \"SyncMaster\", \"Cloud Orchestrator\", \"Ultimate Audio Overlord\" are all acceptable values.", "schema": { "type": "string" }, "in": "header", "required": true }, "NurevaClientVersion": { "name": "Nureva-Client-Version", "description": "Identifier for the integration version. This is intended for you to specify the version of your integration application or service. There is no strict format as long as the value is limited to 500 characters. For example, \"1\", \"2.0\", \"1.5.2\", \"beta\", \"1.0.0-alpha\", \"1.0.0+20250102\" are all acceptable values.", "schema": { "type": "string" }, "in": "header", "required": true } }, "responses": { "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "errors": [ { "message": "Unauthorized" } ] } } }, "description": "Unauthorized. Invalid or missing credentials" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "errors": [ { "message": "Too many requests. Rate limit is exceeded" } ] } } }, "description": "Too many requests. Rate limit is exceeded" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "errors": [ { "message": "Internal Server Error. Unexpected error has occurred." } ] } } }, "description": "Internal Server Error. Unexpected error has occurred." }, "400-missing-header": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "errors": [ { "message": "RESTApi: Nureva-Client-Id is missing" }, { "message": "RESTApi: Nureva-Client-Version is missing" } ] } } }, "description": "Bad Request. Either one of the required headers are missing" }, "409-unsupported-device": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "errors": [ { "message": "Unsupported device type" } ] } } }, "description": "Conflict error. Current device is not supported for this endpoint" } }, "schemas": { "Error": { "description": "The standard format for returned errors.", "type": "object", "properties": { "errors": { "description": "Errors", "type": "array", "items": { "$ref": "#/components/schemas/ErrorMessage" } } }, "examples": [ { "errors": "Invalid Arguments" } ] }, "ErrorMessage": { "description": "Error message", "type": "object", "properties": { "message": { "description": "The error message", "type": "string" } } }, "GetStatus": { "type": "object", "required": [ "leds", "usb", "deviceComponents" ], "properties": { "leds": { "type": "object", "description": "Object that holds LED statuses of connection to network and Nureva Console.", "required": [ "console", "networkA" ], "properties": { "console": { "type": "object", "description": "LED status indicating whether the device is able to connect to Nureva Console.", "required": [ "colour", "state" ], "properties": { "colour": { "type": "string", "enum": [ "none", "red", "yellow", "green" ] }, "state": { "type": "string", "enum": [ "off", "pulsing", "blinking", "solid" ] } } }, "networkA": { "type": "object", "description": "LED status indicating the LAN connection status of the device for HDL310/410 and the LAN connection status of the device on Network A port for HDX.", "required": [ "colour", "state" ], "properties": { "colour": { "type": "string", "enum": [ "none", "red", "yellow", "green" ] }, "state": { "type": "string", "enum": [ "off", "pulsing", "blinking", "solid" ] } } }, "networkB": { "type": "object", "description": "HDX only. LED status indicating the LAN connection status of the device on Network B port.", "required": [ "colour", "state" ], "properties": { "colour": { "type": "string", "enum": [ "none", "red", "yellow", "green" ] }, "state": { "type": "string", "enum": [ "off", "pulsing", "blinking", "solid" ] } } } } }, "usb": { "type": "object", "description": "USB connection status between audio device and room computer.", "properties": { "status": { "type": "string", "enum": [ "connected", "disconnected", "unknown" ] }, "error": { "type": "string", "description": "An optional property that contains an error message if any are produced." } }, "required": [ "status" ] }, "deviceComponents": { "type": "object", "description": "Connection status between the audio device and audio components.", "properties": { "status": { "type": "string", "enum": [ "connected", "disconnected", "unknown" ] }, "error": { "type": "string", "description": "An optional property that contains an error message if any are produced." } }, "required": [ "status" ] } }, "example": { "leds": { "console": { "colour": "none", "state": "off" }, "networkA": { "colour": "red", "state": "solid" } }, "usb": { "status": "connected" }, "deviceComponents": { "status": "connected" } } } }, "securitySchemes": { "NurevaAuth": { "type": "apiKey", "in": "header", "name": "Authorization", "x-default": "Nureva ", "description": "Custom HTTP authentication security scheme which uses the `Authorization` header. Make sure to prefix the value with \\\"Nureva \\\" followed by your `authParameters`" } } }, "security": [ { "NurevaAuth": [] } ], "x-proxy-enabled": false, "x-parameter-ordering": [ "path", "query", "header", "body", "cookie", "form" ] } ```