Report what happened to a chat's cloud computer
curl --request POST \
--url https://api.openworklabs.com/v1/workbot/devices/computer \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"sessionId": "<string>",
"chat": "<string>",
"code": "<string>",
"control": false
}
'import requests
url = "https://api.openworklabs.com/v1/workbot/devices/computer"
payload = {
"sessionId": "<string>",
"chat": "<string>",
"code": "<string>",
"control": False
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({sessionId: '<string>', chat: '<string>', code: '<string>', control: false})
};
fetch('https://api.openworklabs.com/v1/workbot/devices/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/workbot/devices/computer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sessionId' => '<string>',
'chat' => '<string>',
'code' => '<string>',
'control' => false
]),
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/workbot/devices/computer"
payload := strings.NewReader("{\n \"sessionId\": \"<string>\",\n \"chat\": \"<string>\",\n \"code\": \"<string>\",\n \"control\": false\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.openworklabs.com/v1/workbot/devices/computer")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sessionId\": \"<string>\",\n \"chat\": \"<string>\",\n \"code\": \"<string>\",\n \"control\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/workbot/devices/computer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sessionId\": \"<string>\",\n \"chat\": \"<string>\",\n \"code\": \"<string>\",\n \"control\": false\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"message": "<string>"
}{
"error": "unauthorized"
}{
"error": "insufficient_scope"
}{
"error": "<string>",
"message": "<string>"
}Workbot
Report what happened to a chat's cloud computer
For the Workbot app only. With a live Workbot member token (read and write scopes), records that a view of the chat’s cloud computer was opened, that it was paused, resumed, rebuilt or handed back to Workbot, that it could not connect (a fixed code, never error text), or that it was removed with its chat. The computer is listed for the member from its first report. Repeated viewer renewals are recorded once per sitting.
POST
/
v1
/
workbot
/
devices
/
computer
Report what happened to a chat's cloud computer
curl --request POST \
--url https://api.openworklabs.com/v1/workbot/devices/computer \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"sessionId": "<string>",
"chat": "<string>",
"code": "<string>",
"control": false
}
'import requests
url = "https://api.openworklabs.com/v1/workbot/devices/computer"
payload = {
"sessionId": "<string>",
"chat": "<string>",
"code": "<string>",
"control": False
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({sessionId: '<string>', chat: '<string>', code: '<string>', control: false})
};
fetch('https://api.openworklabs.com/v1/workbot/devices/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/workbot/devices/computer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sessionId' => '<string>',
'chat' => '<string>',
'code' => '<string>',
'control' => false
]),
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/workbot/devices/computer"
payload := strings.NewReader("{\n \"sessionId\": \"<string>\",\n \"chat\": \"<string>\",\n \"code\": \"<string>\",\n \"control\": false\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.openworklabs.com/v1/workbot/devices/computer")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sessionId\": \"<string>\",\n \"chat\": \"<string>\",\n \"code\": \"<string>\",\n \"control\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/workbot/devices/computer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sessionId\": \"<string>\",\n \"chat\": \"<string>\",\n \"code\": \"<string>\",\n \"control\": false\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"message": "<string>"
}{
"error": "unauthorized"
}{
"error": "insufficient_scope"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
denApiKeybearerAuth
Organization API key passed as the x-api-key header. The raw key is the header value; do not prefix it with Bearer.
Body
application/json
Pattern:
^hs_[A-Za-z0-9_-]{8,96}$Required string length:
1 - 96Available options:
viewer_opened, paused, resumed, rebuilt, continued, failed, removed Pattern:
^[a-z][a-z0-9_]{0,63}$Available options:
browser, computer Response
Recorded.
Was this page helpful?