Press one or more keys on the host computer

POST /browsers/{id}/computer/press_key

Press one or more keys on the host computer

cURL

curl --request POST \
  --url https://api.onkernel.com/browsers/{id}/computer/press_key \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "keys": [
    "<string>"
  ],
  "duration": 0,
  "hold_keys": [
    "<string>"
  ]
}
'

400

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Browser session ID

Body

application/json

keys · string[] · required

List of key symbols to press. Each item should be a key symbol supported by xdotool (see X11 keysym definitions). Examples include "Return", "Shift", "Ctrl", "Alt", "F5". Items in this list could also be combinations, e.g. "Ctrl+t" or "Ctrl+Shift+Tab".

duration · integer · default: 0

Duration to hold the keys down in milliseconds. If omitted or 0, keys are tapped.

Required range: x >= 0

hold_keys · string[]

Optional modifier keys to hold during the key press sequence.

Response

200

Keys pressed successfully