Skip to main content
The Uplink JavaScript SDK provides a Puppeteer/Playwright-like API for controlling mobile browsers remotely. This reference covers all available classes, methods, and types.
Key terminology:
  • Device: A physical iOS or Android device
  • Worker: A worker created using the native Uplink SDK (a device can create multiple workers)
  • Address: A hex-encoded identifier used to reference specific workers

Installation

Optional: AI Automation

For AI-powered browser automation with natural language instructions:
See the AI Automation section for details.

Quick example

API structure

The SDK is organized into four main classes, plus an optional AI automation package:

Client

Main entry point for connecting to Uplink and managing workers

ClientWorker

Represents a worker (Uplink SDK running on a physical device)

Browser

Browser instance running on a device

Page

Browser tab/window with automation methods

AI Automation

Optional: Natural language actions and data extraction

TypeScript support

The SDK is written in TypeScript and includes full type definitions:

Error handling

All async methods can throw errors. Always use try-catch for robust automation:

Common patterns

Connection and cleanup

Waiting for workers

Multi-page automation

Next steps

Client API

Connection and device management

Page API

Browser automation methods