Displays: Web Client Interface

The HTML5 Display client is a browser-based interface for connecting to and interacting with a Hoody display session. This page documents the connection and general access parameters accepted by the standardized GET /api/v1/display/ endpoint. Use these query parameters to override hostname-based configuration and customize how the client connects to the display server.

Other URL parameters accepted by this endpoint (toolbar, decorations, encoding, clipboard, file transfer, and so on) are documented on separate pages.

Access the HTML5 Display client interface

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, intended for RESTful API compliance, versioned client access, and API gateway integrations. The endpoint accepts the same URL parameters as the root endpoint for full client customization.

For example:

https://domain.com/api/v1/display/?displayId=10&readonly=true&decorations=false

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1-999999
`node`	query	string	No	Hoody node identifier (e.g., `example-1`, `example-2`)
`project_id`	query	string	No	Hoody project ID
`container_id`	query	string	No	Hoody container ID
`url_display_id`	query	string	No	Display ID for URL construction
`ssl`	query	boolean	No	Use SSL/TLS for WebSocket connection. Default: `true`
`webtransport`	query	boolean	No	Use WebTransport (HTTP3) instead of WebSocket. Default: `false`
`sound`	query	boolean	No	Enable audio forwarding. Default: `true`
`audio_codec`	query	string	No	Preferred audio codec
`reconnect`	query	boolean	No	Auto-reconnect on connection loss. Default: `true`

Response

HTML5 Display client interface loaded successfully.

{
  "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"
    }
  }
}

import { HoodyClient } from 'hoody-sdk';

const client = new HoodyClient({ baseURL: 'https://{projectId}-{containerId}-display-1.{server}.containers.hoody.com', token: process.env.HOODY_TOKEN });

await client.display.accessClient({ displayId: 10, sound: true, audio_codec: 'opus', reconnect: true });

curl -G "https://{projectId}-{containerId}-display-1.{server}.containers.hoody.com/api/v1/display/" \
  --data-urlencode "displayId=10" \
  --data-urlencode "sound=true" \
  --data-urlencode "audio_codec=opus" \
  --data-urlencode "reconnect=true"