Skip to main content
POST
Click, type and press keys

Authorizations

Authorization
string
header
required

A team API key, sk_offstage_…, created in the console. Everything it touches belongs to its team.

Path Parameters

sandboxId
string
required

A sandbox id, sbx_….

Body

application/json
actions
(move · object | click · object | drag · object | scroll · object | type · object | key · object | wait · object)[]
required
Required array length: 1 - 100 elements

One input action. Key, modifier and button names: key is one key after any modifiers, joined with +, like return, cmd+s or cmd+shift+t. Keys are US-layout and case-insensitive: a to z, 0 to 9, - = [ ] \ ; ' , . / `, return (or enter), tab, space, backspace (or delete), forwarddelete, escape (or esc), left, right, up, down, home, end, pageup, pagedown and f1 to f12. Modifiers are cmd (or command), shift, ctrl (or control), alt (or opt, option) and fn.

screen
object

The size of the screenshot an input call's coordinates were read from, in pixels.

Response

Every action was performed.

performed
integer
required

How many actions the Mac performed: all of them.

Required range: x >= 0