Get a Computer Screen

curl --request GET \
  --url https://api.checkfu.com/v1/computers/{id}/screens/{screen_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'checkfu-version: <checkfu-version>'

import requests

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

headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'checkfu-version': '<checkfu-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.checkfu.com/v1/computers/{id}/screens/{screen_id}', 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}",
  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>",
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("checkfu-version", "<checkfu-version>")
	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://api.checkfu.com/v1/computers/{id}/screens/{screen_id}")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "workspace_id": "<string>",
  "computer_id": "<string>",
  "computer_generation": 1,
  "active_attachment_id": "<string>",
  "product_subject": {
    "type": "application",
    "application_subject": "<string>"
  },
  "state": "idle",
  "control_epoch": 1,
  "observation_generation": 1,
  "width": 8192,
  "height": 8192,
  "scale": 4.125,
  "active_target_label": "<string>",
  "created_at": "<string>",
  "updated_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": "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"
  }
}

Get a Computer Screen

Returns one stable public Screen head nested under its Computer. The response includes only provider-neutral lifecycle, generation, logical viewport, observed display scale, attachment, control, and target-label facts; provider allocations and browser target coordinates remain private. A mismatched Computer and Screen pair is not addressable.

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

GET

computers

{id}

screens

{screen_id}

Get a Computer Screen

curl --request GET \
  --url https://api.checkfu.com/v1/computers/{id}/screens/{screen_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'checkfu-version: <checkfu-version>'

import requests

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

headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'checkfu-version': '<checkfu-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.checkfu.com/v1/computers/{id}/screens/{screen_id}', 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}",
  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>",
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("checkfu-version", "<checkfu-version>")
	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://api.checkfu.com/v1/computers/{id}/screens/{screen_id}")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "workspace_id": "<string>",
  "computer_id": "<string>",
  "computer_generation": 1,
  "active_attachment_id": "<string>",
  "product_subject": {
    "type": "application",
    "application_subject": "<string>"
  },
  "state": "idle",
  "control_epoch": 1,
  "observation_generation": 1,
  "width": 8192,
  "height": 8192,
  "scale": 4.125,
  "active_target_label": "<string>",
  "created_at": "<string>",
  "updated_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": "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-27

Path Parameters

string

required

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

screen_id

string

required

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

Response

A stable public provider-neutral presentation head without allocation or target coordinates.

string

required

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

workspace_id

string

required

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

computer_id

string

required

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

computer_generation

integer

required

Required range: x > 0

active_attachment_id

string | null

required

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

product_subject

object | null

required

Show child attributes

state

enum<string>

required

Available options:

idle,

agent_controlling,

handoff_requested,

human_controlling,

returning_control,

recovering,

unavailable

control_epoch

integer

required

Required range: x >= 0

observation_generation

integer

required

Required range: x >= 0

width

integer

required

Required range: 0 < x <= 16384

height

integer

required

Required range: 0 < x <= 16384

scale

number

required

Observed device pixels per logical Screen pixel, from 0.25 through 8.

Required range: 0.25 <= x <= 8

active_target_label

string | null

required

Required string length: 1 - 128

Pattern: ^[a-z0-9][a-z0-9._-]*$

created_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$

updated_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

Get a Computer Screen

Authorizations

Headers

Path Parameters

Response