Displays: Input Actions

Send low-level input events — mouse clicks, keyboard keys, drags, scrolls, and window management commands — to a connected display host. These endpoints let you automate GUI interactions, query display and window state, and manage windows programmatically. Every endpoint targets a single display, identified either by the *-display-N.* hostname pattern or the displayId query parameter.

Display State

`GET /api/v1/display/input/display-geometry`

Get the dimensions of the display (width, height, and screen index).

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

curl -X GET "https://display.local/api/v1/display/input/display-geometry?displayId=1"

const { data } = await client.display.input.geometry({ displayId: 1 });

{
  "success": true,
  "width": 1920,
  "height": 1080,
  "screen": 0
}

`GET /api/v1/display/mouse/location`

Get the current cursor position, including the screen index and window under the cursor.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1-999999

curl -X GET "https://display.local/api/v1/display/mouse/location?displayId=1"

const { data } = await client.display.input.mouseLocation({ displayId: 1 });

{
  "success": true,
  "x": 540,
  "y": 320,
  "screen": 0,
  "window": 524288
}

`GET /api/v1/display/window/{windowId}/geometry`

Get the position and size of a specific window.

Parameters

Name	In	Type	Required	Description
`windowId`	path	string	Yes	Window ID (decimal or hex).
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

curl -X GET "https://display.local/api/v1/display/window/0x80010/geometry?displayId=1"

const { data } = await client.display.input.windowGeometry({
  windowId: "0x80010",
  displayId: 1
});

{
  "success": true,
  "windowId": 524304,
  "x": 120,
  "y": 80,
  "width": 800,
  "height": 600
}

`GET /api/v1/display/window/{windowId}/name`

Get the title of a specific window.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1-999999
`windowId`	path	string	Yes	Window ID (decimal or hex)

curl -X GET "https://display.local/api/v1/display/window/0x80010/name?displayId=1"

const { data } = await client.display.input.windowName({
  windowId: "0x80010",
  displayId: 1
});

{
  "success": true,
  "windowId": 524304,
  "name": "Terminal — bash"
}

`GET /api/v1/display/window/active`

Get the ID of the currently focused (active) window.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

curl -X GET "https://display.local/api/v1/display/window/active?displayId=1"

const { data } = await client.display.input.windowActive({ displayId: 1 });

{
  "success": true,
  "windowId": 524304
}

Composite Input Actions

`POST /api/v1/display/input/act`

Execute a single named action (e.g. mouse/click, keyboard/type) with an optional post-action screenshot.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1-999999

Request Body

Field	Type	Required	Description
`action`	string	Yes	Action path (e.g. `mouse/click`, `keyboard/type`). Max length: 50.
`params`	object	No	Action-specific parameters. Default: `{}`.
`screenshot`	boolean	No	Capture screenshot after action. Default: `true`.
`screenshotDelay`	integer	No	Delay before screenshot in milliseconds. Range: 0–5000. Default: `100`.
`screenshotRegion`	string	No	Crop region in format `x1,y1,x2,y2`. Pattern: `^\d+,\d+,\d+,\d+$`. Max length: 40.

curl -X POST "https://display.local/api/v1/display/input/act?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "mouse/click",
    "params": { "x": 540, "y": 320, "button": 1 },
    "screenshot": true
  }'

const { data } = await client.display.input.act({
  displayId: 1,
  data: {
    action: "mouse/click",
    params: { x: 540, y: 320, button: 1 },
    screenshot: true
  }
});

{
  "success": true,
  "action": {
    "success": true,
    "action": "mouse/click",
    "details": {}
  },
  "screenshot": {
    "timestamp": "2025-01-15T10:30:00.000Z",
    "image": {
      "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAAB...",
      "mimeType": "image/png",
      "dataUrl": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUg..."
    }
  }
}

`POST /api/v1/display/input/batch`

Execute a sequence of actions in order. Returns per-action results for completed, failed, and skipped actions.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`actions`	array	Yes	Array of actions to execute. 1–50 items.
`actions[].action`	string	Yes	Action path (e.g. `mouse/click`, `keyboard/type`).
`actions[].params`	object	No	Action-specific parameters.

curl -X POST "https://display.local/api/v1/display/input/batch?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{
    "actions": [
      { "action": "mouse/click", "params": { "x": 100, "y": 200 } },
      { "action": "keyboard/type", "params": { "text": "hello" } },
      { "action": "keyboard/key", "params": { "keys": ["Return"] } }
    ]
  }'

const { data } = await client.display.input.batch({
  displayId: 1,
  data: {
    actions: [
      { action: "mouse/click", params: { x: 100, y: 200 } },
      { action: "keyboard/type", params: { text: "hello" } },
      { action: "keyboard/key", params: { keys: ["Return"] } }
    ]
  }
});

{
  "success": true,
  "completed": [
    { "index": 0, "action": "mouse/click", "success": true },
    { "index": 1, "action": "keyboard/type", "success": true },
    { "index": 2, "action": "keyboard/key", "success": true }
  ],
  "failed": {
    "index": 0,
    "action": "mouse/click",
    "error": "Coordinates out of bounds"
  },
  "skipped": [3]
}

`POST /api/v1/display/input/click-at`

Move the cursor to a position and click a mouse button in a single operation.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`x`	integer	Yes	X coordinate.
`y`	integer	Yes	Y coordinate.
`button`	integer	No	Mouse button (1=left, 2=middle, 3=right, 4–7=extra). Default: `1`.

curl -X POST "https://display.local/api/v1/display/input/click-at?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "x": 540, "y": 320, "button": 1 }'

const { data } = await client.display.input.clickAt({
  displayId: 1,
  data: { x: 540, y: 320, button: 1 }
});

{
  "success": true,
  "action": "click-at",
  "details": {
    "x": 540,
    "y": 320,
    "button": 1
  }
}

`POST /api/v1/display/input/drag`

Drag from a start position to an end position with optional step count for smooth movement.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`startX`	integer	Yes	Starting X coordinate.
`startY`	integer	Yes	Starting Y coordinate.
`endX`	integer	Yes	Ending X coordinate.
`endY`	integer	Yes	Ending Y coordinate.
`button`	integer	No	Mouse button (1=left, 2=middle, 3=right, 4–7=extra). Default: `1`.
`steps`	integer	No	Number of intermediate mouse positions for smooth drag. Range: 1–1000.

curl -X POST "https://display.local/api/v1/display/input/drag?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{
    "startX": 100,
    "startY": 200,
    "endX": 500,
    "endY": 200,
    "steps": 20
  }'

const { data } = await client.display.input.drag({
  displayId: 1,
  data: {
    startX: 100,
    startY: 200,
    endX: 500,
    endY: 200,
    steps: 20
  }
});

{
  "success": true,
  "action": "drag",
  "details": {
    "startX": 100,
    "startY": 200,
    "endX": 500,
    "endY": 200,
    "steps": 20
  }
}

`POST /api/v1/display/input/reset`

Emergency release all held inputs — releases any keys or mouse buttons currently held down. No request body.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

curl -X POST "https://display.local/api/v1/display/input/reset?displayId=1"

const { data } = await client.display.input.reset({ displayId: 1 });

{
  "success": true,
  "action": "reset",
  "details": {
    "released": ["Shift_L", "Button1"]
  }
}

`POST /api/v1/display/input/select`

Select a range by clicking at a start position and shift-clicking at an end position.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1-999999

Request Body

Field	Type	Required	Description
`x`	integer	Yes	Start X coordinate.
`y`	integer	Yes	Start Y coordinate.
`endX`	integer	Yes	End X coordinate.
`endY`	integer	Yes	End Y coordinate.

curl -X POST "https://display.local/api/v1/display/input/select?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "x": 200, "y": 300, "endX": 600, "endY": 300 }'

const { data } = await client.display.input.select({
  displayId: 1,
  data: { x: 200, y: 300, endX: 600, endY: 300 }
});

{
  "success": true,
  "action": "select",
  "details": {
    "start": { "x": 200, "y": 300 },
    "end": { "x": 600, "y": 300 }
  }
}

`POST /api/v1/display/input/type-at`

Move the cursor to a position, click, and type text in one operation.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`x`	integer	Yes	X coordinate to click.
`y`	integer	Yes	Y coordinate to click.
`text`	string	Yes	Text to type. Max length: 10000.
`delay`	integer	No	Inter-keystroke delay in milliseconds. Range: 0–1000.

curl -X POST "https://display.local/api/v1/display/input/type-at?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "x": 540, "y": 320, "text": "user@example.com", "delay": 10 }'

const { data } = await client.display.input.typeAt({
  displayId: 1,
  data: { x: 540, y: 320, text: "user@example.com", delay: 10 }
});

{
  "success": true,
  "action": "type-at",
  "details": {
    "x": 540,
    "y": 320,
    "charsTyped": 16
  }
}

`POST /api/v1/display/input/wait`

Wait for a specified duration, with an optional screenshot capture after the wait.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`ms`	integer	Yes	Wait duration in milliseconds. Range: 50–30000.
`screenshot`	boolean	No	Capture screenshot after wait. Default: `false`.

curl -X POST "https://display.local/api/v1/display/input/wait?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "ms": 2000, "screenshot": true }'

const { data } = await client.display.input.wait({
  displayId: 1,
  data: { ms: 2000, screenshot: true }
});

{
  "success": true,
  "action": "wait",
  "details": {
    "ms": 2000
  },
  "screenshot": {
    "timestamp": "2025-01-15T10:30:02.000Z",
    "image": {
      "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAAB...",
      "mimeType": "image/png",
      "dataUrl": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUg..."
    }
  }
}

Keyboard

`POST /api/v1/display/keyboard/key`

Press one or more key combinations (e.g. ctrl+c, Return). Keys are pressed and released sequentially.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`keys`	array	Yes	Key combinations (e.g. `["ctrl+c", "Return"]`). 1–20 items. Each max length: 100.
`window`	integer \| string	No	Target window ID.
`delay`	integer	No	Delay between keys in milliseconds. Range: 0–5000.
`clearModifiers`	boolean	No	Clear modifier keys before pressing.

curl -X POST "https://display.local/api/v1/display/keyboard/key?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "keys": ["ctrl+c"] }'

const { data } = await client.display.input.keyboardKey({
  displayId: 1,
  data: { keys: ["ctrl+c"] }
});

{
  "success": true,
  "action": "key",
  "details": {
    "keys": ["ctrl+c"]
  }
}

`POST /api/v1/display/keyboard/key-down`

Press and hold a key. Use the matching key-up endpoint to release it, or set holdMs for auto-release.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`key`	string	Yes	Key name (X11 keysym, e.g. `Shift_L`, `ctrl`). Max length: 100.
`window`	integer \| string	No	Target window ID.
`holdMs`	integer	No	Auto-release after this many milliseconds. Range: 100–60000.

curl -X POST "https://display.local/api/v1/display/keyboard/key-down?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "key": "Shift_L", "holdMs": 3000 }'

const { data } = await client.display.input.keyboardKeyDown({
  displayId: 1,
  data: { key: "Shift_L", holdMs: 3000 }
});

{
  "success": true,
  "action": "key-down",
  "details": {
    "key": "Shift_L",
    "holdMs": 3000
  }
}

`POST /api/v1/display/keyboard/key-up`

Release a previously held key.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`key`	string	Yes	Key name (X11 keysym). Max length: 100.
`window`	integer \| string	No	Target window ID.

curl -X POST "https://display.local/api/v1/display/keyboard/key-up?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "key": "Shift_L" }'

const { data } = await client.display.input.keyboardKeyUp({
  displayId: 1,
  data: { key: "Shift_L" }
});

{
  "success": true,
  "action": "key-up",
  "details": {
    "key": "Shift_L"
  }
}

`POST /api/v1/display/keyboard/type`

Type a string of text, sending each character as a keystroke.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`text`	string	Yes	Text to type. Max length: 10000.
`window`	integer \| string	No	Target window ID.
`delay`	integer	No	Inter-keystroke delay in milliseconds. Range: 0–1000.
`clearModifiers`	boolean	No	Clear modifier keys before typing.

curl -X POST "https://display.local/api/v1/display/keyboard/type?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "text": "Hello, world!", "delay": 5 }'

const { data } = await client.display.input.keyboardType({
  displayId: 1,
  data: { text: "Hello, world!", delay: 5 }
});

{
  "success": true,
  "action": "type",
  "details": {
    "charsTyped": 13
  }
}

Mouse

`POST /api/v1/display/mouse/click`

Click a mouse button at the current cursor position, optionally repeating with a delay.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`button`	integer	No	Mouse button (1=left, 2=middle, 3=right, 4–7=extra). Default: `1`.
`repeat`	integer	No	Number of times to repeat the click. Range: 1–100. Default: `1`.
`delay`	integer	No	Delay between repeats in milliseconds. Range: 0–5000.
`window`	integer \| string	No	Target window ID (decimal or hex `0x...`).

curl -X POST "https://display.local/api/v1/display/mouse/click?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "button": 1, "repeat": 1 }'

const { data } = await client.display.input.mouseClick({
  displayId: 1,
  data: { button: 1, repeat: 1 }
});

{
  "success": true,
  "action": "click",
  "details": {
    "button": 1,
    "repeat": 1
  }
}

`POST /api/v1/display/mouse/double-click`

Double-click a mouse button at the current cursor position.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`button`	integer	No	Mouse button. Range: 1–7. Default: `1`.
`window`	integer \| string	No	Target window ID.

curl -X POST "https://display.local/api/v1/display/mouse/double-click?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "button": 1 }'

const { data } = await client.display.input.mouseDoubleClick({
  displayId: 1,
  data: { button: 1 }
});

{
  "success": true,
  "action": "double-click",
  "details": {
    "button": 1
  }
}

`POST /api/v1/display/mouse/down`

Press and hold a mouse button. Use the matching mouse/up endpoint to release it, or set holdMs for auto-release.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`button`	integer	No	Mouse button. Range: 1–7. Default: `1`.
`window`	integer \| string	No	Target window ID.
`holdMs`	integer	No	Auto-release after this many milliseconds. Range: 100–60000.

curl -X POST "https://display.local/api/v1/display/mouse/down?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "button": 1, "holdMs": 5000 }'

const { data } = await client.display.input.mouseDown({
  displayId: 1,
  data: { button: 1, holdMs: 5000 }
});

{
  "success": true,
  "action": "mouse-down",
  "details": {
    "button": 1,
    "holdMs": 5000
  }
}

`POST /api/v1/display/mouse/move`

Move the cursor to an absolute position on the display.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`x`	integer	Yes	Target X coordinate. Range: `-65535` to `65535`.
`y`	integer	Yes	Target Y coordinate. Range: `-65535` to `65535`.
`window`	integer \| string	No	Target window ID.
`screen`	integer	No	Screen index. Range: 0–15.
`sync`	boolean	No	Synchronize the move event.

curl -X POST "https://display.local/api/v1/display/mouse/move?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "x": 540, "y": 320 }'

const { data } = await client.display.input.mouseMove({
  displayId: 1,
  data: { x: 540, y: 320 }
});

{
  "success": true,
  "action": "mouse-move",
  "details": {
    "x": 540,
    "y": 320
  }
}

`POST /api/v1/display/mouse/move-relative`

Move the cursor by a relative offset from its current position.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`x`	integer	Yes	Horizontal offset in pixels.
`y`	integer	Yes	Vertical offset in pixels.
`sync`	boolean	No	Synchronize the move event.

curl -X POST "https://display.local/api/v1/display/mouse/move-relative?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "x": 50, "y": -20 }'

const { data } = await client.display.input.mouseMoveRelative({
  displayId: 1,
  data: { x: 50, y: -20 }
});

{
  "success": true,
  "action": "mouse-move-relative",
  "details": {
    "dx": 50,
    "dy": -20
  }
}

`POST /api/v1/display/mouse/scroll`

Scroll in a specified direction with a configurable number of click units.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`direction`	string	Yes	Scroll direction. One of: `up`, `down`, `left`, `right`.
`clicks`	integer	No	Number of scroll click units. Range: 1–100. Default: `5`.

curl -X POST "https://display.local/api/v1/display/mouse/scroll?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "direction": "down", "clicks": 3 }'

const { data } = await client.display.input.mouseScroll({
  displayId: 1,
  data: { direction: "down", clicks: 3 }
});

{
  "success": true,
  "action": "scroll",
  "details": {
    "direction": "down",
    "clicks": 3
  }
}

`POST /api/v1/display/mouse/up`

Release a previously held mouse button.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`button`	integer	No	Mouse button. Range: 1–7. Default: `1`.
`window`	integer \| string	No	Target window ID.

curl -X POST "https://display.local/api/v1/display/mouse/up?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "button": 1 }'

const { data } = await client.display.input.mouseUp({
  displayId: 1,
  data: { button: 1 }
});

{
  "success": true,
  "action": "mouse-up",
  "details": {
    "button": 1
  }
}

Window Management

`POST /api/v1/display/window/close`

Close a window by its ID.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`windowId`	integer \| string	Yes	Window ID (decimal or hex `0x...`).

curl -X POST "https://display.local/api/v1/display/window/close?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "windowId": "0x80010" }'

const { data } = await client.display.input.windowClose({
  displayId: 1,
  data: { windowId: "0x80010" }
});

{
  "success": true,
  "action": "window-close",
  "details": {
    "windowId": 524304
  }
}

`POST /api/v1/display/window/focus`

Focus (activate) a window by its ID, bringing it to the foreground.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`windowId`	integer \| string	Yes	Window ID (decimal or hex `0x...`).

curl -X POST "https://display.local/api/v1/display/window/focus?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "windowId": "0x80010" }'

const { data } = await client.display.input.windowFocus({
  displayId: 1,
  data: { windowId: "0x80010" }
});

{
  "success": true,
  "action": "window-focus",
  "details": {
    "windowId": 524304
  }
}

`POST /api/v1/display/window/minimize`

Minimize (iconify) a window by its ID.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`windowId`	integer \| string	Yes	Window ID (decimal or hex `0x...`).

curl -X POST "https://display.local/api/v1/display/window/minimize?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "windowId": "0x80010" }'

const { data } = await client.display.input.windowMinimize({
  displayId: 1,
  data: { windowId: "0x80010" }
});

{
  "success": true,
  "action": "window-minimize",
  "details": {
    "windowId": 524304
  }
}

`POST /api/v1/display/window/move`

Move a window to a new position. Use relative: true to move by an offset from the current position.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`windowId`	integer \| string	Yes	Window ID (decimal or hex `0x...`).
`x`	integer	Yes	Target X coordinate (or relative offset if `relative` is `true`).
`y`	integer	Yes	Target Y coordinate (or relative offset if `relative` is `true`).
`sync`	boolean	No	Synchronize the move event.
`relative`	boolean	No	Interpret `x` and `y` as relative offsets.

curl -X POST "https://display.local/api/v1/display/window/move?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "windowId": "0x80010", "x": 100, "y": 50 }'

const { data } = await client.display.input.windowMove({
  displayId: 1,
  data: { windowId: "0x80010", x: 100, y: 50 }
});

{
  "success": true,
  "action": "window-move",
  "details": {
    "windowId": 524304,
    "x": 100,
    "y": 50
  }
}

`POST /api/v1/display/window/raise`

Raise a window to the top of the stacking order so it appears above other windows.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`windowId`	integer \| string	Yes	Window ID (decimal or hex `0x...`).

curl -X POST "https://display.local/api/v1/display/window/raise?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "windowId": "0x80010" }'

const { data } = await client.display.input.windowRaise({
  displayId: 1,
  data: { windowId: "0x80010" }
});

{
  "success": true,
  "action": "window-raise",
  "details": {
    "windowId": 524304
  }
}

`POST /api/v1/display/window/resize`

Resize a window to a specific width and height.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`windowId`	integer \| string	Yes	Window ID (decimal or hex `0x...`).
`width`	integer	Yes	Target width in pixels. Minimum: 0.
`height`	integer	Yes	Target height in pixels. Minimum: 0.
`sync`	boolean	No	Synchronize the resize event.
`useHints`	boolean	No	Use X11 size hints when resizing.

curl -X POST "https://display.local/api/v1/display/window/resize?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "windowId": "0x80010", "width": 1024, "height": 768 }'

const { data } = await client.display.input.windowResize({
  displayId: 1,
  data: { windowId: "0x80010", width: 1024, height: 768 }
});

{
  "success": true,
  "action": "window-resize",
  "details": {
    "windowId": 524304,
    "width": 1024,
    "height": 768
  }
}

`POST /api/v1/display/window/search`

Search for windows by a regex pattern matched against window name, class, or classname.

Parameters

Name	In	Type	Required	Description
`displayId`	query	integer	No	Display ID to use (overrides the `-display-N.` hostname pattern). Valid range: 1–999999.

Request Body

Field	Type	Required	Description
`pattern`	string	Yes	Search pattern (regex). Max length: 200.
`name`	boolean	No	Search by window name/title.
`class`	boolean	No	Search by window class.
`classname`	boolean	No	Search by window classname.
`onlyVisible`	boolean	No	Only return visible windows.

curl -X POST "https://display.local/api/v1/display/window/search?displayId=1" \
  -H "Content-Type: application/json" \
  -d '{ "pattern": "Terminal", "name": true, "onlyVisible": true }'

const { data } = await client.display.input.windowSearch({
  displayId: 1,
  data: { pattern: "Terminal", name: true, onlyVisible: true }
});

{
  "success": true,
  "windows": [524304, 524310, 524322]
}