Displays: UI & Theming

Configure how the HTML5 Display client interface looks and behaves — window decorations, toolbar visibility, menu controls, dark mode, the floating menu, the server clock, and the browser title bar. All options are passed as query parameters on the display client URL.

This page documents the UI theming and decoration parameters for the display client. The same endpoint accepts many additional parameters (audio, video, clipboard, networking, debug, etc.) which are covered on other pages.

Access the Display Client

`GET /api/v1/display/`

Serves the HTML5 Display client web interface with optional URL-based configuration. This is the standardized API version of the root endpoint.

Use this endpoint for:

RESTful API compliance
Versioned client access
API gateway integrations

The client accepts query parameters to customize window decorations, toolbar visibility, menu controls, dark mode, the floating menu, the on-screen clock, and the browser title text.

cURL
SDK

curl -G "https://domain.com/api/v1/display/" \
  --data-urlencode "displayId=10" \
  --data-urlencode "decorations=false" \
  --data-urlencode "toolbar=false" \
  --data-urlencode "menu=true" \
  --data-urlencode "dark_mode=true" \
  --data-urlencode "floating_menu=false" \
  --data-urlencode "clock=true" \
  --data-urlencode "title_show_hoody=true" \
  --data-urlencode "title_show_display_id=false"

const result = await client.display.accessClient({
  displayId: 10,
  decorations: false,
  toolbar: false,
  menu: true,
  dark_mode: true,
  floating_menu: false,
  clock: true,
  title_show_hoody: true,
  title_show_display_id: false
});

Parameters

Name	In	Type	Required	Description
`decorations`	query	boolean	No	Show window decorations (title bar with close/minimize/maximize buttons). Set to `false` for headless/kiosk mode. Default: `true`
`toolbar`	query	boolean	No	Show entire toolbar/menu area (menu trigger + menu). Set to `false` to hide all menu UI elements. Takes precedence over the `menu` parameter. Default: `true`
`menu`	query	boolean	No	Show Hoody menu trigger icon. Set to `false` to hide the menu completely. Note: the `toolbar` parameter takes precedence over this. Default: `true`
`dark_mode`	query	boolean	No	Enable dark mode theme. Default: `false`
`floating_menu`	query	boolean	No	Show floating menu. Default: `true`
`clock`	query	boolean	No	Show server clock. Default: `true`
`title_show_hoody`	query	boolean	No	Show “Hoody” in browser title. Default: `true`
`title_show_display_id`	query	boolean	No	Show display ID in browser title. Default: `true`

Response

<!DOCTYPE html>
<html>
<head><title>Hoody Display Client</title></head>
<body>
  <!-- Display HTML5 client interface -->
</body>
</html>