curl --request GET \
--url https://signal.glasswarp.com/v1/sessions/{sessionId}/observe \
--header 'Authorization: Bearer <token>'import requests
url = "https://signal.glasswarp.com/v1/sessions/{sessionId}/observe"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://signal.glasswarp.com/v1/sessions/{sessionId}/observe', 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://signal.glasswarp.com/v1/sessions/{sessionId}/observe",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://signal.glasswarp.com/v1/sessions/{sessionId}/observe"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://signal.glasswarp.com/v1/sessions/{sessionId}/observe")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://signal.glasswarp.com/v1/sessions/{sessionId}/observe")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"width": 123,
"height": 123,
"native_width": 123,
"native_height": 123,
"timestamp": 123,
"jpeg_base64": "aSDinaTvuI8gbWludGxpZnk=",
"dirty": {
"width": 123,
"height": 123,
"available": true,
"rects": [
[
123
]
]
},
"changed": true,
"capture_mode": "dxgi",
"targets": [
{
"id": "<string>",
"x": 123,
"y": 123,
"w": 123,
"h": 123,
"role": "button",
"name": "Submit",
"source": "uia",
"focused": true,
"masked": true,
"value": "<string>"
}
],
"text": {
"window_title": "Save As",
"window_role": "window",
"targets": [
"[1] Filename (edit, focused)",
"[2] Save (button)"
],
"summary": "Focused: \"Save As\" (window); 2 target(s)"
},
"marked": true,
"timing": {
"total_ms": 123,
"screenshot_rtt_ms": 123,
"dirty_rtt_ms": 123,
"targets_rtt_ms": 123,
"host_jpeg_ms": 123,
"host_uia_ms": 123,
"image": true
}
}Observe: frame, changes, and click targets in one round trip
One-round-trip agent observe: JPEG (same options as screenshot),
dirty rects take, and sparse click targets from the host UI Automation
snapshot. Response includes structured text (window title + readable
target lines), changed (false only when DXGI dirty is available and
empty; true when dirty is unavailable — assume changed), and
capture_mode (dxgi | gdi_fallback | unknown; legacy gdi = gdi_fallback).
Password / masked fields are redacted in text and target value
(masked=true, value always [redacted]).
Set image=0 for text/targets-only verification (skips JPEG encode —
much faster). Prefer max_width=960 and quality=60 for cheap
verification-grade frames when you do need an image.
SDK applies Set-of-Mark when mark=1 and targets are present.
Coords are native capture space.
curl --request GET \
--url https://signal.glasswarp.com/v1/sessions/{sessionId}/observe \
--header 'Authorization: Bearer <token>'import requests
url = "https://signal.glasswarp.com/v1/sessions/{sessionId}/observe"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://signal.glasswarp.com/v1/sessions/{sessionId}/observe', 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://signal.glasswarp.com/v1/sessions/{sessionId}/observe",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://signal.glasswarp.com/v1/sessions/{sessionId}/observe"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://signal.glasswarp.com/v1/sessions/{sessionId}/observe")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://signal.glasswarp.com/v1/sessions/{sessionId}/observe")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"width": 123,
"height": 123,
"native_width": 123,
"native_height": 123,
"timestamp": 123,
"jpeg_base64": "aSDinaTvuI8gbWludGxpZnk=",
"dirty": {
"width": 123,
"height": 123,
"available": true,
"rects": [
[
123
]
]
},
"changed": true,
"capture_mode": "dxgi",
"targets": [
{
"id": "<string>",
"x": 123,
"y": 123,
"w": 123,
"h": 123,
"role": "button",
"name": "Submit",
"source": "uia",
"focused": true,
"masked": true,
"value": "<string>"
}
],
"text": {
"window_title": "Save As",
"window_role": "window",
"targets": [
"[1] Filename (edit, focused)",
"[2] Save (button)"
],
"summary": "Focused: \"Save As\" (window); 2 target(s)"
},
"marked": true,
"timing": {
"total_ms": 123,
"screenshot_rtt_ms": 123,
"dirty_rtt_ms": 123,
"targets_rtt_ms": 123,
"host_jpeg_ms": 123,
"host_uia_ms": 123,
"image": true
}
}Authorizations
API key in the format gw_(live|test)_sk_<hex>
Path Parameters
Query Parameters
1280
40 <= x <= 100Request SoM marking when host targets are non-empty (ignored when image=0)
0, 1 Set to 0 for text/targets-only observe (no JPEG). Use for simple verification — did the dialog close? is the field focused?
0, 1 Response
Observe payload
Omitted when image=0 (text/targets-only observe)
Accumulated DXGI dirty rects since the last take, or null when dirty metadata is unavailable (GDI capture fallback). Never a synthesized full-frame rect. Null ⇒ agents should assume changed.
Show child attributes
Show child attributes
False only when DXGI dirty was available and empty. True when dirty is null/unavailable (assume changed) or when rects exist.
Host API capture path (updates mid-session on DXGI loss → GDI fallback)
dxgi, gdi, gdi_fallback, unknown Show child attributes
Show child attributes
Compact structured text for agent decisions without image tokens
Show child attributes
Show child attributes
Server-side timing for this observe (milliseconds). Host fields are null until the paired host daemon reports them.
Show child attributes
Show child attributes
