RPC API (gRPC)

Overview

The Browser Cloud API uses gRPC (gRPC Remote Procedure Calls) with Protocol Buffers for efficient, type-safe communication. All browser sessions share a single, centralized gRPC server endpoint.

After renting a browser session, you receive a gRPC URL pointing to the central server. Each gRPC request must include your session_id and api_keyas part of the request payload to identify and authenticate your session.

Quick Start

To get started with the gRPC API:

1. Rent a browser session using the REST API
2. Connect to the provided central gRPC URL
3. Send gRPC requests with session_id and api_key in each request
4. Use the browser service methods to control the browser

// Example: Rent a browser session (REST API)
POST /api/browser/rent
{
  "apiKey": "your-api-key",
  "rentDuration": 300,
  "proxyHost": "proxy.example.com",
  "proxyPort": 8080
}

// Response includes central gRPC URL and session ID
{
  "sessionId": "ABC123",
  "grpcUrl": "localhost:50051"
}

// Connect to central gRPC endpoint and call Navigate
// Using grpcurl (example):
grpcurl -plaintext \
  localhost:50051 \
  cloudbrowser.BrowserService/Navigate \
  '{
    "session_id": "ABC123",
    "api_key": "your-api-key",
    "url": "https://example.com",
    "timeout_ms": 30000
  }'

Features

• Navigation: Navigate to URLs or load HTML content directly
• JavaScript Execution: Run JavaScript code in browser contexts
• Element Interaction: Click, fill inputs, select options, and type text
• Waiting Operations: Wait for selectors, expressions, or network requests
• Frame Management: Work with multiple frames and iframes
• Network Interception: Monitor and modify network requests
• Cookie Management: Get, set, and clear browser cookies
• Captcha Solving: Solve supported captchas (PerimeterX, Cloudflare Turnstile, DataDome)

Next Steps

For complete API documentation including all methods, request/response formats, and examples, see the API Reference.