Expand description
Typed HTTP client and /v1 wire types for Bobby Browser.
The single crates.io Rust SDK package. Mirrors
@cavi-ai/bobby-browser
for Rust callers.
§Auth headers
Every request includes:
Authorization: Bearer <token>x-interface-versionx-correlation-idx-deadline
§Example
use bobby_browser_client::{BrowserRuntimeClient, CreateSessionRequest};
let client = BrowserRuntimeClient::new(
"http://127.0.0.1:7777",
std::env::var("AUTOMATION_RUNTIME_TOKEN")?,
)?;
let info = client.runtime_info(None).await?;
let session = client
.create_session(
&CreateSessionRequest {
profile: "default".into(),
proxy: None,
execution_policy: Default::default(),
},
None,
)
.await?;
client.delete_session(&session.id, None).await?;
let _ = info;§Features
schema— deriveschemars::JsonSchemaon wire types.
Structs§
- Accessibility
Node - One node in an
accessibilitySnapshotresult tree. - Accessibility
Snapshot Command - Accessibility
Target - Semantic target for accessibility-based commands (role + accessible name).
- Activate
Page Command - Artifact
Id - Attachment
Id - Attempt
Id - Browser
Runtime Client - Authenticated HTTP client for the Bobby Browser
/v1runtime interface. - Candidate
Evidence - Capability
Set - Canonical capability set. Serializes in lexical wire order.
- Capture
Screenshot Command - Checkpoint
Id - Click
AndWait ForDownload Command - Click
AndWait ForPopup Command - Click
Command - Close
Page Command - Command
Envelope - Envelope submitted to
POST /v1/commands. - Command
Error - Command
Id - Companion
Id - Complete
Form Field - Complete
Form Intent - Confidence
Metrics Snapshot - Context
Answer - Where the retained page context says a described control is.
- Context
Metrics Snapshot - Context
Neighbor Control - Context
Neighbor Stats - Context
Neighbors - The remembered form structure around a located control (
context_neighbors). Structure only: roles, names, ordinals, and per-intent counters — never values, page text, or timestamps finer than a day. - Context
Site View - One remembered site’s structure: page pattern → form key → controls.
- Control
Action Command - Control
Action Evidence - Cookie
Record - One cookie as returned by a cookie read on any engine.
- Correlation
Id - Correlation id for a single request (
x-correlation-id). - Create
Session Request POST /v1/sessionsbody.- Delete
Cookies Command - Dismiss
Obstruction Intent - Dismiss an obstruction (overlay, cookie banner, etc.).
- Download
UrlCommand - Emulate
Command - Evaluate
Java Script Command - Event
Cursor - Evidence
Id - Execution
Policy - Per-session gate for privileged execution. Defaults to deny; a session must opt in even when the bearer token holds the matching capability.
- Execution
Record - Extract
Field - One named field within an
ExtractIntent, resolved independently of siblings. - Extract
Intent - Structured extraction intent. Replayable (does not mutate the page).
- Extract
Request - Extract
Result - Result of a structured extract command.
- Extract
Structured Command - Fill
Intent - Follow
Intent - Follow a control and wait for the expected destination.
- Form
Control - Form
Control Constraints - Form
Control Target - Form
Control Validity - Form
Descriptor - Form
Group - Form
Option - Form
Snapshot - Semantic form observation returned by form-snapshot endpoints and evidence.
- Form
Validity - Geolocation
Coordinates - GetCookies
Command - Handle
Dialog Command - Idempotency
Key - Caller-provided key that identifies a repeated request (
idempotency-key). - Inspect
Command - Intent
Hints - Optional targeting hints for intents. All fields are optional on the wire
(
#[serde(default)]); a body like{"role":"textbox"}must deserialize. - Intent
Metrics Snapshot - Interface
Error - Interface
Version - Marker for the sole supported interface version (
CURRENT_INTERFACE_VERSION). - JobId
- Latency
Bucket Snapshot - Latency
Histogram Snapshot - List
Pages Command - Locate
Intent - Navigate
Command - Navigation
Request - Navigation
Result - Result of a navigation command.
- Network
LogCommand - Open
Page Command - Open
Page Request POST /v1/pagesbody.- Operational
Metrics Snapshot - Page
Evidence - PageId
- Page
State - Page within a session.
- Prefill
Metrics Snapshot - Principal
Id - Authenticated caller id. Carries no credential material.
- Print
ToPdf Command - Profile
Id - Reconciliation
Metrics Snapshot - Recovery
Command Identity - Recovery
Receipt - Recovery
Record - Recovery
Request - Recovery
Status - Current recovery status for a workflow (
GET /v1/recovery/{id}). - Request
Context - Request
Options - Options for a single request.
- Restart
Lineage - Retry
Metrics Snapshot - Revealed
Control - A form control that an action revealed (conditional field). Emitted on
ControlActionEvidenceso an agent learns about fields that did not exist at snapshot time without re-snapshotting the whole page. - Runtime
Info GET /v1/runtimebody.- Semantic
Target Segment - Session
Id - Session
State - Browser session returned by session create/list endpoints.
- SetCookie
Param - One cookie to store.
urlanchors the cookie’s origin;path, flags, and expiry are optional per the driver defaults. - SetCookies
Command - SetEmulated
Media Command - SetFocus
Emulation Command - Skill
Checkpoint Proof - Skill
Command Identity - Skill
Decision - Skill
Evidence Ref - Skill
Issued Decision - Skill
Profile - Skill
Profile Request - Skill
Session State - Submit
AndVerify Intent - Target
Fingerprint - Target
Spec - Type
Text Command - Unknown
Capability - A capability wire string no variant claims.
- Upload
Files Command - Verification
Metrics Snapshot - Viewport
Size - Vision
Metrics Snapshot - Wait
ForCommand - Wait
ForState Intent - Worker
Id - Workflow
Call Metrics Snapshot - Workflow
Checkpoint - Workflow
Id
Enums§
- Capability
- Capability granted by a token or policy.
- Checkpoint
Invariant - Client
Error - Errors returned by
BrowserRuntimeClient. - Command
Class - Command
Outcome - Command
Phase - Context
Answer Source - How a remembered control record entered the graph.
- Context
Observed At - Provenance of a
ContextAnswer: live-observed under a page generation, or remembered from the persisted per-profile context store. - Control
Action - Dialog
Action - Element
State - Error
Code - Error
Layer - Evidence
- Execution
Path - Execution
Reason - Extract
Value Kind - Value to extract from a resolved field.
Hrefis shorthand forattribute = "href"; other attributes useExtractValueKind::Attribute. - Fill
Value - Form
Control Kind - Form
Control Operation - Form
Control State - Form
Validity Flag - Intent
Command - Intent
Resolution Path - Interface
Error Code - Interface
Event - Interface
Operation - Transport-neutral interface operations and their required capabilities.
- Interface
Validation Error - Network
Resource Type - Page
Mode - Page rendering / interaction mode.
- Primitive
Command - Recovery
Decision - Recovery
Receipt State - Runtime
Command - Nested command wire shape:
{ kind: "intent" | "primitive", input: … }. - Runtime
Error - Screenshot
Mode - Skill
Browser Engine - Skill
Capability - Skill
Command - Skill
Failure - Skill
Ghost Command - Skill
Outcome - Skill
Tactic - Skill
ZigZag ZigCommand - Text
Match - Wait
Condition - Wait
Until
Constants§
- CURRENT_
INTERFACE_ VERSION - Value of the
x-interface-versionheader for this release. - DEFAULT_
DISMISS_ OBSTRUCTION_ TIMEOUT_ MS - FORM_
SNAPSHOT_ SCHEMA_ VERSION - Schema version for
FormSnapshotpayloads. - MAX_
FORM_ ACCEPT_ TYPES - MAX_
FORM_ GROUPS - MAX_
FORM_ ID_ BYTES - MAX_
FORM_ OPTIONS - MAX_
FORM_ REFERENCES - MAX_
FORM_ SNAPSHOT_ CONTROLS - MAX_
FORM_ SNAPSHOT_ FORMS - MAX_
FORM_ TARGET_ ORDINAL - MAX_
FORM_ TARGET_ PATH - MAX_
FORM_ TEXT_ BYTES - MAX_
FORM_ VALIDATION_ MESSAGE_ BYTES - MAX_
FORM_ VALUE_ BYTES - MAX_
INTENT_ PURPOSE_ BYTES - Maximum UTF-8 byte length for intent
purposestrings. - MAX_
RECOVERY_ RECEIPTS - MAX_
RECOVERY_ RECEIPT_ BYTES - MAX_
RECOVERY_ RECEIPT_ EVIDENCE - MAX_
WAIT_ OBSERVED_ CHARS - Upper bound on
Evidence::Wait’sobservedvalue, in characters. - SKILL_
SCHEMA_ VERSION