Skip to main content
GET
Take screenshot
Captures the computer’s display. By default it returns a stored image URL. Use response_format=binary for image bytes in the same response, or response_format=base64 for inline JSON. Inline responses skip storage and a second download.

Path parameters

string
required
Computer ID (UUID). An instance_id is not accepted here and fails with 500.

Query parameters

string
Which screen to capture. Optional. Omit it to capture the screen the computer booted with. An unknown id returns 404 rather than falling back to the default screen. A Windows computer ignores this parameter.
string
default:"url"
url, base64, or binary. Binary returns the image with its actual Content-Type. Base64 returns {success, image, mime_type, width, height}, where image is raw base64.
string
png, jpeg, or webp. Omit to preserve the captured format.
integer
default:"80"
An integer from 1 through 100. Applies when the image is re-encoded as JPEG or WebP, which happens when you request a format or a scale below 1.
number
default:"1"
Greater than 0 and at most 1. For example, 0.5 halves both dimensions.
For a smaller response, request ?response_format=binary&format=webp&quality=75&scale=0.5.

URL response

boolean
Always true on a 200. A failed capture is an error status, not success: false.
string
Path to the stored image, relative to https://www.orgo.ai. For example: /api/storage/4d96f9a0-1c2b-4f3e-9a7d-8b5c6e0f1a2d/2026-04-20T12-00-00-000Z_9f2b7c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d.png. It is not an absolute URL, so join it to the origin before fetching. The path does not expire, but it is not public: fetch it with the same Authorization header, as an account that can view the computer’s workspace. A request without credentials returns 401, and one without access returns 404. A workspace-scoped key cannot fetch it at all (403), so use response_format=base64 or binary with a scoped key.
object
Information about the stored image.
Stored filenames and Content-Type match the encoded image: .png, .jpg, or .webp. Inline responses use Cache-Control: private, no-store.

Example

Response

Errors

Every failure raised after the request leaves the API layer also carries a request_id. Quote it in support requests. When the computer agent itself answered non-2xx, the body additionally carries upstream_status.

Authorizations

Authorization
string
header
required

API key authentication. Get your key at orgo.ai/workspaces

Path Parameters

id
string
required

Computer ID

Query Parameters

screen
string

Which screen to act on. Omit for the boot screen. An unknown id returns 404 rather than falling back.

response_format
enum<string>
default:url

How to return the image.

Available options:
url,
base64,
binary
format
enum<string>

Optional output encoding. Omit to preserve the guest encoding.

Available options:
png,
jpeg,
webp
quality
integer
default:80

JPEG/WebP encoding quality. Use with an explicit format.

Required range: 1 <= x <= 100
scale
number
default:1

Image dimensions as a fraction of the source. Coordinates in click/type APIs remain unscaled.

Required range: x <= 1

Response

Screenshot captured

success
boolean
image
string

Stored URL for url mode; raw base64 for base64 mode.

mime_type
string
width
integer
height
integer
metadata
object