Documentation Index
Fetch the complete documentation index at: https://mintlify.com/steerlabs/opensteer/llms.txt
Use this file to discover all available pages before exploring further.
Overview
OpenSteer provides methods to retrieve the current page state and capture screenshots.Methods
state
Returns the current state of the page including URL, title, and HTML content.Object containing current page state
Example
screenshot
Captures a screenshot of the current page.Optional configuration for the screenshot
Whether to capture the full scrollable page. Default:
falseImage format. Default:
'png'JPEG quality (0-100). Only applies when
type is 'jpeg'. Default: 90Whether to omit the default white background. Default:
falseImage data as a Node.js Buffer
Example
Types
StateResult
The state of the current page:Current URL of the page
Title of the page
HTML content of the page (cleaned snapshot)
ScreenshotOptions
Configuration options for screenshots:Capture the full scrollable page instead of just the viewport
Image format
JPEG quality from 0 to 100. Ignored for PNG images
Hides default white background and allows capturing screenshots with transparency
BoundingBox
Represents the position and dimensions of an element:X coordinate of the element in pixels
Y coordinate of the element in pixels
Width of the element in pixels
Height of the element in pixels
Related methods
- snapshot() - Get cleaned HTML snapshot with counters
- goto() - Navigate to different pages
- screenshot() - Capture page screenshot