List screenshots

Lists screenshots in this project, newest first. Screenshots are kept for 7 days.

GET /v1/render/screenshots
Lists screenshots in this project, newest first. Screenshots are kept for 7 days.

Authentication

Bearer Token (b3os_sk_ API key or b3os_pat_ token) API Key (cookie: __Host-b3os_session)

Query Parameters

limit integer optional query
Page size, from 1 to 100.
cursor string optional query
Opaque cursor from the previous page's `next_cursor`. Omit it for the first page.

Responses

200 A page of screenshots.
application/json
object string REQUIRED
Enum: list
data object[] REQUIRED
Array of:
id string REQUIRED
object string REQUIRED
Enum: screenshot
status string REQUIRED
Screenshots are synchronous, so a stored screenshot always succeeded.
Enum: succeeded
source object REQUIRED
url string (uri)
html boolean
Present when the screenshot rendered inline HTML.
Enum: true
profile string
width integer REQUIRED
height integer REQUIRED
format string REQUIRED
Enum: webp, png, jpeg
artifacts object[] REQUIRED
The primary image first, then variants.
Array of:
id string REQUIRED
object string REQUIRED
Enum: artifact
kind string REQUIRED
Enum: image, mp4, gif, poster, vtt, srt
content_type string REQUIRED
bytes integer
width integer
height integer
duration_ms integer
url string (uri)
Signed URL on `usercontent.b3os.org`, `https://usercontent.b3os.org/a/<id in host-safe form>/<name>?node=&exp=&sig=`: an Ed25519 signature by the node's key over the method, path and expiry (`renderGetArtifactContent`), no cookies. It works as soon as the artifact is reported, while the upload to storage is still finishing.
url_expires_at string (date-time)
created_at string (date-time)
expires_at string (date-time)
When the artifact is deleted.
created_at string (date-time) REQUIRED
expires_at string (date-time) REQUIRED
timing object
Server-side phase durations in milliseconds with microsecond resolution: the same phases as the `Server-Timing` header, keyed `<phase>_ms`. `total_ms` is always present. Phase names are product-specific and documented per operation. Example values in this reference are illustrative, not measurements.
total_ms number REQUIRED
metadata object REQUIRED
Up to 16 string key-value pairs you attach to an object for your own use. Keys are 1 to 40 characters of `A-Z a-z 0-9 _ . : -`; values are at most 500 characters. B3OS never interprets them.
next_cursor string | null REQUIRED
400 The request failed validation (`invalid_request`, `invalid_url`).
401 Missing, malformed, expired or revoked credentials (`unauthorized`).
403 Authenticated but not allowed (`forbidden`, `egress_denied`).
429 A rate, concurrency or quota limit applies (`rate_limited`, `concurrency_limited`, `quota_exceeded`).
500 Something failed inside B3OS (`internal`). Retry with backoff.
503 The node or the product is not available right now (`node_unavailable`, `product_unavailable`, `capacity_unavailable`). 
curl -X GET 'https://beta-api.b3os.org/v1/render/screenshots' \  -H 'Authorization: Bearer YOUR_API_TOKEN'
const response = await fetch('https://beta-api.b3os.org/v1/render/screenshots', {  method: 'GET',  headers: {      "Authorization": "Bearer YOUR_API_TOKEN"  }});const data = await response.json();console.log(data);
import requestsheaders = {    'Authorization': 'Bearer YOUR_API_TOKEN'}response = requests.get('https://beta-api.b3os.org/v1/render/screenshots', headers=headers)print(response.json())
200 Response 
{  "object": "list",  "data": [    {      "id": "shot_01m5t4gy1j4hazr9khn5x51m6f",      "object": "screenshot",      "status": "succeeded",      "source": {        "url": "https://app.example.com/billing"      },      "width": 1792,      "height": 1092,      "format": "webp",      "artifacts": [],      "created_at": "2026-10-25T18:40:00.000Z",      "expires_at": "2026-11-01T18:40:00.118Z",      "metadata": {}    }  ],  "next_cursor": null}
Previous Export a profile's state
Next Take a screenshot
Ask a question... ⌘I