Read a remote session
curl --request POST \
--url https://api.openworklabs.com/v1/remote-sessions/read \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"messageId": "<string>",
"sessionId": "<string>",
"commandId": "<string>",
"requestId": "<string>",
"workspaceId": "<string>",
"cursor": "<string>",
"limit": 50
}
'import requests
url = "https://api.openworklabs.com/v1/remote-sessions/read"
payload = {
"messageId": "<string>",
"sessionId": "<string>",
"commandId": "<string>",
"requestId": "<string>",
"workspaceId": "<string>",
"cursor": "<string>",
"limit": 50
}
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({
messageId: '<string>',
sessionId: '<string>',
commandId: '<string>',
requestId: '<string>',
workspaceId: '<string>',
cursor: '<string>',
limit: 50
})
};
fetch('https://api.openworklabs.com/v1/remote-sessions/read', 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-sessions/read",
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([
'messageId' => '<string>',
'sessionId' => '<string>',
'commandId' => '<string>',
'requestId' => '<string>',
'workspaceId' => '<string>',
'cursor' => '<string>',
'limit' => 50
]),
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-sessions/read"
payload := strings.NewReader("{\n \"messageId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"commandId\": \"<string>\",\n \"requestId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"cursor\": \"<string>\",\n \"limit\": 50\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/remote-sessions/read")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"messageId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"commandId\": \"<string>\",\n \"requestId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"cursor\": \"<string>\",\n \"limit\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/remote-sessions/read")
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 \"messageId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"commandId\": \"<string>\",\n \"requestId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"cursor\": \"<string>\",\n \"limit\": 50\n}"
response = http.request(request)
puts response.read_body{}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
],
"message": "<string>",
"capability": "<string>"
}{
"error": "unauthorized"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>",
"retryable": true
}{
"error": "<string>",
"message": "<string>",
"retryable": true
}Automations
Read a remote session
Returns a page of a remote session’s transcript by sessionId, or a desktop task’s receipt by commandId or requestId. A desktop that has not answered within about 20 seconds returns state pending with a requestId to read later. Same result as the remote-session:read capability.
POST
/
v1
/
remote-sessions
/
read
Read a remote session
curl --request POST \
--url https://api.openworklabs.com/v1/remote-sessions/read \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"messageId": "<string>",
"sessionId": "<string>",
"commandId": "<string>",
"requestId": "<string>",
"workspaceId": "<string>",
"cursor": "<string>",
"limit": 50
}
'import requests
url = "https://api.openworklabs.com/v1/remote-sessions/read"
payload = {
"messageId": "<string>",
"sessionId": "<string>",
"commandId": "<string>",
"requestId": "<string>",
"workspaceId": "<string>",
"cursor": "<string>",
"limit": 50
}
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({
messageId: '<string>',
sessionId: '<string>',
commandId: '<string>',
requestId: '<string>',
workspaceId: '<string>',
cursor: '<string>',
limit: 50
})
};
fetch('https://api.openworklabs.com/v1/remote-sessions/read', 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-sessions/read",
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([
'messageId' => '<string>',
'sessionId' => '<string>',
'commandId' => '<string>',
'requestId' => '<string>',
'workspaceId' => '<string>',
'cursor' => '<string>',
'limit' => 50
]),
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-sessions/read"
payload := strings.NewReader("{\n \"messageId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"commandId\": \"<string>\",\n \"requestId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"cursor\": \"<string>\",\n \"limit\": 50\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/remote-sessions/read")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"messageId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"commandId\": \"<string>\",\n \"requestId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"cursor\": \"<string>\",\n \"limit\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/remote-sessions/read")
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 \"messageId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"commandId\": \"<string>\",\n \"requestId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"cursor\": \"<string>\",\n \"limit\": 50\n}"
response = http.request(request)
puts response.read_body{}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
],
"message": "<string>",
"capability": "<string>"
}{
"error": "unauthorized"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>",
"retryable": true
}{
"error": "<string>",
"message": "<string>",
"retryable": true
}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
Minimum string length:
1Minimum string length:
1Minimum string length:
1Required string length:
1 - 240Available options:
start, end Required string length:
1 - 160Required range:
1 <= x <= 100Response
The transcript page or receipt.
Was this page helpful?