Actions
Type text
Type a string on the computer keyboard, one character at a time.
POST
Type text
Types text on the computer keyboard. Each character is sent as an individual keystroke, so unicode characters and printable symbols are supported.
Path parameters
Query parameters
Which screen to type on. Optional. Omit it to
act on the screen the computer booted with. An unknown id returns
404 rather
than falling back to the default screen. A Windows computer ignores this
parameter.Body parameters
Text to type. Unicode is supported. Nothing checks that it is present:
omitting it types the empty string and still returns
200 (with
text_length: 0 on Linux), so a body that lost its text looks like a
success.Delay between keystrokes, in milliseconds. Optional. Omitting it, or sending
0, uses 12. Lower values type faster; higher values help with inputs that
drop fast keystrokes. A Windows computer refuses this field with 400.The API waits at most 30 seconds for the computer to finish typing. The text
takes about
delay_ms per character, so at the default of 12 ms anything over
roughly 2,500 characters returns 503 with code: "ECONNABORTED", and the
text may be only partly typed. Split long text into several requests.A Windows computer ignores
?screen= and accepts only text in the body. Any
other field, including delay_ms, returns 400, and so does text longer
than 20,000 bytes. A successful response is {"ok": true}.Response
Carries
text_length, the length of the typed text in bytes, not
characters. A non-ASCII character counts as more than one.Example
Response
Errors
Every failure raised after the request leaves the API layer also carries a
request_id. Quote it in support requests. When the computer agent itself
answered non-2xx, the body additionally carries upstream_status.
Authorizations
Query Parameters
Body
application/json
Text to type. Unicode is supported. Not validated: omitting it types the empty string and still returns 200.
Response
Text typed. details.text_length is the length in bytes, not characters.