Authentication

All WebUplink API requests require a Bearer token in the Authorization header.

API Keys

API keys are provisioned through the dashboard. They start with wup_ and should be kept secret.

# Set as environment variable
export WEBUPLINK_API_KEY="wup_your_key_here"

SDK Configuration

import { WebUplink } from 'webuplink';

const client = new WebUplink({
  apiKey: process.env.WEBUPLINK_API_KEY!,
  baseUrl: 'https://api.webuplink.ai',
});

Direct HTTP

curl -X POST https://api.webuplink.ai/v1/browse \
  -H "Authorization: Bearer wup_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

Security Best Practices

• Never commit API keys to version control
• Use environment variables or a secrets manager
• Rotate keys if they may have been exposed
• Use the minimum plan that meets your needs

Playground Tokens

The documentation playground uses scoped tokens with limited permissions:

• Browse-only — Can observe pages but cannot execute tools
• 30-minute TTL — Automatically expire
• No billing access — Cannot view usage or manage subscriptions

Playground tokens are intended for the docs site only. Use your full API key for production integrations.