curl --request PUT \
--url https://api.openworklabs.com/v1/remote-devices/this-computer \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"installId": "<string>",
"label": "<string>",
"appVersion": "<string>",
"osVersion": "<string>",
"arch": "<string>",
"computerUse": {
"enabled": true,
"remoteEnabled": true,
"selectedId": "<string>",
"computers": [
{
"id": "<string>",
"label": "<string>",
"detail": "<string>",
"externalId": "<string>"
}
],
"permissions": {
"accessibility": true,
"screenRecording": true
}
}
}
'import requests
url = "https://api.openworklabs.com/v1/remote-devices/this-computer"
payload = {
"installId": "<string>",
"label": "<string>",
"appVersion": "<string>",
"osVersion": "<string>",
"arch": "<string>",
"computerUse": {
"enabled": True,
"remoteEnabled": True,
"selectedId": "<string>",
"computers": [
{
"id": "<string>",
"label": "<string>",
"detail": "<string>",
"externalId": "<string>"
}
],
"permissions": {
"accessibility": True,
"screenRecording": True
}
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
installId: '<string>',
label: '<string>',
appVersion: '<string>',
osVersion: '<string>',
arch: '<string>',
computerUse: {
enabled: true,
remoteEnabled: true,
selectedId: '<string>',
computers: [
{id: '<string>', label: '<string>', detail: '<string>', externalId: '<string>'}
],
permissions: {accessibility: true, screenRecording: true}
}
})
};
fetch('https://api.openworklabs.com/v1/remote-devices/this-computer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.openworklabs.com/v1/remote-devices/this-computer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'installId' => '<string>',
'label' => '<string>',
'appVersion' => '<string>',
'osVersion' => '<string>',
'arch' => '<string>',
'computerUse' => [
'enabled' => true,
'remoteEnabled' => true,
'selectedId' => '<string>',
'computers' => [
[
'id' => '<string>',
'label' => '<string>',
'detail' => '<string>',
'externalId' => '<string>'
]
],
'permissions' => [
'accessibility' => true,
'screenRecording' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.openworklabs.com/v1/remote-devices/this-computer"
payload := strings.NewReader("{\n \"installId\": \"<string>\",\n \"label\": \"<string>\",\n \"appVersion\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"arch\": \"<string>\",\n \"computerUse\": {\n \"enabled\": true,\n \"remoteEnabled\": true,\n \"selectedId\": \"<string>\",\n \"computers\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"detail\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n ],\n \"permissions\": {\n \"accessibility\": true,\n \"screenRecording\": true\n }\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.openworklabs.com/v1/remote-devices/this-computer")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"installId\": \"<string>\",\n \"label\": \"<string>\",\n \"appVersion\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"arch\": \"<string>\",\n \"computerUse\": {\n \"enabled\": true,\n \"remoteEnabled\": true,\n \"selectedId\": \"<string>\",\n \"computers\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"detail\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n ],\n \"permissions\": {\n \"accessibility\": true,\n \"screenRecording\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/remote-devices/this-computer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"installId\": \"<string>\",\n \"label\": \"<string>\",\n \"appVersion\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"arch\": \"<string>\",\n \"computerUse\": {\n \"enabled\": true,\n \"remoteEnabled\": true,\n \"selectedId\": \"<string>\",\n \"computers\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"detail\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n ],\n \"permissions\": {\n \"accessibility\": true,\n \"screenRecording\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"device": {
"id": "<string>",
"kind": "desktop",
"provider": "openwork_desktop",
"source": "desktop_app",
"platform": "darwin",
"label": "<string>",
"access": "mine",
"availability": "online",
"state": "ready",
"statusDetail": "<string>",
"lastSeenAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"appVersion": "<string>",
"computerId": "<string>",
"workbotChat": "<string>",
"canRename": true,
"canRemove": true,
"workingSince": "2023-11-07T05:31:56Z",
"disconnectedAt": "2023-11-07T05:31:56Z",
"canDisconnect": false,
"remoteAccess": {
"effective": "off",
"chosen": true,
"reason": "organization"
}
},
"reportAfterSeconds": 123
}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
],
"message": "<string>",
"capability": "<string>"
}{
"error": "unauthorized"
}{
"error": "computer_disconnected",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "rate_limited"
}Report this desktop and how its computer use is doing
Sent by the signed-in desktop app on launch, when something changes and every few minutes. Creates or refreshes this desktop in the caller’s list, records what changed (app update, computer use needing setup, the computer agents use) and does the same for VMs the desktop is configured to reach. Names, versions and readiness only: no file paths, window titles or screen content. installId is the id the desktop registers its runner with, so the same computer is one entry. A desktop that was disconnected from the organization is answered 403 computer_disconnected and its entry is left as it was, unless the report comes with a sign-in made after the disconnect, which connects it again. Requires active organization membership; device ownership and management permissions still apply.
curl --request PUT \
--url https://api.openworklabs.com/v1/remote-devices/this-computer \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"installId": "<string>",
"label": "<string>",
"appVersion": "<string>",
"osVersion": "<string>",
"arch": "<string>",
"computerUse": {
"enabled": true,
"remoteEnabled": true,
"selectedId": "<string>",
"computers": [
{
"id": "<string>",
"label": "<string>",
"detail": "<string>",
"externalId": "<string>"
}
],
"permissions": {
"accessibility": true,
"screenRecording": true
}
}
}
'import requests
url = "https://api.openworklabs.com/v1/remote-devices/this-computer"
payload = {
"installId": "<string>",
"label": "<string>",
"appVersion": "<string>",
"osVersion": "<string>",
"arch": "<string>",
"computerUse": {
"enabled": True,
"remoteEnabled": True,
"selectedId": "<string>",
"computers": [
{
"id": "<string>",
"label": "<string>",
"detail": "<string>",
"externalId": "<string>"
}
],
"permissions": {
"accessibility": True,
"screenRecording": True
}
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
installId: '<string>',
label: '<string>',
appVersion: '<string>',
osVersion: '<string>',
arch: '<string>',
computerUse: {
enabled: true,
remoteEnabled: true,
selectedId: '<string>',
computers: [
{id: '<string>', label: '<string>', detail: '<string>', externalId: '<string>'}
],
permissions: {accessibility: true, screenRecording: true}
}
})
};
fetch('https://api.openworklabs.com/v1/remote-devices/this-computer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.openworklabs.com/v1/remote-devices/this-computer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'installId' => '<string>',
'label' => '<string>',
'appVersion' => '<string>',
'osVersion' => '<string>',
'arch' => '<string>',
'computerUse' => [
'enabled' => true,
'remoteEnabled' => true,
'selectedId' => '<string>',
'computers' => [
[
'id' => '<string>',
'label' => '<string>',
'detail' => '<string>',
'externalId' => '<string>'
]
],
'permissions' => [
'accessibility' => true,
'screenRecording' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.openworklabs.com/v1/remote-devices/this-computer"
payload := strings.NewReader("{\n \"installId\": \"<string>\",\n \"label\": \"<string>\",\n \"appVersion\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"arch\": \"<string>\",\n \"computerUse\": {\n \"enabled\": true,\n \"remoteEnabled\": true,\n \"selectedId\": \"<string>\",\n \"computers\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"detail\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n ],\n \"permissions\": {\n \"accessibility\": true,\n \"screenRecording\": true\n }\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.openworklabs.com/v1/remote-devices/this-computer")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"installId\": \"<string>\",\n \"label\": \"<string>\",\n \"appVersion\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"arch\": \"<string>\",\n \"computerUse\": {\n \"enabled\": true,\n \"remoteEnabled\": true,\n \"selectedId\": \"<string>\",\n \"computers\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"detail\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n ],\n \"permissions\": {\n \"accessibility\": true,\n \"screenRecording\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/remote-devices/this-computer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"installId\": \"<string>\",\n \"label\": \"<string>\",\n \"appVersion\": \"<string>\",\n \"osVersion\": \"<string>\",\n \"arch\": \"<string>\",\n \"computerUse\": {\n \"enabled\": true,\n \"remoteEnabled\": true,\n \"selectedId\": \"<string>\",\n \"computers\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"detail\": \"<string>\",\n \"externalId\": \"<string>\"\n }\n ],\n \"permissions\": {\n \"accessibility\": true,\n \"screenRecording\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"device": {
"id": "<string>",
"kind": "desktop",
"provider": "openwork_desktop",
"source": "desktop_app",
"platform": "darwin",
"label": "<string>",
"access": "mine",
"availability": "online",
"state": "ready",
"statusDetail": "<string>",
"lastSeenAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"appVersion": "<string>",
"computerId": "<string>",
"workbotChat": "<string>",
"canRename": true,
"canRemove": true,
"workingSince": "2023-11-07T05:31:56Z",
"disconnectedAt": "2023-11-07T05:31:56Z",
"canDisconnect": false,
"remoteAccess": {
"effective": "off",
"chosen": true,
"reason": "organization"
}
},
"reportAfterSeconds": 123
}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
],
"message": "<string>",
"capability": "<string>"
}{
"error": "unauthorized"
}{
"error": "computer_disconnected",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "rate_limited"
}Authorizations
Body
Was this page helpful?