Displays: Input & Clipboard

This page documents the input and clipboard parameters for the HTML5 Display client endpoint. Use these query parameters to configure keyboard layout, key swapping, clipboard sharing, and scroll direction behavior when accessing the display client.

Access the HTML5 Display client interface

GET /api/v1/display/

Serves the HTML5 Display client web interface. The query parameters documented here control keyboard input, clipboard handling, and scroll direction behavior. This page covers only the input and clipboard subset — other client configuration parameters are documented separately.

Parameters

Name	In	Type	Required	Description
`keyboard`	query	boolean	No	Show on-screen virtual keyboard. Default: `false`
`keyboard_layout`	query	string	No	Keyboard layout (e.g., `us`, `gb`, `fr`, `de`). Default: `"us"`
`swap_keys`	query	boolean	No	Swap Cmd/Ctrl keys (useful for macOS). Default: `false`
`clipboard`	query	boolean	No	Enable clipboard sharing. Default: `true`
`clipboard_preferred_format`	query	string	No	Preferred clipboard format. Allowed values: `text/plain`, `text/html`, `UTF8_STRING`. Default: `"text/plain"`
`scroll_reverse_y`	query	string	No	Reverse vertical scrolling direction. Allowed values: `auto`, `true`, `false`. Default: `"auto"`
`scroll_reverse_x`	query	boolean	No	Reverse horizontal scrolling direction. Default: `false`

This endpoint takes no request body.

Response

{
  "description": "HTML5 Display client interface loaded successfully",
  "content": {
    "text/html": {
      "schema": {
        "type": "string"
      },
      "example": "<!DOCTYPE html>\n<html>\n<head><title>Hoody Display Client</title></head>\n<body>\n  <!-- Display HTML5 client interface -->\n</body>\n</html>\n"
    }
  }
}

curl -X GET "https://my-project-my-container-display-1.node.containers.hoody.icu/api/v1/display/?keyboard=false&keyboard_layout=us&swap_keys=false&clipboard=true&clipboard_preferred_format=text/plain&scroll_reverse_y=auto&scroll_reverse_x=false"

await client.display.accessClient({
  keyboard: false,
  keyboard_layout: "us",
  swap_keys: false,
  clipboard: true,
  clipboard_preferred_format: "text/plain",
  scroll_reverse_y: "auto",
  scroll_reverse_x: false
});