Skip to main content
GET
Retrieve Device Settings

Authorizations

Authorization
string
header
required

Short-lived session token obtained from POST /api/sessions/v2. Send it as Authorization: Bearer <session_token> together with the X-Device-Key: <device-key> header identifying the target device.

Headers

X-Device-Key
string
required

Device Key (4 BIP39 words) identifying the target device. Obtain it from POST /device/otp/confirm/v2.

Pattern: ^[a-z]+-[a-z]+-[a-z]+-[a-z]+$
Example:

"orbit-ranch-silver-tomato"

Response

200 - application/json

OK

Device settings. Every field is optional in both directions: a request carries only the fields it wants to change, and a response omits a field the device does not report. An explicit false is a value, not an omission, so sending wifi_enabled: false or ble_enabled: false can drop the connection you are using. An unknown field name is rejected with 400.

device_name
string

The name of the device.

Example:

"My Awesome Device"

wifi_enabled
boolean

Enable/disable WiFi on device.

Example:

true

ble_enabled
boolean

Enable/disable BLE on device.

Example:

true

travel_mode
boolean

When enabled, the device powers on after a 3-second hold of the mode button; when disabled, after 500 ms.

Example:

true

intro_label
string

String shown after "Hello!" label on intro screen.

Example:

"Welcome!"

client_name
string

Client name set by the client after connection. The device stores up to 32 characters; a name written over BLE is capped at 31.

Example:

"My App"

inactivity_timeout

Seconds without activity before the device powers off. 0 means never; any other value must be within 60–86400, otherwise the request is rejected with 400. Firmware uses 900 (15 minutes) until a value is set. Supported from firmware v0.6.9; older firmware ignores it. Missing from a response when the device has it set to 0 or runs older firmware.

Available options:
0
Example:

900

playback_mode_label
string

Title of the Script Playback screen. Empty shows the default "Script Playback". A request takes up to 20 characters of printable ASCII (codes 32–126); anything else is rejected with 400. A label written over BLE may hold other characters and is returned as is. The device loses it on restart. Missing from a response when empty or when the firmware does not support it.

Maximum string length: 20
Example:

"Now playing"

playback_source_label
string

Line under the Script Playback title, e.g. the video name. Empty shows nothing. A request takes up to 20 characters of printable ASCII (codes 32–126); anything else is rejected with 400. A label written over BLE may hold other characters and is returned as is. The device loses it on restart. Missing from a response when empty or when the firmware does not support it.

Maximum string length: 20
Example:

"Beach sunset"