Struct BrowsrClient 

pub struct BrowsrClient { /* private fields */ }

Browsr HTTP client for browser automation.

Example

use browsr_client::BrowsrClient;

// From environment variables (BROWSR_BASE_URL, BROWSR_API_KEY)
let client = BrowsrClient::from_env();

// From explicit URL (for local development)
let client = BrowsrClient::new("http://localhost:8082");

// With API key authentication
let client = BrowsrClient::new("https://api.browsr.dev")
    .with_api_key("your-api-key");

Implementations

impl BrowsrClient

pub fn new(base_url: impl Into<String>) -> Self

Create a new client with the specified base URL (no authentication). For local development, use this method.

pub fn from_env() -> Self

Create a new client from environment variables.

• BROWSR_BASE_URL: Base URL (defaults to https://api.browsr.dev)
• BROWSR_API_KEY: Optional API key for authentication

pub fn from_client_config(config: BrowsrClientConfig) -> Self

Create a new client from explicit configuration.

pub fn with_api_key(self, api_key: impl Into<String>) -> Self

Set the API key for authentication. This rebuilds the HTTP client with the new authentication header.

pub fn new_http(base_url: impl Into<String>) -> Self

Create HTTP transport client (legacy method).

pub fn new_stdout(command: impl Into<String>) -> Self

Create stdout transport client.

pub fn from_config(cfg: TransportConfig) -> Self

Create client from transport config (legacy method).

pub fn base_url(&self) -> &str

Get the base URL.

pub fn config(&self) -> &BrowsrClientConfig

Get the current configuration.

pub fn has_auth(&self) -> bool

Check if the client has authentication configured.

pub fn is_local(&self) -> bool

Check if this is a local development client.

pub async fn list_sessions(&self) -> Result<Vec<String>, ClientError>

List all active browser sessions.

pub async fn create_session(&self) -> Result<SessionCreated, ClientError>

Create a new browser session. Returns the full session info including viewer_url, sse_url, and frame_url.

pub async fn destroy_session(&self, session_id: &str) -> Result<(), ClientError>

Destroy a browser session.

pub async fn create_shell_session( &self, request: ShellCreateSessionRequest, ) -> Result<ShellCreateSessionResponse, ClientError>

Create a new shell session.

pub async fn list_shell_sessions( &self, ) -> Result<ShellSessionListResponse, ClientError>

List active shell sessions.

pub async fn terminate_shell_session( &self, session_id: &str, ) -> Result<ShellTerminateResponse, ClientError>

Terminate a shell session.

pub async fn shell_exec( &self, request: ShellExecRequest, ) -> Result<ShellExecResponse, ClientError>

Execute a shell command in an existing shell session.

pub async fn execute_commands( &self, commands: Vec<Commands>, session_id: Option<String>, headless: Option<bool>, context: Option<BrowserContext>, ) -> Result<AutomateResponse, ClientError>

Execute a list of browser commands.

pub async fn execute_command( &self, command: Commands, session_id: Option<String>, headless: Option<bool>, ) -> Result<AutomateResponse, ClientError>

Execute a single browser command.

pub async fn navigate( &self, url: &str, session_id: Option<String>, ) -> Result<AutomateResponse, ClientError>

Navigate to a URL.

pub async fn click( &self, selector: &str, session_id: Option<String>, ) -> Result<AutomateResponse, ClientError>

Click an element by selector.

pub async fn type_text( &self, selector: &str, text: &str, clear: Option<bool>, session_id: Option<String>, ) -> Result<AutomateResponse, ClientError>

Type text into an element.

pub async fn wait_for_element( &self, selector: &str, timeout_ms: Option<u64>, session_id: Option<String>, ) -> Result<AutomateResponse, ClientError>

Wait for an element to appear.

pub async fn screenshot( &self, full_page: bool, session_id: Option<String>, ) -> Result<AutomateResponse, ClientError>

Take a screenshot.

pub async fn get_title( &self, session_id: Option<String>, ) -> Result<AutomateResponse, ClientError>

Get page title.

pub async fn get_text( &self, selector: &str, session_id: Option<String>, ) -> Result<AutomateResponse, ClientError>

Get text content of an element.

pub async fn get_content( &self, selector: Option<String>, session_id: Option<String>, ) -> Result<AutomateResponse, ClientError>

Get HTML content of an element or page.

pub async fn evaluate( &self, expression: &str, session_id: Option<String>, ) -> Result<AutomateResponse, ClientError>

Evaluate JavaScript expression.

pub async fn extract_structured( &self, query: &str, schema: Option<Value>, max_chars: Option<usize>, session_id: Option<String>, ) -> Result<AutomateResponse, ClientError>

Extract structured content from the current page using AI.

Arguments

• query - Natural language description of what to extract
• schema - Optional JSON schema for the output
• max_chars - Optional maximum characters to process
• session_id - Optional session ID

Example

let data = client.extract_structured(
    "Extract all product names and prices",
    None,
    None,
).await?;

pub async fn observe( &self, session_id: Option<String>, headless: Option<bool>, opts: ObserveOptions, ) -> Result<ObserveResponse, ClientError>

Observe the current browser state (screenshot + DOM snapshot).

pub async fn cdp( &self, session_id: impl Into<String>, method: impl Into<String>, params: Option<Value>, ) -> Result<Value, ClientError>

Execute a raw CDP request against an existing session.

pub async fn relay_events( &self, session_id: &str, limit: Option<usize>, ) -> Result<RelayEventsResponse, ClientError>

List recent buffered relay events for a relay session.

pub async fn list_relay_sessions( &self, ) -> Result<RelaySessionListResponse, ClientError>

List relay sessions visible to the current authenticated user.

pub async fn clear_relay_events( &self, session_id: &str, ) -> Result<Value, ClientError>

Clear buffered relay events for a relay session.

pub async fn scrape_v1( &self, request: ScrapeApiRequest, ) -> Result<ScrapeApiResponse, ClientError>

Scrape a URL with full format options (v1 API).

pub async fn scrape_url( &self, url: &str, ) -> Result<ScrapeApiResponse, ClientError>

Scrape a URL with default options (markdown output).

pub async fn crawl( &self, request: CrawlApiRequest, ) -> Result<CrawlApiResponse, ClientError>

Crawl a website starting from a URL.

pub async fn crawl_url( &self, url: &str, ) -> Result<CrawlApiResponse, ClientError>

Crawl a URL with default options (markdown, 10 pages, depth 2).

pub async fn search( &self, options: SearchOptions, ) -> Result<SearchResponse, ClientError>

Perform a web search via the /v1/search endpoint.

pub async fn search_query( &self, query: &str, ) -> Result<SearchResponse, ClientError>

Search with a query string.

pub async fn step( &self, request: BrowserStepRequest, ) -> Result<BrowserStepResult, ClientError>

Execute a browser step with commands and optional context.

This is the primary method for agent integration, providing full control over browser automation with context for sequence persistence.

Arguments

• request - Full browser step request with commands and context

Example

use browsr_client::{BrowsrClient, BrowserStepRequest, BrowserStepInput};
use browsr_types::Commands;

let client = BrowsrClient::from_env();

let input = BrowserStepInput::new(vec![
    Commands::NavigateTo { url: "https://example.com".to_string() },
    Commands::Screenshot { full_page: Some(false), path: None },
]);

let request = BrowserStepRequest::new(input)
    .with_session_id("my-session")
    .with_thread_id("thread-123");

let result = client.step(request).await?;
println!("Success: {}, URL: {:?}", result.success, result.url);

pub async fn step_commands( &self, commands: Vec<Commands>, ) -> Result<BrowserStepResult, ClientError>

Execute a browser step with just commands (simple usage).

Use this for quick automation tasks without context tracking.

Example

use browsr_client::BrowsrClient;
use browsr_types::Commands;

let client = BrowsrClient::from_env();

let result = client.step_commands(vec![
    Commands::NavigateTo { url: "https://example.com".to_string() },
]).await?;

Trait Implementations

impl Clone for BrowsrClient

fn clone(&self) -> BrowsrClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BrowsrClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.