curl --request GET \
--url https://www.closient.com/byos/api/display \
--header 'Access-Token: <api-key>'import requests
url = "https://www.closient.com/byos/api/display"
headers = {"Access-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'Access-Token': '<api-key>'}};
fetch('https://www.closient.com/byos/api/display', 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://www.closient.com/byos/api/display",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Access-Token: <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"
"net/http"
"io"
)
func main() {
url := "https://www.closient.com/byos/api/display"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Access-Token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.closient.com/byos/api/display")
.header("Access-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/byos/api/display")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Access-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"device_status": "claimed",
"filename": "closient-A1B2C3-3f9a2c1d8e.png",
"firmware_url": "",
"image_url": "https://www.closient.com/byos/devices/A1B2C3/image.png",
"refresh_rate": 900,
"reset_firmware": false,
"status": 0,
"update_firmware": false
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}TRMNL display poll
Called by TRMNL firmware on every refresh cycle to decide what to paint. The server returns an image_url pointing to the device’s next PNG plus a refresh_rate telling firmware when to poll again.
Phase 1 always returns the current image_url — image generation is synchronous and per-request. A future phase will switch to S3-backed pre-rendered images so many devices can share a single render.
Auth: Access-Token header (the opaque per-device token issued by /api/setup/).
200— image ready.401— missing, unknown, or disabledAccess-Token.
curl --request GET \
--url https://www.closient.com/byos/api/display \
--header 'Access-Token: <api-key>'import requests
url = "https://www.closient.com/byos/api/display"
headers = {"Access-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'Access-Token': '<api-key>'}};
fetch('https://www.closient.com/byos/api/display', 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://www.closient.com/byos/api/display",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Access-Token: <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"
"net/http"
"io"
)
func main() {
url := "https://www.closient.com/byos/api/display"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Access-Token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.closient.com/byos/api/display")
.header("Access-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/byos/api/display")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Access-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"device_status": "claimed",
"filename": "closient-A1B2C3-3f9a2c1d8e.png",
"firmware_url": "",
"image_url": "https://www.closient.com/byos/devices/A1B2C3/image.png",
"refresh_rate": 900,
"reset_firmware": false,
"status": 0,
"update_firmware": false
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}{
"type": "https://closient.com/docs/errors/not_found",
"title": "Not Found",
"status": 404,
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"timestamp": "2026-03-31T12:00:00+00:00"
}Authorizations
Response
OK
Response to GET /api/display.
Tells the device what to draw next, how long to wait before checking again, and (optionally) whether to take firmware action.
Absolute URL the device should fetch and paint. Currently a Django view that streams the rendered 2-bit PNG.
Suggested filename for the device's local cache (the device de-dupes by this name).
Seconds the device should wait before polling /api/display again. Bounded to [60s, 24h].
60 <= x <= 86400Closient-side lifecycle state of this device. Non-standard extension to the TRMNL response — TRMNL firmware ignores it; dashboards consume it for status badges.
unclaimed, claimed, disabled TRMNL display status code. 0 means "image ready"; non-zero values are reserved for future TRMNL extensions.
Whether the device should reset to first-boot state on next reboot. Unused in Phase 1.
Whether the device should fetch new firmware. Unused in Phase 1 — Closient does not host firmware images.
URL of new firmware to fetch when update_firmware is true. Empty in Phase 1.