Request a Browser observation

curl --request POST \
  --url https://api.checkfu.com/v1/computers/{id}/screens/{screen_id}/observations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --data '
{
  "capture": {
    "accessibility_tree": true,
    "screenshot": true
  },
  "deadline": "<string>"
}
'

import requests

url = "https://api.checkfu.com/v1/computers/{id}/screens/{screen_id}/observations"

payload = {
    "capture": {
        "accessibility_tree": True,
        "screenshot": True
    },
    "deadline": "<string>"
}
headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'checkfu-version': '<checkfu-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({capture: {accessibility_tree: true, screenshot: true}, deadline: '<string>'})
};

fetch('https://api.checkfu.com/v1/computers/{id}/screens/{screen_id}/observations', 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.checkfu.com/v1/computers/{id}/screens/{screen_id}/observations",
  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([
    'capture' => [
        'accessibility_tree' => true,
        'screenshot' => true
    ],
    'deadline' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "checkfu-version: <checkfu-version>"
  ],
]);

$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.checkfu.com/v1/computers/{id}/screens/{screen_id}/observations"

	payload := strings.NewReader("{\n  \"capture\": {\n    \"accessibility_tree\": true,\n    \"screenshot\": true\n  },\n  \"deadline\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	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.checkfu.com/v1/computers/{id}/screens/{screen_id}/observations")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"capture\": {\n    \"accessibility_tree\": true,\n    \"screenshot\": true\n  },\n  \"deadline\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/computers/{id}/screens/{screen_id}/observations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"capture\": {\n    \"accessibility_tree\": true,\n    \"screenshot\": true\n  },\n  \"deadline\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "request": {
    "id": "<string>",
    "workspace_id": "<string>",
    "computer_id": "<string>",
    "expected_computer_generation": 1,
    "screen_id": "<string>",
    "attachment_id": "<string>",
    "session_id": "<string>",
    "run_id": "<string>",
    "run_attempt_id": "<string>",
    "acting_principal_id": "<string>",
    "expected_control_epoch": 1,
    "expected_observation_generation": 1,
    "expected_active_target_label": "<string>",
    "expected_target_labels": [
      "<string>"
    ],
    "expected_viewport": {
      "width": 8192,
      "height": 8192
    },
    "capture": {
      "accessibility_tree": true,
      "screenshot": true
    },
    "policy_context_digest": "<string>",
    "usage_budget_context_digest": "<string>",
    "requested_at": "<string>",
    "deadline": "<string>"
  },
  "request_fingerprint": "<string>",
  "admitted_at": "<string>"
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "validation.conflict",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-conflict"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Request a Browser observation

Queues one bounded semantic observation for the exact Computer Screen. The caller selects only accessibility-tree and screenshot capture modes plus a short deadline; the server derives the observation identity, current Computer generation, attachment, Session, Run attempt, acting Principal, control and observation epochs, profile-policy context, UsageBudget context, target labels, and viewport before any provider contact. Send Idempotency-Key for exact replay.

Checkfu support posture: alpha; hosted. No release evidence journey applies to this operation.

POST

computers

{id}

screens

{screen_id}

observations

Request a Browser observation

curl --request POST \
  --url https://api.checkfu.com/v1/computers/{id}/screens/{screen_id}/observations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --data '
{
  "capture": {
    "accessibility_tree": true,
    "screenshot": true
  },
  "deadline": "<string>"
}
'

import requests

url = "https://api.checkfu.com/v1/computers/{id}/screens/{screen_id}/observations"

payload = {
    "capture": {
        "accessibility_tree": True,
        "screenshot": True
    },
    "deadline": "<string>"
}
headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'checkfu-version': '<checkfu-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({capture: {accessibility_tree: true, screenshot: true}, deadline: '<string>'})
};

fetch('https://api.checkfu.com/v1/computers/{id}/screens/{screen_id}/observations', 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.checkfu.com/v1/computers/{id}/screens/{screen_id}/observations",
  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([
    'capture' => [
        'accessibility_tree' => true,
        'screenshot' => true
    ],
    'deadline' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "checkfu-version: <checkfu-version>"
  ],
]);

$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.checkfu.com/v1/computers/{id}/screens/{screen_id}/observations"

	payload := strings.NewReader("{\n  \"capture\": {\n    \"accessibility_tree\": true,\n    \"screenshot\": true\n  },\n  \"deadline\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	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.checkfu.com/v1/computers/{id}/screens/{screen_id}/observations")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"capture\": {\n    \"accessibility_tree\": true,\n    \"screenshot\": true\n  },\n  \"deadline\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/computers/{id}/screens/{screen_id}/observations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"capture\": {\n    \"accessibility_tree\": true,\n    \"screenshot\": true\n  },\n  \"deadline\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "request": {
    "id": "<string>",
    "workspace_id": "<string>",
    "computer_id": "<string>",
    "expected_computer_generation": 1,
    "screen_id": "<string>",
    "attachment_id": "<string>",
    "session_id": "<string>",
    "run_id": "<string>",
    "run_attempt_id": "<string>",
    "acting_principal_id": "<string>",
    "expected_control_epoch": 1,
    "expected_observation_generation": 1,
    "expected_active_target_label": "<string>",
    "expected_target_labels": [
      "<string>"
    ],
    "expected_viewport": {
      "width": 8192,
      "height": 8192
    },
    "capture": {
      "accessibility_tree": true,
      "screenshot": true
    },
    "policy_context_digest": "<string>",
    "usage_budget_context_digest": "<string>",
    "requested_at": "<string>",
    "deadline": "<string>"
  },
  "request_fingerprint": "<string>",
  "admitted_at": "<string>"
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "validation.conflict",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-conflict"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

checkfu-version

enum<string>

required

Available options:

2026-08-24

idempotency-key

string

Maximum string length: 255

Path Parameters

string

required

Pattern: ^comp_[0-9a-f]{32}$

screen_id

string

required

Pattern: ^scrn_[0-9a-f]{32}$

Body

application/json

Caller-selected Browser observation modes and deadline without resource or execution authority.

capture

object

required

Show child attributes

deadline

string

required

A canonical UTC ISO-8601 timestamp with millisecond precision.

Maximum string length: 24

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$

Response

Success

request

object

required

Show child attributes

request_fingerprint

string

required

Pattern: ^sha256:[0-9a-f]{64}$

admitted_at

string

required

A canonical UTC ISO-8601 timestamp with millisecond precision.

Maximum string length: 24

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Request a Browser observation

Authorizations

Headers

Path Parameters

Body

Response