Quickstart
Get from zero to running code in under 5 minutes.
Quickstart
This guide gets you from zero to a working WebUplink integration in three steps.
1. Get an API Key
Contact the team or visit the dashboard to provision your API key. Keys start with wup_.
export WEBUPLINK_API_KEY="wup_your_key_here"2. Install the SDK
npm install webuplinkThe SDK works with Node.js 18+ and supports both ESM and CommonJS:
// ESM
import { WebUplink } from 'webuplink';
// CommonJS
const { WebUplink } = require('webuplink');3. Browse Your First Page
import { WebUplink } from 'webuplink';
const client = new WebUplink({
apiKey: process.env.WEBUPLINK_API_KEY!,
baseUrl: 'https://api.webuplink.ai',
});
async function main() {
// Open a page — returns structured tools + summary
const page = await client.browse('https://news.ycombinator.com');
console.log('Title:', page.title);
console.log('Summary:', page.summary);
console.log('Available tools:', page.tools.map(t => t.name));
// Execute a tool on the page
if (page.tools.length > 0) {
const result = await client.browse({
session_id: page.session_id,
tool: page.tools[0].name,
params: {},
});
console.log('After action:', result.summary);
}
// Clean up
await client.closeSession(page.session_id);
}
main();What's Next?
- Core Concepts — Understand the mental model: PageMaps, tools, sessions, and actions.
- Browsing Pages — Learn about observe-only requests and
page_content. - Executing Actions — Single tools, batch execution, and
stopped_reason. - Error Handling — Handle quota limits, rate limiting, and retryable errors.