Skip to main content

Computer Use Proxy (PATCH)

PATCH /v1/computeruse/{session_id}/{path}

Send a request, with any method, to the Computer Use API running inside your session's VM; the path after /v1/computeruse/\{session_id\}/ is passed through. Screenshots and recording downloads are streamed back. When you stop a recording through this route, its video is saved to your account in the background and then appears in GET /v1/recordings.

Authentication​

Requires authentication via: OAuth2PasswordBearer.

Parameters​

NameInTypeRequiredDescriptionConstraints
session_idpathstringYes
pathpathstringYes
X-API-Keyheaderstring | nullNonullable

Responses​

200​

Successful Response

application/json​

Resolved schema:

{}

400​

session_id is not a valid UUID, the session has no VM, or its VM is not active.

No response body.

401​

No credentials, or the Bearer token / X-API-Key is invalid.

No response body.

403​

The account is disabled, or a guest token was used; or the session belongs to another account.

No response body.

404​

Session not found.

No response body.

422​

Validation Error

application/json​

Resolved schema:

{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}

Field details:

FieldTypeRequiredDescriptionConstraints
detailarray<object>No
detail[]objectNo
detail[].locarray<string | integer>No
detail[].loc[]string | integerNo
detail[].msgstringNo
detail[].typestringNo

502​

Could not reach the Computer Use service inside the VM.

No response body.

503​

The VM is being recovered or moved; retry once recovery completes.

No response body.

504​

Timed out connecting to the Computer Use service inside the VM.

No response body.