Displays: Web Client Interface

Access the HTML5 Display Client

The standardized API version of the root display client endpoint. Use it for RESTful integrations, API gateway routing, and versioned client access. The endpoint serves the HTML5 Display client interface and accepts URL-based configuration parameters that mirror the root endpoint’s behavior.

`GET /api/v1/display/`

Serves the HTML5 Display client web interface with optional URL-based configuration.

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., `sg-sin-1`, `us-nyc-1`)
`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`

This endpoint takes no request body.

curl "https://domain.com/api/v1/display/?displayId=10&node=sg-sin-1&project_id=proj_abc123&container_id=cont_xyz789&ssl=true&sound=true&reconnect=true"

client.display.accessClient(
    displayId=10,
    node="sg-sin-1",
    project_id="proj_abc123",
    container_id="cont_xyz789",
    ssl=True,
    webtransport=False,
    sound=True,
    audio_codec="opus",
    reconnect=True
)

HTML5 Display client interface loaded successfully.

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