Skip to main content

Crate bobby_browser_client

Crate bobby_browser_client 

Source
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-version
  • x-correlation-id
  • x-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 — derive schemars::JsonSchema on wire types.

Structs§

AccessibilityNode
One node in an accessibilitySnapshot result tree.
AccessibilitySnapshotCommand
AccessibilityTarget
Semantic target for accessibility-based commands (role + accessible name).
ActivatePageCommand
ArtifactId
AttachmentId
AttemptId
BrowserRuntimeClient
Authenticated HTTP client for the Bobby Browser /v1 runtime interface.
CandidateEvidence
CapabilitySet
Canonical capability set. Serializes in lexical wire order.
CaptureScreenshotCommand
CheckpointId
ClickAndWaitForDownloadCommand
ClickAndWaitForPopupCommand
ClickCommand
ClosePageCommand
CommandEnvelope
Envelope submitted to POST /v1/commands.
CommandError
CommandId
CompanionId
CompleteFormField
CompleteFormIntent
ContextAnswer
Where the retained page context says a described control is.
ContextNeighborControl
ContextNeighborStats
ContextNeighbors
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.
ContextSiteView
One remembered site’s structure: page pattern → form key → controls.
ControlActionCommand
ControlActionEvidence
CookieRecord
One cookie as returned by a cookie read on any engine.
CorrelationId
Correlation id for a single request (x-correlation-id).
CreateSessionRequest
POST /v1/sessions body.
DeleteCookiesCommand
DismissObstructionIntent
Dismiss an obstruction (overlay, cookie banner, etc.).
DownloadUrlCommand
EmulateCommand
EvaluateJavaScriptCommand
EventCursor
EvidenceId
ExecutionPolicy
Per-session gate for privileged execution. Defaults to deny; a session must opt in even when the bearer token holds the matching capability.
ExecutionRecord
ExtractField
One named field within an ExtractIntent, resolved independently of siblings.
ExtractIntent
Structured extraction intent. Replayable (does not mutate the page).
ExtractRequest
ExtractResult
Result of a structured extract command.
ExtractStructuredCommand
FillIntent
FollowIntent
Follow a control and wait for the expected destination.
FormControl
FormControlConstraints
FormControlTarget
FormControlValidity
FormDescriptor
FormGroup
FormOption
FormSnapshot
Semantic form observation returned by form-snapshot endpoints and evidence.
FormValidity
GeolocationCoordinates
GetCookiesCommand
HandleDialogCommand
IdempotencyKey
Caller-provided key that identifies a repeated request (idempotency-key).
InspectCommand
IntentHints
Optional targeting hints for intents. All fields are optional on the wire (#[serde(default)]); a body like {"role":"textbox"} must deserialize.
InterfaceError
InterfaceVersion
Marker for the sole supported interface version (CURRENT_INTERFACE_VERSION).
JobId
ListPagesCommand
LocateIntent
NavigateCommand
NavigationRequest
NavigationResult
Result of a navigation command.
NetworkLogCommand
OpenPageCommand
OpenPageRequest
POST /v1/pages body.
PageEvidence
PageId
PageState
Page within a session.
PrincipalId
Authenticated caller id. Carries no credential material.
PrintToPdfCommand
ProfileId
RecoveryCommandIdentity
RecoveryReceipt
RecoveryRecord
RecoveryRequest
RecoveryStatus
Current recovery status for a workflow (GET /v1/recovery/{id}).
RequestContext
RequestOptions
Options for a single request.
RestartLineage
RuntimeInfo
GET /v1/runtime body.
SemanticTargetSegment
SessionId
SessionState
Browser session returned by session create/list endpoints.
SetCookieParam
One cookie to store. url anchors the cookie’s origin; path, flags, and expiry are optional per the driver defaults.
SetCookiesCommand
SetEmulatedMediaCommand
SetFocusEmulationCommand
SkillCheckpointProof
SkillCommandIdentity
SkillDecision
SkillEvidenceRef
SkillIssuedDecision
SkillProfile
SkillProfileRequest
SkillSessionState
SubmitAndVerifyIntent
TargetFingerprint
TargetSpec
TypeTextCommand
UnknownCapability
A capability wire string no variant claims.
UploadFilesCommand
ViewportSize
WaitForCommand
WaitForStateIntent
WorkerId
WorkflowCheckpoint
WorkflowId

Enums§

Capability
Capability granted by a token or policy.
CheckpointInvariant
ClientError
Errors returned by BrowserRuntimeClient.
CommandClass
CommandOutcome
CommandPhase
ContextAnswerSource
How a remembered control record entered the graph.
ContextObservedAt
Provenance of a ContextAnswer: live-observed under a page generation, or remembered from the persisted per-profile context store.
ControlAction
DialogAction
ElementState
ErrorCode
ErrorLayer
Evidence
ExecutionPath
ExecutionReason
ExtractValueKind
Value to extract from a resolved field. Href is shorthand for attribute = "href"; other attributes use ExtractValueKind::Attribute.
FillValue
FormControlKind
FormControlOperation
FormControlState
FormValidityFlag
IntentCommand
IntentResolutionPath
InterfaceErrorCode
InterfaceEvent
InterfaceOperation
Transport-neutral interface operations and their required capabilities.
InterfaceValidationError
NetworkResourceType
PageMode
Page rendering / interaction mode.
PrimitiveCommand
RecoveryDecision
RecoveryReceiptState
RuntimeCommand
Nested command wire shape: { kind: "intent" | "primitive", input: … }.
RuntimeError
ScreenshotMode
SkillBrowserEngine
SkillCapability
SkillCommand
SkillFailure
SkillGhostCommand
SkillOutcome
SkillTactic
SkillZigZagZigCommand
TextMatch
WaitCondition
WaitUntil

Constants§

CURRENT_INTERFACE_VERSION
Value of the x-interface-version header for this release.
DEFAULT_DISMISS_OBSTRUCTION_TIMEOUT_MS
FORM_SNAPSHOT_SCHEMA_VERSION
Schema version for FormSnapshot payloads.
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 purpose strings.
MAX_RECOVERY_RECEIPTS
MAX_RECOVERY_RECEIPT_BYTES
MAX_RECOVERY_RECEIPT_EVIDENCE
MAX_WAIT_OBSERVED_CHARS
Upper bound on Evidence::Wait’s observed value, in characters.
SKILL_SCHEMA_VERSION