Docs

Built-in tools›Preview

Page screenshot

preview_screenshot
Group
Preview
Turned on by
Its own switch on the Tools page of Conversation settings.
Approval
Reviewed: writes and open-ended actions ask for approval unless the security level or an earlier “Always allow” covers them.
Profile key
tool.preview_screenshot.description

Captures the visible part of the conversation's preview page as a JPEG image and shows it to the model.

Only what is in view is captured, not the whole scrolling page. Only models with the Vision capability get this tool (see model properties), although Conversation settings → Tools lists it for every model.

When it asks you

Asks at Manual and Accept edits, because the image shows whatever the page is signed in to; Always allow is not offered. If you have been using the page yourself, you hand it back first in the pane; on a signed-in page, that takeover needs your approval at every security level. See Browser and preview.

Limits

The image is at most 800 pixels wide; a smaller scale shrinks it further and costs fewer tokens.

Parameters

ParameterTypeDetails
scale
Scale
numberScale factor in [0.1, 1] for the returned image; smaller images use fewer tokens. preview_click and preview_fill find elements by CSS selector or by a uid from preview_snapshot, not by pixel coordinates.
serverId
Server ID
stringServer ID

Edit this page on GitHub