Skip to content

Beta: these docs are still being updated. The next full update is on 19 November at 8 PM UTC. Docs in beta. Full update 19 Nov, 8 PM UTC.

Hoody.com

Lookup tables for Embed a kit UI in your own page.

In the SDK a refusal is an EmbedValidationError whose code is one of these. The CLI prints the same refusal as Error: … and exits 1.

CodeMeaning
KIT_UNKNOWN, VIEW_UNKNOWNThe kit or view name is not in the catalog.
KIT_NOT_BUILDABLEThe kit has no browser UI to embed.
INDEX_OUT_OF_RANGE, INDEX_NOT_SUPPORTED, PORT_INVALIDThe instance number or port is outside what the service accepts.
HOST_LABEL_TOO_LONGA hostname label would be longer than 63 characters.
TARGET_INVALIDThe computer fields are missing or cannot form a hostname.
LOCAL_REFUSEDA local URL was requested. Several kit UIs only work at the root of their host.
PARAM_EXCLUDED, PARAM_FORCED, PARAM_NON_UI, PARAM_DEADThe parameter is a credential, changes state, is set by the platform, is not a UI parameter, or has no effect.
PARAM_UNKNOWN, PARAM_NOT_ON_VIEW, PARAM_NOT_TYPED, QUERY_NOT_PASSTHROUGHThe parameter is not accepted by this view, or not in the form given.
REQUIRED_MISSING, VALUE_INVALID, PATH_INVALIDA required parameter is missing, or a value is outside its allowed values or pattern.
DUPLICATE_KEY, CONST_OVERRIDEA key was given twice, or a fixed value of the view was overridden.
ALIAS_URL_MISSING, ALIAS_MISMATCH, ALIAS_VIEW_UNSUPPORTED, ALIAS_TARGET_PATH_CONFLICTThe alias cannot serve this view: it has no URL, targets another program or instance, the view refuses aliases, or the alias sets a target path for a view whose path is /.
CommandWhat it does
hoody <kit> open [index]Opens the kit’s default view in your browser, or the view the flags select. SQLite is hoody db open, also hoody kv open, where --view kvStore opens the key-value store.
--view <name>Opens a named view, on a kit that has more than one view.
--urlPrints the URL only: nothing is opened or started.
--query-param <key=value>Adds a query parameter the view accepts as-is, repeatable. On hoody exec open and hoody display open.
--no-starthoody browser open only: skips starting the browser instance before opening its page.
hoody open <kit> [index]Runs that kit’s open.
hoody open http <port>, hoody open https --port <port>, hoody open http-8080Opens your application on a port. --path sets the path inside it (default /).
hoody code embed <publisher.name> [index]Prints the code.extension URL; --open opens it instead.

A boolean parameter is a switch: --read-only sends true and --no-read-only sends false. A parameter that takes a JSON object, such as the terminal and agent theme, has no flag; set it with the SDK.

FunctionReturns
client.embeds.<kit>.<view>(target, options)The URL of one view. The target is a computer response (or its id, project_id and server_name) or a proxy alias; it can be left out only on a withComputer() client, and an unscoped call without one is refused. options takes index (port for http and https), params and query. params takes the view’s typed parameters by name: every parameter of every view except 36 of display.client’s. query takes those 36, the parameters whose catalog class is passthrough (on display.client only decorations, toolbar, menu, maximize_new_windows, readonly, dark_mode, clipboard, printing, file_transfer, title_show_hoody, title_show_display_id, parent_keys and parent_origin are typed), plus any extra key on http.content, https.content and exec.script. A passthrough parameter in params is refused with PARAM_NOT_TYPED, and a typed one in query with QUERY_NOT_PASSTHROUGH.
client.embeds.getUrl(kit, target, options)The URL of any view by kit name; options.view picks the view, default the kit’s default.
client.embeds.listViews(kit)The kit’s view IDs, such as files.folder, default first.
client.embeds.getCatalog()The whole construction catalog.
buildEmbedUrl(kit, computer, options, config)A URL without a client, from the fields a computer response carries (id, project_id, server_name). Use it in code that has those fields but no HoodyClient, such as a browser page. Pass the API base URL or computers domain as the fourth argument, for example buildEmbedUrl(kit, computer, options, { baseUrl: 'https://api.hoody.com' }). Always supply this configuration when building public Hoody URLs.

Both entry points of the package, Node and browser, export these functions. The catalog is published at /embeds/catalog.v1.json; use the catalog supplied with your SDK version when building URLs for that version. To build a URL by hand, fill the catalog’s host template with the computer’s fields and the view’s path, then append the query parameters in the order the catalog’s serialization section gives.

Pipe page links open in the browser, so they do not carry the SDK’s kitAuth headers: the browser itself must be allowed by the computer’s access rule. Direct pipe links, including autostart, which the builder refuses, are on the Pipe page.

LimitValue
Send page name in an embed URL1023 characters
Pipe path values in an embed URL1023 characters after percent-encoding
noscriptPathA separate 1024-character limit
Names in direct pipe links and PipeMedia.getPageUrl()Up to 1024 encoded characters
n, a fixed viewer countNot accepted by the pipe.video embed view. Use a direct ?video&n=3 link or media.getPageUrl('video', 'demo', { n: 3 }).

The tables below are generated from the construction catalog at /embeds/catalog.v1.json, its machine-readable form. Parameters are listed by their URL query name; the SDK’s embed options use the same names, except that pipe.noscript takes its path as noscriptPath.

Web terminal sessions in the browser.

ViewLabelPathRequiredFrameableAliasNotes
terminal.sessionTerminal session/noneyesnodefault, starts a process

A browser terminal attached to one session. Opening it starts a shell if the session is not running; a terminal that belongs to a daemon program attaches to that program instead and never starts a shell.

ParameterInValuesDescription
cwdquerystringStarting directory for a new session. The directory must already exist.
readonlyquerybooleanOpen the session read-only: output is shown, keyboard input is blocked.
titlequerystringBrowser tab title. HTML tags are removed.
fontSizequeryinteger (≥ 8, ≤ 72)Font size in pixels.
backgroundColorquerystringBackground colour: a hex colour (#RGB, #RRGGBB, #RRGGBBAA) or a CSS colour name.
panelqueryURLAn http(s) URL to show in a side panel next to the terminal.
panel-visiblequerybooleanShow the side panel on load.
panel-positionqueryleft, right, top, bottomWhere the side panel sits.
panel-widthquerystringInitial side-panel width, in pixels (400px) or percent, for a left or right panel.
panel-heightquerystringInitial side-panel height, in pixels (300px) or percent, for a top or bottom panel.
panel-resizablequerybooleanAllow resizing the side panel by dragging.
panel-width-pctqueryinteger (≥ 5, ≤ 95)Initial side-panel width as a percentage of the window. Takes precedence over panel-width.
panel-height-pctqueryinteger (≥ 5, ≤ 95)Initial side-panel height as a percentage of the window. Takes precedence over panel-height.
hide-toolbarquerybooleanHide the terminal toolbar.
fontFamilyquerystringCSS font-family list for terminal text.
fontWeightquerynormal, bold, 100, 200, 300, 400, 500, 600, 700, 800, 900Font weight for normal text.
fontWeightBoldquerynormal, bold, 100, 200, 300, 400, 500, 600, 700, 800, 900Font weight for bold text.
lineHeightqueryinteger (≥ 1)Line height as a multiple of the font size.
letterSpacingqueryintegerExtra spacing between characters, in whole pixels.
cursorBlinkquerybooleanMake the cursor blink.
cursorStylequeryblock, underline, barCursor shape when the terminal has focus.
cursorWidthqueryinteger (≥ 1)Cursor width in pixels when the cursor style is bar.
cursorInactiveStylequeryoutline, block, bar, underline, noneCursor shape when the terminal does not have focus.
themequeryobject (JSON)Colour theme as a JSON object (foreground, background, cursor, and the 16 ANSI colours).
minimumContrastRatioqueryinteger (≥ 1, ≤ 21)Minimum contrast ratio between text and background; colours are adjusted to meet it.
drawBoldTextInBrightColorsquerybooleanDraw bold text in the bright colour variants.
scrollbackqueryinteger (≥ 0, ≤ 100000)Number of lines kept above the visible screen.
scrollSensitivityqueryinteger (≥ 1)Scroll speed multiplier.
fastScrollSensitivityqueryinteger (≥ 1)Scroll speed multiplier while Alt is held.
smoothScrollDurationqueryinteger (≥ 0)Smooth-scroll duration in milliseconds; 0 scrolls instantly.
screenReaderModequerybooleanEnable screen-reader support.
disableResizeOverlayquerybooleanDo not show the size overlay while the window is resized.
unicodeVersionquerygraphemes, 11Character-width rules: graphemes (default, emoji-aware) or 11.
rendererTypequerydom, canvas, webglRenderer used to draw the terminal: webgl (the default; Firefox uses dom), dom, or canvas (drawn with WebGL). Phones, tablets and other touch-screen devices use dom even when webgl or canvas is asked for. Try dom if text renders wrongly with WebGL on a particular browser or GPU.
parent_keysquerybooleanHand two keyboard chords to the page that frames the terminal: Ctrl+Alt+B and Ctrl+Alt with an arrow key are not sent to the terminal, and that page receives a hoody-parent-key message naming the chord (escape, left, right, up or down), sent only to its own origin. Without a framing page the keys work as usual.
parent_originqueryURLThe origin of the page that frames the terminal, such as https://app.example.com, for parent_keys. Used when the browser sends no referrer naming that page. The terminal keeps the origin it uses in its own address, so its own reloads keep reaching that page. Ignored unless it is an http or https origin.

Refused parameters: terminal_id (forced; use serviceIndex), display (forced; use serviceIndex), cwd_auto_create (mutating), shell (mutating), user (mutating), cmd (mutating), arg (mutating), reset (mutating), pid (mutating), env (mutating), startup_script (mutating), welcome (mutating), debug (mutating), env_inject (mutating), desktop (mutating), redirect (mutating), agent (mutating), ephemeral (mutating), desktop_env (mutating), ssh_host (credential), ssh_user (credential), ssh_port (credential), ssh_password (credential), ssh_key (credential), socks5_host (credential), socks5_port (credential), socks5_user (credential), socks5_pass (credential), redirect_delay (non-ui), wait_timeout (non-ui).

A full graphical desktop environment in the browser.

ViewLabelPathRequiredFrameableAliasNotes
desktop.sessionDesktop/noneyesnodefault, starts a process

A full graphical desktop. Opening it starts the desktop if needed, then shows it once it is ready.

ParameterInValuesDescription
desktop_envqueryxfce, mateDesktop environment to start.
redirect_delayqueryinteger (≥ 0, ≤ 30)Extra seconds to wait after the desktop is ready before it opens.
wait_timeoutqueryinteger (≥ 1, ≤ 300)Seconds to wait for the desktop to become ready.

Refused parameters: terminal_id (forced; use serviceIndex), display (forced; use serviceIndex), desktop (forced; use view), redirect (forced; use view), cwd_auto_create (mutating), shell (mutating), user (mutating), cmd (mutating), arg (mutating), reset (mutating), pid (mutating), env (mutating), startup_script (mutating), welcome (mutating), debug (mutating), env_inject (mutating), agent (mutating), ssh_host (credential), ssh_user (credential), ssh_port (credential), ssh_password (credential), ssh_key (credential), socks5_host (credential), socks5_port (credential), socks5_user (credential), socks5_pass (credential), cwd (non-ui), readonly (non-ui), title (non-ui), fontSize (non-ui), backgroundColor (non-ui), panel (non-ui), panel-visible (non-ui), panel-position (non-ui), panel-width (non-ui), panel-height (non-ui), panel-resizable (non-ui), panel-width-pct (non-ui), panel-height-pct (non-ui), hide-toolbar (non-ui), fontFamily (non-ui), fontWeight (non-ui), fontWeightBold (non-ui), lineHeight (non-ui), letterSpacing (non-ui), cursorBlink (non-ui), cursorStyle (non-ui), cursorWidth (non-ui), cursorInactiveStyle (non-ui), theme (non-ui), minimumContrastRatio (non-ui), drawBoldTextInBrightColors (non-ui), scrollback (non-ui), scrollSensitivity (non-ui), fastScrollSensitivity (non-ui), smoothScrollDuration (non-ui), screenReaderMode (non-ui), disableResizeOverlay (non-ui), unicodeVersion (non-ui), rendererType (non-ui), ephemeral (mutating), parent_keys (non-ui), parent_origin (non-ui).

The Hoody agent’s interactive interface.

ViewLabelPathRequiredFrameableAliasNotes
agent.webuiAgent/noneyesnodefault, starts a process

The agent’s interactive interface in a browser terminal. Opening it starts the agent if it is not running.

ParameterInValuesDescription
titlequerystringBrowser tab title. HTML tags are removed.
fontSizequeryinteger (≥ 8, ≤ 72)Font size in pixels.
backgroundColorquerystringBackground colour: a hex colour (#RGB, #RRGGBB, #RRGGBBAA) or a CSS colour name.
panelqueryURLAn http(s) URL to show in a side panel next to the terminal.
panel-visiblequerybooleanShow the side panel on load.
panel-positionqueryleft, right, top, bottomWhere the side panel sits.
panel-widthquerystringInitial side-panel width, in pixels (400px) or percent, for a left or right panel.
panel-heightquerystringInitial side-panel height, in pixels (300px) or percent, for a top or bottom panel.
panel-resizablequerybooleanAllow resizing the side panel by dragging.
panel-width-pctqueryinteger (≥ 5, ≤ 95)Initial side-panel width as a percentage of the window. Takes precedence over panel-width.
panel-height-pctqueryinteger (≥ 5, ≤ 95)Initial side-panel height as a percentage of the window. Takes precedence over panel-height.
fontFamilyquerystringCSS font-family list for terminal text.
fontWeightquerynormal, bold, 100, 200, 300, 400, 500, 600, 700, 800, 900Font weight for normal text.
fontWeightBoldquerynormal, bold, 100, 200, 300, 400, 500, 600, 700, 800, 900Font weight for bold text.
lineHeightqueryinteger (≥ 1)Line height as a multiple of the font size.
letterSpacingqueryintegerExtra spacing between characters, in whole pixels.
cursorBlinkquerybooleanMake the cursor blink.
cursorStylequeryblock, underline, barCursor shape when the terminal has focus.
cursorWidthqueryinteger (≥ 1)Cursor width in pixels when the cursor style is bar.
cursorInactiveStylequeryoutline, block, bar, underline, noneCursor shape when the terminal does not have focus.
themequeryobject (JSON)Colour theme as a JSON object (foreground, background, cursor, and the 16 ANSI colours).
minimumContrastRatioqueryinteger (≥ 1, ≤ 21)Minimum contrast ratio between text and background; colours are adjusted to meet it.
drawBoldTextInBrightColorsquerybooleanDraw bold text in the bright colour variants.
scrollbackqueryinteger (≥ 0, ≤ 100000)Number of lines kept above the visible screen.
scrollSensitivityqueryinteger (≥ 1)Scroll speed multiplier.
fastScrollSensitivityqueryinteger (≥ 1)Scroll speed multiplier while Alt is held.
smoothScrollDurationqueryinteger (≥ 0)Smooth-scroll duration in milliseconds; 0 scrolls instantly.
screenReaderModequerybooleanEnable screen-reader support.
disableResizeOverlayquerybooleanDo not show the size overlay while the window is resized.
unicodeVersionquerygraphemes, 11Character-width rules: graphemes (default, emoji-aware) or 11.
rendererTypequerydom, canvas, webglRenderer used to draw the terminal: webgl (the default; Firefox uses dom), dom, or canvas (drawn with WebGL). Phones, tablets and other touch-screen devices use dom even when webgl or canvas is asked for. Try dom if text renders wrongly with WebGL on a particular browser or GPU.
parent_keysquerybooleanHand two keyboard chords to the page that frames the terminal: Ctrl+Alt+B and Ctrl+Alt with an arrow key are not sent to the terminal, and that page receives a hoody-parent-key message naming the chord (escape, left, right, up or down), sent only to its own origin. Without a framing page the keys work as usual.
parent_originqueryURLThe origin of the page that frames the terminal, such as https://app.example.com, for parent_keys. Used when the browser sends no referrer naming that page. The terminal keeps the origin it uses in its own address, so its own reloads keep reaching that page. Ignored unless it is an http or https origin.

Refused parameters: terminal_id (forced; use serviceIndex), display (forced; use serviceIndex), agent (forced; use view), cwd_auto_create (mutating), shell (mutating), user (mutating), cmd (mutating), arg (mutating), reset (mutating), pid (mutating), env (mutating), startup_script (mutating), welcome (mutating), debug (mutating), env_inject (mutating), desktop (mutating), redirect (mutating), onboarding (mutating), desktop_env (mutating), cwd (mutating), readonly (mutating), ssh_host (credential), ssh_user (credential), ssh_port (credential), ssh_password (credential), ssh_key (credential), socks5_host (credential), socks5_port (credential), socks5_user (credential), socks5_pass (credential), redirect_delay (non-ui), wait_timeout (non-ui), ephemeral (mutating).

Web viewer for one remote display.

ViewLabelPathRequiredFrameableAliasNotes
display.clientDisplay/noneyesyesdefault

Opens the display in the web viewer.

ParameterInValuesDescription
decorationsquerybooleanShow window title bars and buttons. Set false for a frameless look.
toolbarquerybooleanShow the toolbar. false hides it, exactly as menu=false does.
menuquerybooleanShow the menu button. false hides it, exactly as toolbar=false does.
maximize_new_windowsquerybooleanOpen new application windows maximized. On by default; off by default when decorations is false or 0, since a window without a title bar has nothing to restore it from. Set false to keep the centred placement. On a desktop smaller than 1024 pixels in either direction new windows fill the screen whatever this says; dialogs, menus and fixed-size windows are never maximized.
readonlyquerybooleanView-only mode: keyboard and mouse input is not sent.
dark_modequerybooleanUse the dark colour scheme.
colorSchemequerylight, dark, systemColour scheme of the viewer: light, dark, or system to follow the device. The default is system. If dark_mode is also set, system wins over it and dark_mode=true wins over light.
themequeryoc-1, aura, ayu, carbonfox, catppuccin, dracula, gruvbox, monokai, nightowl, nord, onedarkpro, shadesofpurple, solarized, tokyonight, vesperColour theme of the viewer interface. The default is oc-1.
fontquerystringFont family of the viewer interface, by name, for example Inter or IBM Plex Mono. Letters, digits, spaces, underscores and hyphens only. A name the browser cannot find falls back to Inter. By default the viewer uses its own font.
encodingqueryauto, webp, jpeg, png, rgbEncoding the viewer asks the server to use for window updates. Defaults to webp, which keeps text sharp. auto lets the server choose, and it may switch busy windows to a video encoding that looks blurry. The server only uses an encoding that both ends support.
quality_modequeryauto, best, reducedHow the viewer picks image quality, the same choice as the Image Quality menu. auto (the default) uses full quality and switches to a lower one while the connection is detected as slow, then back; each switch reconnects the viewer, so it needs reconnect to be on (with reconnect off the viewer stays at full quality). best always uses full quality. reduced uses a lower quality, for picture formats that have one: png, rgb and avif encodings stay as they are. Any other value counts as auto. A fixed quality overrides it.
qualityqueryinteger (≥ 0, ≤ 100)Fixed image quality for this viewer, 0 to 100. Unset, quality_mode decides, and a fixed quality wins over it. It also hides the Image Quality choice in the menu. Lossless encodings (png, rgb) ignore it.
offscreenquerybooleanDecode and paint in a Web Worker (offscreen canvas). On by default in Chrome and Chromium over https and in Firefox 108 or later; never on Safari or other WebKit browsers, where it stays off even if you ask for it. false turns it off.
scrollquerybooleanLet the server send region copies instead of new pixels when a window scrolls, which keeps scrolling smooth. On by default except in Safari. Without this parameter the viewer offers it only to a server it has already found safe for it, and only with reconnect on; true or false forces the choice.
bandwidth_limitqueryinteger (≥ 0)Bandwidth limit for this viewer in bits per second; 0 means unlimited.
override_widthquerystringWidth in pixels of the desktop the viewer asks for; the page scales it to fit the window. auto (the default) uses the window’s own width.
vrefreshqueryintegerScreen refresh rate in Hz sent to the server. Unset, or -1, the viewer measures it and uses 60 when it cannot.
suspend_inactive_tabquerybooleanPause updates while the browser tab is hidden.
soundquerybooleanPlay the session’s audio in the viewer.
audio_codecquerystringPreferred audio codec.
keyboardquerybooleanShow the on-screen keyboard from the start. On by default in mobile browsers and off elsewhere; the keyboard button in the menu opens and closes it either way.
swap_keysquerybooleanSwap the Ctrl and Cmd (Meta) keys. On by default on macOS and off elsewhere.
scroll_speedquerynumber (≥ 0.2, ≤ 3)Scroll speed multiplier for a mouse wheel. 1 is normal. The default is 1; the page keeps it between 0.2 and 3.
touchpad_scroll_scalequerynumber (≥ 0.2, ≤ 2)Scroll speed multiplier for a touchpad. Lower values make scrolling less sensitive. The default is 0.85; the page keeps it between 0.2 and 2.
clipboardqueryfalseSet false to turn clipboard sharing off for this viewer.
clipboard_preferred_formatquerytext/plain, text/html, UTF8_STRINGPreferred clipboard format.
clipboard_pollqueryfalseSet false to stop the viewer polling your local clipboard for changes to send to the session. Polling is on by default, except in Firefox, and in Safari over https.
printingqueryfalseSet false to turn print forwarding off.
file_transferqueryfalseSet false to turn file transfer off.
videoquerybooleanAllow video encodings.
display_notificationsquerybooleanShow notifications inside the display view.
reconnectquerybooleanReconnect automatically after a lost connection.
reconnect_countqueryinteger (≥ 1, ≤ 1000)How many quick reconnect attempts the viewer makes after a connection that worked is lost, before it stops. The default is 30. Needs reconnect to be on.
soft_giveup_attemptsqueryinteger (≥ 1, ≤ 1000)Failed attempts to reach a display that has not connected yet before the viewer reports that it cannot connect and moves to slow retries. The default is 30. The time limit soft_giveup_ms counts too, whichever comes first.
soft_giveup_msqueryinteger (≥ 1000, ≤ 3600000)Milliseconds of failed attempts to reach a display that has not connected yet before the viewer reports that it cannot connect and moves to slow retries. The default is 90000.
slow_retry_delayqueryinteger (≥ 2000, ≤ 300000)Milliseconds between the slow retries that follow that report. The default is 15000.
slow_retry_max_msqueryinteger (≥ 0, ≤ 7200000)Milliseconds, counted from the first attempt, after which a viewer that has never connected stops its slow retries and closes. It is checked only once the first-connection give-up (soft_giveup_attempts, soft_giveup_ms) has happened, and does not apply after a connection that worked is lost (reconnect_count covers that). 0 removes this limit only. The default is 1200000 (20 minutes).
floating_menuquerybooleanShow the floating menu. false hides it together with the menu button.
clockquerybooleanShow the server clock.
scroll_reverse_yqueryauto, true, falseReverse vertical scrolling: auto, true or false.
scroll_reverse_xquerybooleanReverse horizontal scrolling.
title_show_hoodyquerybooleanShow Hoody in the page title.
title_show_display_idquerybooleanShow the display number in the page title.
recordquerybooleanStart recording the display in the browser about two seconds after the recorder is ready, which is after the viewer has painted the display for the first time (or 4 seconds after it began waiting for that paint, if nothing paints). mp4 and webm recordings normally stream to a browser download; some browsers download only after recording stops, and if the viewer falls back to buffering, use its Download menu after stopping. A gif downloads automatically after rendering. See record_format, record_codec and record_fps. The default is off.
record_formatquerymp4, webm, gifFile format of the recording started by record: mp4, webm or gif. The default is mp4.
record_codecqueryh264, h265, vp8, vp9Video codec of the recording: h264 or h265 for mp4, vp8 or vp9 for webm. The default is h264 for mp4 and vp9 (else vp8) for webm. A codec the format or the browser does not support is replaced by another codec of the same format when the browser has one; when it has none (no mp4 codec, or no webm support), recording does not start and the viewer does not switch to another format. gif has no codec.
record_fpsqueryinteger (≥ 1, ≤ 60)Frames per second of the recording, 1 to 60. The default is 30, or 10 for gif.
parent_keysquerybooleanHand two keyboard chords to the page that frames the viewer: Ctrl+Alt+B and Ctrl+Alt with an arrow key are not sent to the display, and that page receives a hoody-parent-key message naming the chord (escape, left, right, up or down), sent only to its own origin. Without a framing page the keys work as usual.
parent_originqueryURLThe origin of the page that frames the viewer, such as https://app.example.com, for parent_keys. Used when the browser sends no referrer naming that page. The viewer keeps the origin it uses in its own address, so its own reloads and reconnects keep reaching that page. Ignored unless it is an http or https origin.

Refused parameters: displayId (mutating), node (mutating), project_id (mutating), computer_id (mutating), url_display_id (mutating), ssl (mutating), webtransport (mutating), path (mutating), action (mutating), display (mutating), override_height (not-supported), keyboard_layout (mutating), open_url (not-supported), notification_server_url (mutating), web_notifications (not-supported), notification_connection_type (not-supported), sharing (mutating), steal (mutating), app (mutating), remote_logging (mutating), insecure (auth), debug_main (mutating), debug_keyboard (mutating), debug_geometry (mutating), debug_mouse (mutating), debug_clipboard (mutating), debug_draw (mutating), debug_audio (mutating), debug_network (mutating), debug_file (mutating).

Status page of the headless or headful browser service, and a full-page view of its display.

ViewLabelPathRequiredFrameableAliasNotes
browser.statusStatus/noneyesyesdefault
browser.displayDisplay/noneyesyesnone

Lists the running browser instances with links to their display and developer tools.

ParameterInValuesDescription
maximize_new_windowsquerybooleanOpen new browser windows maximized in the display. On by default.

Always sent: start=false.

Shows the browser’s display full-page.

ParameterInValuesDescription
maximize_new_windowsquerybooleanOpen new browser windows maximized in the display. On by default.
iframe_urlqueryURLWeb address shown in the full-page frame instead of the browser’s own display. Must start with http:// or https://.

Always sent: view=display, start=false.

Refused parameters: display (forced; use serviceIndex).

A VS Code editor in the browser, opened on a folder of the computer, optionally focused on a single extension.

ViewLabelPathRequiredFrameableAliasNotes
code.rootEditor (default folder)/api/v1/codenoneyesnostarts a process
code.editorEditor/api/v1/codefolderyesnodefault, starts a process
code.extensionExtension/api/v1/codeextensionyesnostarts a process

The editor opened on the default workspace folder the platform sets. Opening it starts the editor instance when it is not running yet.

ParameterInValuesDescription
localequerystringDisplay language of the editor, as a language tag such as en or pt-BR. Applies when the instance starts.
page-loaderquerybooleanShow a loading overlay while a newly started editor initialises. Applies when the instance starts.
disable-walkthroughsquerybooleanHide the editor’s walkthrough pages. Applies when the instance starts.
hoody-codequerybooleanLoad the Hoody page integration scripts, such as tab-title sync. Applies when the instance starts.

The editor opened on a folder. Opening it starts the editor instance when it is not running yet.

ParameterInValuesDescription
folderquerystringAbsolute path of the folder to open. It applies when the editor instance starts; on a running instance the page opens this folder, and the instance keeps reporting the folder it was started with.
localequerystringDisplay language of the editor, as a language tag such as en or pt-BR. Applies when the instance starts.
page-loaderquerybooleanShow a loading overlay while a newly started editor initialises. Applies when the instance starts.
disable-walkthroughsquerybooleanHide the editor’s walkthrough pages. Applies when the instance starts.
hoody-codequerybooleanLoad the Hoody page integration scripts, such as tab-title sync. Applies when the instance starts.

The editor in extension-only mode: only the chosen extension’s view is shown. Opening it starts the editor instance when it is not running yet.

ParameterInValuesDescription
folderquerystringAbsolute path of the folder to open. It applies when the editor instance starts; on a running instance the page opens this folder, and the instance keeps reporting the folder it was started with.
extensionquerystringExtension identifier in PUBLISHER.NAME form. Opens the editor in extension-only mode, showing only that extension’s view.
localequerystringDisplay language of the editor, as a language tag such as en or pt-BR. Applies when the instance starts.
page-loaderquerybooleanShow a loading overlay while a newly started editor initialises. Applies when the instance starts.
disable-walkthroughsquerybooleanHide the editor’s walkthrough pages. Applies when the instance starts.
hoody-codequerybooleanLoad the Hoody page integration scripts, such as tab-title sync. Applies when the instance starts.

Refused parameters: id (forced; use serviceIndex), restart (mutating), welcome-iframe-url (mutating), page-loader-path (mutating), proxy-domain (mutating), app-name (mutating).

A file manager for the computer: folder listings, search, a code editor and a read-only viewer.

ViewLabelPathRequiredFrameableAliasNotes
files.rootRoot folder/noneyesnonone
files.folderFolder/{path}pathyesnodefault
files.editorEditor/{path}pathyesnonone
files.searchSearch/{directory}directory, qyesnonone

The listing of the computer root folder, with upload, rename and delete controls for the user.

ParameterInValuesDescription
sortqueryname, mtime, sizeSort the listing by name, modification time or size.
orderqueryasc, descSort direction. Only desc changes the order; asc is the default.
themequeryoc-1, aura, ayu, carbonfox, catppuccin, dracula, gruvbox, monokai, nightowl, nord, onedarkpro, shadesofpurple, solarized, tokyonight, vesperColour theme of the page.
colorSchemequerylight, darkLight or dark colour scheme. Without it the page follows the system setting.
fontqueryibm-plex-mono, cascadia-code, fira-code, hack, inconsolata, intel-one-mono, iosevka, jetbrains-mono, meslo-lgs, roboto-mono, source-code-pro, ubuntu-monoMonospace font of the editor and listing.
fontSizequeryinteger (≥ 8, ≤ 72)Editor font size in pixels, 8 to 72.
embedderOriginqueryURLOrigin of the embedding page, such as https://app.example.com. The page then accepts theme and layout messages from it and tells it when it is ready.
chromelessquerybooleanHide the header, sidebar, preview, footer and borders at once. Each can be turned back on with its own option set to false.
borderlessquerybooleanHide the page borders.
hideHeaderquerybooleanHide the header bar.
hideSidebarquerybooleanHide the sidebar.
hidePreviewquerybooleanHide the preview pane.
hideFooterquerybooleanHide the footer.
embedBgquerytransparentSet to transparent to let the embedding page’s background show through.

The listing of a folder, with upload, rename and delete controls for the user.

ParameterInValuesDescription
pathpathstringAbsolute path inside the computer, starting with /. Each segment is percent-encoded; the slashes between segments are kept.
sortqueryname, mtime, sizeSort the listing by name, modification time or size.
orderqueryasc, descSort direction. Only desc changes the order; asc is the default.
themequeryoc-1, aura, ayu, carbonfox, catppuccin, dracula, gruvbox, monokai, nightowl, nord, onedarkpro, shadesofpurple, solarized, tokyonight, vesperColour theme of the page.
colorSchemequerylight, darkLight or dark colour scheme. Without it the page follows the system setting.
fontqueryibm-plex-mono, cascadia-code, fira-code, hack, inconsolata, intel-one-mono, iosevka, jetbrains-mono, meslo-lgs, roboto-mono, source-code-pro, ubuntu-monoMonospace font of the editor and listing.
fontSizequeryinteger (≥ 8, ≤ 72)Editor font size in pixels, 8 to 72.
embedderOriginqueryURLOrigin of the embedding page, such as https://app.example.com. The page then accepts theme and layout messages from it and tells it when it is ready.
chromelessquerybooleanHide the header, sidebar, preview, footer and borders at once. Each can be turned back on with its own option set to false.
borderlessquerybooleanHide the page borders.
hideHeaderquerybooleanHide the header bar.
hideSidebarquerybooleanHide the sidebar.
hidePreviewquerybooleanHide the preview pane.
hideFooterquerybooleanHide the footer.
embedBgquerytransparentSet to transparent to let the embedding page’s background show through.

A text file opened in the code editor. Changes are saved only when the user saves.

ParameterInValuesDescription
pathpathstringAbsolute path inside the computer, starting with /. Each segment is percent-encoded; the slashes between segments are kept.
themequeryoc-1, aura, ayu, carbonfox, catppuccin, dracula, gruvbox, monokai, nightowl, nord, onedarkpro, shadesofpurple, solarized, tokyonight, vesperColour theme of the page.
colorSchemequerylight, darkLight or dark colour scheme. Without it the page follows the system setting.
fontqueryibm-plex-mono, cascadia-code, fira-code, hack, inconsolata, intel-one-mono, iosevka, jetbrains-mono, meslo-lgs, roboto-mono, source-code-pro, ubuntu-monoMonospace font of the editor and listing.
fontSizequeryinteger (≥ 8, ≤ 72)Editor font size in pixels, 8 to 72.
embedderOriginqueryURLOrigin of the embedding page, such as https://app.example.com. The page then accepts theme and layout messages from it and tells it when it is ready.
chromelessquerybooleanHide the header, sidebar, preview, footer and borders at once. Each can be turned back on with its own option set to false.
borderlessquerybooleanHide the page borders.
hideHeaderquerybooleanHide the header bar.
hideFooterquerybooleanHide the footer.
embedBgquerytransparentSet to transparent to let the embedding page’s background show through.

Always sent: edit=.

Search results for a text inside a folder and its subfolders.

ParameterInValuesDescription
directorypathstringAbsolute path of the folder to search in, starting with /, encoded like path.
qquerystringSearch text. Lists the entries below the folder whose names match.
themequeryoc-1, aura, ayu, carbonfox, catppuccin, dracula, gruvbox, monokai, nightowl, nord, onedarkpro, shadesofpurple, solarized, tokyonight, vesperColour theme of the page.
colorSchemequerylight, darkLight or dark colour scheme. Without it the page follows the system setting.
fontqueryibm-plex-mono, cascadia-code, fira-code, hack, inconsolata, intel-one-mono, iosevka, jetbrains-mono, meslo-lgs, roboto-mono, source-code-pro, ubuntu-monoMonospace font of the editor and listing.
fontSizequeryinteger (≥ 8, ≤ 72)Editor font size in pixels, 8 to 72.
embedderOriginqueryURLOrigin of the embedding page, such as https://app.example.com. The page then accepts theme and layout messages from it and tells it when it is ready.
chromelessquerybooleanHide the header, sidebar, preview, footer and borders at once. Each can be turned back on with its own option set to false.
borderlessquerybooleanHide the page borders.
hideHeaderquerybooleanHide the header bar.
hideSidebarquerybooleanHide the sidebar.
hidePreviewquerybooleanHide the preview pane.
hideFooterquerybooleanHide the footer.
embedBgquerytransparentSet to transparent to let the embedding page’s background show through.

Refused parameters: json (non-ui), simple (non-ui), hash (non-ui), sha256 (non-ui), base64 (non-ui), view (not-read-only), download (mutating), content-type (non-ui), history (non-ui), at (non-ui), revision (non-ui), diff (non-ui), from_seq (non-ui), from_ts (non-ui), to_seq (non-ui), to_ts (non-ui), after_id (non-ui), limit (non-ui).

Hoody Notes: notebooks, pages and databases in the browser. Whether a framed Notes page shares its local cache with Notes open in a tab depends on the browser: a frame embedded by another site usually gets separate storage. Separate caches exchange changes, offline edits included, once they sync with the server. Offline edits survive a reload only when the browser gives Notes persistent storage; where it does not, Notes runs from memory and unsynced edits are lost on reload.

ViewLabelPathRequiredFrameableAliasNotes
notes.homeHome/noneyesnodefault
notes.createCreate notebook/createnoneyesnonone
notes.notebookNotebook/notebook/{userId}userIdyesnonone
notes.notebookHomeNotebook home/notebook/{userId}/homeuserIdyesnonone
notes.nodePage/notebook/{userId}/{nodeId}userId, nodeIdyesnonone
notes.modalPage with modal/notebook/{userId}/{nodeId}/modal/{modalNodeId}userId, nodeId, modalNodeIdyesnonone
notes.aliasPage by alias/notebook/{userId}/alias/{alias}userId, aliasyesnonone
notes.filesFiles/notebook/{userId}/filesuserIdyesnonone
notes.uploadsUploads/notebook/{userId}/uploadsuserIdyesnonone
notes.downloadsDownloads/notebook/{userId}/downloadsuserIdyesnonone
notes.usersUsers/notebook/{userId}/usersuserIdyesnonone
notes.settingsNotebook settings/notebook/{userId}/settingsuserIdyesnonone
notes.accountAccount settings/notebook/{userId}/accountuserIdyesnonone

Opens the last used locally available notebook, or the first available one. On a first visit, with no notebook stored in this browser, Notes needs the server to set one up.

ParameterInValuesDescription
modequeryreadonly, readwriteShare presentation. Either value hides the sidebar. readonly shows the notebook’s content and management views as a viewer sees them; your own account settings and appearance preferences stay editable. readwrite keeps the editing controls your permissions allow, including section and channel role overrides. Neither changes permissions.
sidebarqueryhiddenSet to hidden to hide the notebook sidebar.
themequeryoc-1, hc-black, aura, ayu, carbonfox, catppuccin, dracula, gruvbox, monokai, nightowl, nord, onedarkpro, shadesofpurple, solarized, tokyonight, vesperColour theme id.
colorSchemequerylight, darkLight or dark colour scheme, over the saved preference. A page set to light or dark in its own appearance keeps it.
fontqueryibm-plex-mono, jetbrains-mono, fira-code, cascadia-code, hack, source-code-pro, inconsolata, roboto-mono, ubuntu-mono, intel-one-mono, meslo-lgs, iosevkaMonospace font id.

Opens the form for creating a new notebook; only submitting the form creates one. Like any Notes page, the first visit may set up the default notebook and your user in it.

ParameterInValuesDescription
themequeryoc-1, hc-black, aura, ayu, carbonfox, catppuccin, dracula, gruvbox, monokai, nightowl, nord, onedarkpro, shadesofpurple, solarized, tokyonight, vesperColour theme id.
colorSchemequerylight, darkLight or dark colour scheme, over the saved preference. A page set to light or dark in its own appearance keeps it.
fontqueryibm-plex-mono, jetbrains-mono, fira-code, cascadia-code, hack, source-code-pro, inconsolata, roboto-mono, ubuntu-mono, intel-one-mono, meslo-lgs, iosevkaMonospace font id.

Opens a notebook at its last visited location, or its home page.

ParameterInValuesDescription
userIdpathstringYour own user id in the notebook to open, as the viewing identity knows it (not the notebook id, and not another member’s user id: an id the viewer does not have opens Notes home instead). New ids are 24 lowercase hexadecimal characters; older ids may be up to 28 lowercase letters and digits.
modequeryreadonly, readwriteShare presentation. Either value hides the sidebar. readonly shows the notebook’s content and management views as a viewer sees them; your own account settings and appearance preferences stay editable. readwrite keeps the editing controls your permissions allow, including section and channel role overrides. Neither changes permissions.
sidebarqueryhiddenSet to hidden to hide the notebook sidebar.
themequeryoc-1, hc-black, aura, ayu, carbonfox, catppuccin, dracula, gruvbox, monokai, nightowl, nord, onedarkpro, shadesofpurple, solarized, tokyonight, vesperColour theme id.
colorSchemequerylight, darkLight or dark colour scheme, over the saved preference. A page set to light or dark in its own appearance keeps it.
fontqueryibm-plex-mono, jetbrains-mono, fira-code, cascadia-code, hack, source-code-pro, inconsolata, roboto-mono, ubuntu-mono, intel-one-mono, meslo-lgs, iosevkaMonospace font id.

Opens the home page of a notebook.

ParameterInValuesDescription
userIdpathstringYour own user id in the notebook to open, as the viewing identity knows it (not the notebook id, and not another member’s user id: an id the viewer does not have opens Notes home instead). New ids are 24 lowercase hexadecimal characters; older ids may be up to 28 lowercase letters and digits.
modequeryreadonly, readwriteShare presentation. Either value hides the sidebar. readonly shows the notebook’s content and management views as a viewer sees them; your own account settings and appearance preferences stay editable. readwrite keeps the editing controls your permissions allow, including section and channel role overrides. Neither changes permissions.
sidebarqueryhiddenSet to hidden to hide the notebook sidebar.
themequeryoc-1, hc-black, aura, ayu, carbonfox, catppuccin, dracula, gruvbox, monokai, nightowl, nord, onedarkpro, shadesofpurple, solarized, tokyonight, vesperColour theme id.
colorSchemequerylight, darkLight or dark colour scheme, over the saved preference. A page set to light or dark in its own appearance keeps it.
fontqueryibm-plex-mono, jetbrains-mono, fira-code, cascadia-code, hack, source-code-pro, inconsolata, roboto-mono, ubuntu-mono, intel-one-mono, meslo-lgs, iosevkaMonospace font id.

Opens one page or node of a notebook.

ParameterInValuesDescription
userIdpathstringYour own user id in the notebook to open, as the viewing identity knows it (not the notebook id, and not another member’s user id: an id the viewer does not have opens Notes home instead). New ids are 24 lowercase hexadecimal characters; older ids may be up to 28 lowercase letters and digits.
nodeIdpathstringId of the page or node to open. New ids are 24 lowercase hexadecimal characters; older ids may be up to 28 lowercase letters and digits.
modequeryreadonly, readwriteShare presentation. Either value hides the sidebar. readonly shows the notebook’s content and management views as a viewer sees them; your own account settings and appearance preferences stay editable. readwrite keeps the editing controls your permissions allow, including section and channel role overrides. Neither changes permissions.
sidebarqueryhiddenSet to hidden to hide the notebook sidebar.
themequeryoc-1, hc-black, aura, ayu, carbonfox, catppuccin, dracula, gruvbox, monokai, nightowl, nord, onedarkpro, shadesofpurple, solarized, tokyonight, vesperColour theme id.
colorSchemequerylight, darkLight or dark colour scheme, over the saved preference. A page set to light or dark in its own appearance keeps it.
fontqueryibm-plex-mono, jetbrains-mono, fira-code, cascadia-code, hack, source-code-pro, inconsolata, roboto-mono, ubuntu-mono, intel-one-mono, meslo-lgs, iosevkaMonospace font id.

Opens a page with another node shown in a modal over it.

ParameterInValuesDescription
userIdpathstringYour own user id in the notebook to open, as the viewing identity knows it (not the notebook id, and not another member’s user id: an id the viewer does not have opens Notes home instead). New ids are 24 lowercase hexadecimal characters; older ids may be up to 28 lowercase letters and digits.
nodeIdpathstringId of the page or node to open. New ids are 24 lowercase hexadecimal characters; older ids may be up to 28 lowercase letters and digits.
modalNodeIdpathstringId of the node shown in a modal over the page. New ids are 24 lowercase hexadecimal characters; older ids may be up to 28 lowercase letters and digits.
modequeryreadonly, readwriteShare presentation. Either value hides the sidebar. readonly shows the notebook’s content and management views as a viewer sees them; your own account settings and appearance preferences stay editable. readwrite keeps the editing controls your permissions allow, including section and channel role overrides. Neither changes permissions.
sidebarqueryhiddenSet to hidden to hide the notebook sidebar.
themequeryoc-1, hc-black, aura, ayu, carbonfox, catppuccin, dracula, gruvbox, monokai, nightowl, nord, onedarkpro, shadesofpurple, solarized, tokyonight, vesperColour theme id.
colorSchemequerylight, darkLight or dark colour scheme, over the saved preference. A page set to light or dark in its own appearance keeps it.
fontqueryibm-plex-mono, jetbrains-mono, fira-code, cascadia-code, hack, source-code-pro, inconsolata, roboto-mono, ubuntu-mono, intel-one-mono, meslo-lgs, iosevkaMonospace font id.

Opens the page with the given alias if it is available in this browser. If it is not, Notes waits while the first sync runs, for up to 30 seconds. If the page is still not available, Notes opens the notebook home.

ParameterInValuesDescription
userIdpathstringYour own user id in the notebook to open, as the viewing identity knows it (not the notebook id, and not another member’s user id: an id the viewer does not have opens Notes home instead). New ids are 24 lowercase hexadecimal characters; older ids may be up to 28 lowercase letters and digits.
aliaspathstringPage alias (lowercase letters, digits, ’_’ and ’-’, up to 48 characters). Opens the matching page available in this browser, or the notebook home if it is still not available after waiting up to 30 seconds for the first sync.
modequeryreadonly, readwriteShare presentation. Either value hides the sidebar. readonly shows the notebook’s content and management views as a viewer sees them; your own account settings and appearance preferences stay editable. readwrite keeps the editing controls your permissions allow, including section and channel role overrides. Neither changes permissions.
sidebarqueryhiddenSet to hidden to hide the notebook sidebar.
themequeryoc-1, hc-black, aura, ayu, carbonfox, catppuccin, dracula, gruvbox, monokai, nightowl, nord, onedarkpro, shadesofpurple, solarized, tokyonight, vesperColour theme id.
colorSchemequerylight, darkLight or dark colour scheme, over the saved preference. A page set to light or dark in its own appearance keeps it.
fontqueryibm-plex-mono, jetbrains-mono, fira-code, cascadia-code, hack, source-code-pro, inconsolata, roboto-mono, ubuntu-mono, intel-one-mono, meslo-lgs, iosevkaMonospace font id.

Opens the file tree of a notebook.

ParameterInValuesDescription
userIdpathstringYour own user id in the notebook to open, as the viewing identity knows it (not the notebook id, and not another member’s user id: an id the viewer does not have opens Notes home instead). New ids are 24 lowercase hexadecimal characters; older ids may be up to 28 lowercase letters and digits.
modequeryreadonly, readwriteShare presentation. Either value hides the sidebar. readonly shows the notebook’s content and management views as a viewer sees them; your own account settings and appearance preferences stay editable. readwrite keeps the editing controls your permissions allow, including section and channel role overrides. Neither changes permissions.
sidebarqueryhiddenSet to hidden to hide the notebook sidebar.
themequeryoc-1, hc-black, aura, ayu, carbonfox, catppuccin, dracula, gruvbox, monokai, nightowl, nord, onedarkpro, shadesofpurple, solarized, tokyonight, vesperColour theme id.
colorSchemequerylight, darkLight or dark colour scheme, over the saved preference. A page set to light or dark in its own appearance keeps it.
fontqueryibm-plex-mono, jetbrains-mono, fira-code, cascadia-code, hack, source-code-pro, inconsolata, roboto-mono, ubuntu-mono, intel-one-mono, meslo-lgs, iosevkaMonospace font id.

Opens the uploads list of a notebook.

ParameterInValuesDescription
userIdpathstringYour own user id in the notebook to open, as the viewing identity knows it (not the notebook id, and not another member’s user id: an id the viewer does not have opens Notes home instead). New ids are 24 lowercase hexadecimal characters; older ids may be up to 28 lowercase letters and digits.
modequeryreadonly, readwriteShare presentation. Either value hides the sidebar. readonly shows the notebook’s content and management views as a viewer sees them; your own account settings and appearance preferences stay editable. readwrite keeps the editing controls your permissions allow, including section and channel role overrides. Neither changes permissions.
sidebarqueryhiddenSet to hidden to hide the notebook sidebar.
themequeryoc-1, hc-black, aura, ayu, carbonfox, catppuccin, dracula, gruvbox, monokai, nightowl, nord, onedarkpro, shadesofpurple, solarized, tokyonight, vesperColour theme id.
colorSchemequerylight, darkLight or dark colour scheme, over the saved preference. A page set to light or dark in its own appearance keeps it.
fontqueryibm-plex-mono, jetbrains-mono, fira-code, cascadia-code, hack, source-code-pro, inconsolata, roboto-mono, ubuntu-mono, intel-one-mono, meslo-lgs, iosevkaMonospace font id.

Opens the downloads list of a notebook.

ParameterInValuesDescription
userIdpathstringYour own user id in the notebook to open, as the viewing identity knows it (not the notebook id, and not another member’s user id: an id the viewer does not have opens Notes home instead). New ids are 24 lowercase hexadecimal characters; older ids may be up to 28 lowercase letters and digits.
modequeryreadonly, readwriteShare presentation. Either value hides the sidebar. readonly shows the notebook’s content and management views as a viewer sees them; your own account settings and appearance preferences stay editable. readwrite keeps the editing controls your permissions allow, including section and channel role overrides. Neither changes permissions.
sidebarqueryhiddenSet to hidden to hide the notebook sidebar.
themequeryoc-1, hc-black, aura, ayu, carbonfox, catppuccin, dracula, gruvbox, monokai, nightowl, nord, onedarkpro, shadesofpurple, solarized, tokyonight, vesperColour theme id.
colorSchemequerylight, darkLight or dark colour scheme, over the saved preference. A page set to light or dark in its own appearance keeps it.
fontqueryibm-plex-mono, jetbrains-mono, fira-code, cascadia-code, hack, source-code-pro, inconsolata, roboto-mono, ubuntu-mono, intel-one-mono, meslo-lgs, iosevkaMonospace font id.

Opens the member list of a notebook.

ParameterInValuesDescription
userIdpathstringYour own user id in the notebook to open, as the viewing identity knows it (not the notebook id, and not another member’s user id: an id the viewer does not have opens Notes home instead). New ids are 24 lowercase hexadecimal characters; older ids may be up to 28 lowercase letters and digits.
modequeryreadonly, readwriteShare presentation. Either value hides the sidebar. readonly shows the notebook’s content and management views as a viewer sees them; your own account settings and appearance preferences stay editable. readwrite keeps the editing controls your permissions allow, including section and channel role overrides. Neither changes permissions.
sidebarqueryhiddenSet to hidden to hide the notebook sidebar.
themequeryoc-1, hc-black, aura, ayu, carbonfox, catppuccin, dracula, gruvbox, monokai, nightowl, nord, onedarkpro, shadesofpurple, solarized, tokyonight, vesperColour theme id.
colorSchemequerylight, darkLight or dark colour scheme, over the saved preference. A page set to light or dark in its own appearance keeps it.
fontqueryibm-plex-mono, jetbrains-mono, fira-code, cascadia-code, hack, source-code-pro, inconsolata, roboto-mono, ubuntu-mono, intel-one-mono, meslo-lgs, iosevkaMonospace font id.

Opens the settings of a notebook.

ParameterInValuesDescription
userIdpathstringYour own user id in the notebook to open, as the viewing identity knows it (not the notebook id, and not another member’s user id: an id the viewer does not have opens Notes home instead). New ids are 24 lowercase hexadecimal characters; older ids may be up to 28 lowercase letters and digits.
modequeryreadonly, readwriteShare presentation. Either value hides the sidebar. readonly shows the notebook’s content and management views as a viewer sees them; your own account settings and appearance preferences stay editable. readwrite keeps the editing controls your permissions allow, including section and channel role overrides. Neither changes permissions.
sidebarqueryhiddenSet to hidden to hide the notebook sidebar.
themequeryoc-1, hc-black, aura, ayu, carbonfox, catppuccin, dracula, gruvbox, monokai, nightowl, nord, onedarkpro, shadesofpurple, solarized, tokyonight, vesperColour theme id.
colorSchemequerylight, darkLight or dark colour scheme, over the saved preference. A page set to light or dark in its own appearance keeps it.
fontqueryibm-plex-mono, jetbrains-mono, fira-code, cascadia-code, hack, source-code-pro, inconsolata, roboto-mono, ubuntu-mono, intel-one-mono, meslo-lgs, iosevkaMonospace font id.

Opens the account settings for a notebook’s account. The display name and avatar choice are kept in this browser for the signed-in identity and do not sync to other browsers or to a frame with separate storage; the avatar image itself is uploaded to the server.

ParameterInValuesDescription
userIdpathstringYour own user id in the notebook to open, as the viewing identity knows it (not the notebook id, and not another member’s user id: an id the viewer does not have opens Notes home instead). New ids are 24 lowercase hexadecimal characters; older ids may be up to 28 lowercase letters and digits.
modequeryreadonly, readwriteShare presentation. Either value hides the sidebar. readonly shows the notebook’s content and management views as a viewer sees them; your own account settings and appearance preferences stay editable. readwrite keeps the editing controls your permissions allow, including section and channel role overrides. Neither changes permissions.
sidebarqueryhiddenSet to hidden to hide the notebook sidebar.
themequeryoc-1, hc-black, aura, ayu, carbonfox, catppuccin, dracula, gruvbox, monokai, nightowl, nord, onedarkpro, shadesofpurple, solarized, tokyonight, vesperColour theme id.
colorSchemequerylight, darkLight or dark colour scheme, over the saved preference. A page set to light or dark in its own appearance keeps it.
fontqueryibm-plex-mono, jetbrains-mono, fira-code, cascadia-code, hack, source-code-pro, inconsolata, roboto-mono, ubuntu-mono, intel-one-mono, meslo-lgs, iosevkaMonospace font id.

Refused parameters: widgetId (mutating).

Hoody SQLite studio: browse tables, run queries and manage key-value data.

ViewLabelPathRequiredFrameableAliasNotes
sqlite.overviewOverview/noneyesnodefault
sqlite.tablesTables/tablesnoneyesnonone
sqlite.queryQuery editor/querynoneyesnonone
sqlite.kvStoreKey-value store/kv-storenoneyesnonone
sqlite.historyHistory/historynoneyesnonone
sqlite.pragmasPragmas/pragmasnoneyesnonone

Opens the database overview.

ParameterInValuesDescription
dbquerystringPath of the database file to open. A missing file is reported as an error, never created.
colorSchemequerylight, dark, systemForce the light or dark colour scheme, or follow the system.
embedquerybooleanCompact chrome for embedding: a thin navigation bar instead of the full header.

Opens the table browser, optionally with one table selected.

ParameterInValuesDescription
tablequerystringTable to select. On the key-value view it names the key-value table (default kv_store).
dbquerystringPath of the database file to open. A missing file is reported as an error, never created.
colorSchemequerylight, dark, systemForce the light or dark colour scheme, or follow the system.
embedquerybooleanCompact chrome for embedding: a thin navigation bar instead of the full header.

Opens the SQL query editor. Nothing runs until you run a query.

ParameterInValuesDescription
dbquerystringPath of the database file to open. A missing file is reported as an error, never created.
colorSchemequerylight, dark, systemForce the light or dark colour scheme, or follow the system.
embedquerybooleanCompact chrome for embedding: a thin navigation bar instead of the full header.

Opens the key-value store browser.

ParameterInValuesDescription
tablequerystringTable to select. On the key-value view it names the key-value table (default kv_store).
dbquerystringPath of the database file to open. A missing file is reported as an error, never created.
colorSchemequerylight, dark, systemForce the light or dark colour scheme, or follow the system.
embedquerybooleanCompact chrome for embedding: a thin navigation bar instead of the full header.

Opens the query history.

ParameterInValuesDescription
dbquerystringPath of the database file to open. A missing file is reported as an error, never created.
colorSchemequerylight, dark, systemForce the light or dark colour scheme, or follow the system.
embedquerybooleanCompact chrome for embedding: a thin navigation bar instead of the full header.

Opens the database pragma settings. Nothing changes until you save.

ParameterInValuesDescription
dbquerystringPath of the database file to open. A missing file is reported as an error, never created.
colorSchemequerylight, dark, systemForce the light or dark colour scheme, or follow the system.
embedquerybooleanCompact chrome for embedding: a thin navigation bar instead of the full header.

Refused parameters: sql (not-supported).

Notification landing page: recent notifications and a live feed from all displays, plus a test sender for one display or all of them.

ViewLabelPathRequiredFrameableAliasNotes
notifications.landingNotifications/noneyesyes (display selects)default

Recent and live notifications from every display, with a button to send a test notification to one display.

ParameterInValuesDescription
displayquerystringDisplay number to send the test notification to, or all (also *) to send it to every display the page has seen notifications from. Takes precedence over the display named by the host. The feed always shows every display.
displaysquerystringAlternative name for display; read when display is absent or empty.

Browser pages for streaming data through a named pipe path: send files or text, receive downloads, share a screen, camera or microphone, watch video, and follow a transfer’s progress.

ViewLabelPathRequiredFrameableAliasNotes
pipe.sendSend/api/v1/pipe/noneyesnodefault
pipe.noscriptSend without JavaScript/api/v1/pipe/noscriptnoneyesnonone
pipe.progressProgress/api/v1/pipe/{path}pathyesnonone
pipe.videoVideo player/api/v1/pipe/{path}pathyesnochanges state
pipe.shareShare screen, camera or audio/api/v1/pipe/{path}pathyesnonone
pipe.receiveReceive/api/v1/pipe/{path}pathyesnonone

The page for sending a file or text to a pipe path. Its fields can be pre-filled, except the file itself, which the user picks; nothing is sent until the user confirms.

ParameterInValuesDescription
namequerystringPipe name to pre-fill on the send page, without a leading slash. The values . and .. as a segment, control characters, backslashes and the reserved names help, noscript, health, metrics, favicon.ico and robots.txt are refused. Absent: the page picks a random name.
nqueryinteger (≥ 1, ≤ 256)How many receivers the transfer waits for, from 1 to 256. It pre-fills the receivers field; nothing is sent or received until the user confirms on the page.
textquerystringText to pre-fill on the send page; it selects text mode unless mode says otherwise.
modequeryfile, textWhether the form sends a file or typed text. Defaults to file, or on the send page to text when text is given.
filenamequerystringA file name to pre-fill: on the send page the name given to a text or pasted send, on the receive page the download name.

A plain HTML form for sending a file or text to a pipe path, for browsers without JavaScript.

ParameterInValuesDescription
pathquerystringPipe path to prefill in the form, without a leading slash. Letters, digits and the characters . _ ~ : @ ! $ & ’ ( ) * + , ; = % - only. The values . and .., and the reserved names help, noscript, health, metrics, favicon.ico and robots.txt are refused.
modequeryfile, textWhether the form sends a file or typed text. Defaults to file, or on the send page to text when text is given.
waitqueryinteger (≥ 1, ≤ 3600)Seconds the page’s own transfer waits for the other side, from 1 to 3600 (default 300): on the receive page how long the download waits for the sender, on the video player how long the player waits for the stream, on the send page without JavaScript how long the send waits for the receivers. It changes no other participant’s wait.
sha256query11 to have the kit compute a SHA-256 digest of the transfer the page starts: the receive page’s download or the send of the page without JavaScript. Leave it out for none. The page without JavaScript shows the digest in its send result; the receive page shows none (the digest goes to the sender’s status).

A live view of a transfer’s progress on a pipe path. It only observes; it does not receive the data.

ParameterInValuesDescription
pathpathstringThe pipe path the sender uses, without a leading slash. Each segment is percent-encoded.

Always sent: progress=true.

A video player for a video streamed to a pipe path. Opening it starts receiving: the player takes the stream as one of the transfer’s receivers or, with live, joins a live stream from now on.

ParameterInValuesDescription
pathpathstringThe pipe path the sender uses, without a leading slash. Each segment is percent-encoded.
livequery11 for a live stream. On the share page it pre-ticks Live: once the user starts, viewers join and leave at any time, and the receivers count is hidden and not used. On the video player the player joins a live stream from now on and keeps up with the newest data. Any n is then ignored.
waitqueryinteger (≥ 1, ≤ 3600)Seconds the page’s own transfer waits for the other side, from 1 to 3600 (default 300): on the receive page how long the download waits for the sender, on the video player how long the player waits for the stream, on the send page without JavaScript how long the send waits for the receivers. It changes no other participant’s wait.

Always sent: video=true.

A page that streams the user’s screen, camera or microphone live to a pipe path, for viewers on the video view. Capture starts only on the user’s click. In an iframe, give the frame allow=“display-capture; camera; microphone; autoplay”.

ParameterInValuesDescription
pathpathstringThe pipe path the sender uses, without a leading slash. Each segment is percent-encoded.
sourcequeryscreen, camera, audioWhat the share page captures: screen (default), camera or audio (microphone only).
audioquery1, 01 to also capture audio when sharing a screen, 0 (default) for none.
surfacequerymonitor, window, browserWhich kind of surface the browser’s screen picker offers first: monitor, window or browser (tab). A hint; the user still picks.
qualityquerylow, medium, highVideo quality of the share: low, medium (default) or high.
fpsqueryinteger (≥ 1, ≤ 60)Frames per second of the share, from 1 to 60 (default 30).
nqueryinteger (≥ 1, ≤ 256)How many receivers the transfer waits for, from 1 to 256. It pre-fills the receivers field; nothing is sent or received until the user confirms on the page.
livequery11 for a live stream. On the share page it pre-ticks Live: once the user starts, viewers join and leave at any time, and the receivers count is hidden and not used. On the video player the player joins a live stream from now on and keeps up with the newest data. Any n is then ignored.

Always sent: share=true.

A page for receiving what is sent to a pipe path as a download. It shows the transfer state and starts the download only on the user’s click.

ParameterInValuesDescription
pathpathstringThe pipe path the sender uses, without a leading slash. Each segment is percent-encoded.
nqueryinteger (≥ 1, ≤ 256)How many receivers the transfer waits for, from 1 to 256. It pre-fills the receivers field; nothing is sent or received until the user confirms on the page.
filenamequerystringA file name to pre-fill: on the send page the name given to a text or pasted send, on the receive page the download name.
waitqueryinteger (≥ 1, ≤ 3600)Seconds the page’s own transfer waits for the other side, from 1 to 3600 (default 300): on the receive page how long the download waits for the sender, on the video player how long the player waits for the stream, on the send page without JavaScript how long the send waits for the receivers. It changes no other participant’s wait.
sha256query11 to have the kit compute a SHA-256 digest of the transfer the page starts: the receive page’s download or the send of the page without JavaScript. Leave it out for none. The page without JavaScript shows the digest in its send result; the receive page shows none (the digest goes to the sender’s status).

Always sent: receive=true.

Refused parameters: download (mutating), autostart (mutating), status (non-ui), transfer (non-ui), ws (mutating).

Cron manager: browse and edit the crontab entries of each user.

ViewLabelPathRequiredFrameableAliasNotes
cron.managerCron manager/noneyesyesdefault

Lists users and their cron entries; changes are made only through the page controls.

A results page that lists the applications matching a name, with their versions and the provider each comes from.

ViewLabelPathRequiredFrameableAliasNotes
run.resultsResults/api/v1/run/resolveappyesnodefault

The list of applications matching a name. It only looks them up; nothing is installed or started.

ParameterInValuesDescription
appquerystringName of the application to look up.
osquerylinux, windows, anyTarget operating system of the application.
sourcequeryarray[]Source types to search: nix, pkgx, appimage, oci (Docker images already on the machine), registry, system or any. Repeat the key for several types.
kindquerygui, cli, anyGraphical or terminal applications.
archqueryamd64, arm64, anyTarget CPU architecture.
profilequerystringNamed preference profile to apply to this lookup; without it, the selected profile applies. The results page appears only when the profile leaves pick unset or set to ask: a profile that picks a result answers with JSON instead.
versionquerystringPackage version for pkgx candidates: the listed pkgx entry runs that version. It does not change which applications are listed.
repoquerystringLimits the GitHub-release applications to the configured repository with this name.
releasequerystringRelease tag to use for GitHub-release applications.
assetquerystringAsset-name filter for GitHub-release applications; with no matching asset the application is not listed.
limitqueryinteger (≥ 1, ≤ 100)Maximum number of candidates, 1 to 100. The page lists at most 50.

Always sent: format=html.

Refused parameters: pick (non-ui), pick_index (non-ui), candidate_id (non-ui), set_id (non-ui), terminal_id (non-ui), display (non-ui), dry_run (non-ui), print_curl (non-ui), args (non-ui), pass_env (non-ui), launch_tag (non-ui), launch_env (non-ui), enrich (non-ui), origin (mutating).

A short information page about the watch service.

ViewLabelPathRequiredFrameableAliasNotes
watch.indexAbout/noneyesnodefault

A static page describing the watch service and where its API starts.

Pages served by your own scripts. The address runs the script mapped to the path, and the script decides what is returned.

ViewLabelPathRequiredFrameableAliasNotes
exec.scriptScript page/{path}pathyesnodefault, starts a process, changes state

The response of your script for the given path. Opening it runs the script, which reads the query parameters in metadata.query; a repeated key keeps only its last value. On a script with @token, a token query parameter that authenticates the request is removed first. A route parameter, such as id in [id].ts, replaces a query parameter of the same name.

ParameterInValuesDescription
pathpathstringPath of the script route to open, starting with /. Each segment is percent-encoded and the slashes between segments are kept; the builder refuses a . or .. segment. Once decoded, the path may hold only ASCII letters, digits, -, _, . and /: any other character gets a 400 answer, even when it is percent-encoded.

Any other query parameter is added to the URL’s query string.

Whatever the application listening on the chosen port serves.

ViewLabelPathRequiredFrameableAliasNotes
http.contentApp content/{path}noneyesnodefault

A path of the application on this port, with any query the caller passes.

ParameterInValuesDescription
pathpathstringPath inside the application, encoded segment by segment.

Any other query parameter is added to the URL’s query string.

Whatever the application listening on the chosen port serves.

ViewLabelPathRequiredFrameableAliasNotes
https.contentApp content/{path}noneyesnodefault

A path of the application on this port, with any query the caller passes.

ParameterInValuesDescription
pathpathstringPath inside the application, encoded segment by segment.

Any other query parameter is added to the URL’s query string.