Skip to main content
POST
Send Haptic Direct Control Command

Authorizations

Authorization
string
header
required

Short-lived session token obtained from POST /api/sessions/v2. Send it as Authorization: Bearer <session_token> together with the X-Device-Key: <device-key> header identifying the target device.

Headers

X-Device-Key
string
required

Device Key (4 BIP39 words) identifying the target device. Obtain it from POST /device/otp/confirm/v2.

Pattern: ^[a-z]+-[a-z]+-[a-z]+-[a-z]+$
Example:

"alpha-bravo-charlie-delta"

Body

application/json

User can set position & velocity or position & time it will take to get the receiver there. One of the velocity or time must be specified.

position
number
required

The position of the stroker. Range: [0, 10000).

Example:

50

time
number
required

The time in milliseconds that takes to get stroker into specified position.

Example:

1

Response

200

OK