computers.useDesktop

POST

/v1/computers/{computerId}/desktop/actions

curl --request POST \
  --url https://example.com/v1/computers/example/desktop/actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "actions": [ { "_tag": "Click", "x": 1, "y": 1, "button": "left", "double": true } ] }'

Does the actions in order, then takes a screenshot.

Authorizations

• token
• session

Parameters

Path Parameters

computerId

required

string

>= 1 characters <= 128 characters

Request Body^required

Media typeapplication/json

object

actions

required

Array

>= 1 items <= 50 items

Any of:

object

object

_tag

required

string

Allowed values: Click

x

required

integer

<= 9007199254740991

y

required

integer

<= 9007199254740991

button

string

Allowed values: left right middle

double

boolean

object

object

_tag

required

string

Allowed values: Move

x

required

integer

<= 9007199254740991

y

required

integer

<= 9007199254740991

object

object

_tag

required

string

Allowed values: Drag

fromX

required

integer

<= 9007199254740991

fromY

required

integer

<= 9007199254740991

toX

required

integer

<= 9007199254740991

toY

required

integer

<= 9007199254740991

object

object

_tag

required

string

Allowed values: Scroll

x

required

integer

<= 9007199254740991

y

required

integer

<= 9007199254740991

deltaX

required

integer

>= -9007199254740991 <= 9007199254740991

deltaY

required

integer

>= -9007199254740991 <= 9007199254740991

object

object

_tag

required

string

Allowed values: Type

text

required

string

<= 10000 characters

object

object

_tag

required

string

Allowed values: Key

keys

required

Array<string>

>= 1 items <= 5 items

Responses

200

Success

Media typeapplication/json

object

mediaType

required

string

Allowed values: image/png

data

required

string

width

required

integer

>= -9007199254740991 <= 9007199254740991

height

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "mediaType": "image/png"
}

400

ComputerInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ComputerInvalid

message

required

string

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "ComputerInvalid"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: PermissionDenied

permission

required

string

Allowed values: responses.run sessions.read sessions.write requests.resolve bots.read bots.write bots.delegate bots.share triggers.read triggers.write channels.read channels.write channels.use channel_identities.read channel_identities.write connections.read connections.write apps.use apps.publish computers.read computers.write computers.use computer_providers.read computer_providers.write computer_providers.use models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read usage.read budgets.read budgets.write

resource

required

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

404

ComputerNotFound | ComputerProviderNotFound | PairingInvalid

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ComputerNotFound

id

required

string

object

object

_tag

required

string

Allowed values: ComputerProviderNotFound

id

required

string

object

object

_tag

required

string

Allowed values: PairingInvalid

Example

{
  "_tag": "ComputerNotFound"
}

409

ComputerConflict | ComputerUnsupported | ComputerNotReady

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ComputerConflict

version

required

integer

<= 9007199254740991

object

object

_tag

required

string

Allowed values: ComputerUnsupported

feature

required

string

object

object

_tag

required

string

Allowed values: ComputerNotReady

state

required

string

Allowed values: starting running paused offline failed

Example

{
  "_tag": "ComputerConflict"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

502

ComputerProviderFailed

Media typeapplication/json

object

_tag

required

string

Allowed values: ComputerProviderFailed

message

required

string

Example

{
  "_tag": "ComputerProviderFailed"
}

503

AuthorizationUnavailable | ComputersUnavailable | AuthenticationUnavailable

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: AuthorizationUnavailable

object

object

_tag

required

string

Allowed values: ComputersUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

Example

{
  "_tag": "AuthorizationUnavailable"
}