Skip to content

Quick Start

Get Browserman running in under 5 minutes.

Prerequisites

  • Email address for account creation
  • At least one social media account to automate

Step 1: Sign Up (30 seconds)

  1. Go to app.browserman.run
  2. Click Sign Up
  3. Enter email and create password
  4. Verify your email

Step 2: Get Your API Key (30 seconds)

  1. Log into the dashboard
  2. Click Settings in sidebar
  3. Go to API Keys
  4. Click Generate New Key
  5. Copy and save your key securely

Step 3: Connect an Account (1 minute)

  1. Click Accounts in sidebar
  2. Click Add Account
  3. Select Twitter (or your preferred platform)
  4. Click Connect with OAuth
  5. Authorize in the popup
  6. Name it "my-twitter"

Step 4: Test It (2 minutes)

Option A: Using Dashboard

  1. Go to Tasks > New Task
  2. Select account: "my-twitter"
  3. Select tool: "Create Tweet"
  4. Enter text: "Testing Browserman! 🚀"
  5. Click Execute
  6. View result

Option B: Using API

bash
curl -X POST https://api.browserman.run/api/tasks \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "platform": "twitter",
    "tool": "createTweet",
    "accountName": "my-twitter",
    "parameters": {
      "text": "Testing Browserman! 🚀"
    }
  }'

Option C: Using MCP with Claude

  1. Open your Claude config file:

    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    • Windows: %APPDATA%\Claude\claude_desktop_config.json
  2. Add this configuration:

    json
    {
      "mcpServers": {
        "browserman": {
          "url": "https://mcp.browserman.run",
          "headers": {
            "Authorization": "Bearer YOUR_API_KEY"
          }
        }
      }
    }
  3. Restart Claude Desktop

  4. Tell Claude:

    Post a tweet saying "Testing Browserman! 🚀"
    using my my-twitter account

You're Done! 🎉

You've successfully:

  • ✅ Created a Browserman account
  • ✅ Generated an API key
  • ✅ Connected a social media account
  • ✅ Posted your first automated message

What's Next?

Explore More Platforms

Connect other accounts:

Try More Tools

Each platform has multiple tools:

Twitter:

  • likeTweet - Like tweets
  • reTweet - Retweet
  • replyTweet - Reply to tweets
  • quoteTweet - Quote with comment

View all tools →

Build Automations

Create workflows:

javascript
// Daily posting routine
async function dailyRoutine() {
  // Morning tweet
  await postTweet({
    text: 'Good morning! ☀️',
    accountName: 'my-twitter'
  });

  // Market update
  await postToXueqiu({
    text: 'Market analysis...',
    accountName: 'my-xueqiu'
  });

  // Evening summary
  setTimeout(async () => {
    await postTweet({
      text: 'End of day summary...',
      accountName: 'my-twitter'
    });
  }, 12 * 60 * 60 * 1000); // 12 hours
}

Advanced Features

  • Multi-account management - Handle multiple accounts per platform
  • Task queuing - Queue hundreds of tasks
  • Rate limiting - Automatic rate limit management
  • Error recovery - Automatic retry on failures
  • Full browser mode - Better platform compatibility

Common Next Steps

1. Add More Accounts

Go to Accounts > Add Account and connect:

  • Different platforms
  • Multiple accounts per platform
  • Work and personal accounts

2. Generate Client Code

Use the OpenAPI schema to generate API clients:

bash
# Get the schema
curl https://api.browserman.run/api/platforms/schema > schema.json

# Generate client (example for TypeScript)
npx openapi-generator-cli generate \
  -i schema.json \
  -g typescript-fetch \
  -o ./browserman-client

3. Set Up Monitoring

Track your automation:

  • Check Tasks page for history
  • Set up webhooks for notifications
  • Monitor rate limits
  • Review error logs

4. Create Workflows

Combine multiple actions:

javascript
// Engagement workflow
async function engageWithTrends() {
  const trends = await getTrends();

  for (const trend of trends.slice(0, 5)) {
    const tweet = await findRelevantTweet(trend);
    await likeTweet({ tweetUrl: tweet.url });
    await retweet({ tweetUrl: tweet.url });

    // Wait to avoid rate limits
    await sleep(60000);
  }
}

Need Help?

Documentation

Support

Tips for Success

  1. Start small - Test with one account first
  2. Use descriptive names - Name accounts clearly
  3. Monitor initially - Watch first few tasks closely
  4. Respect limits - Don't exceed platform rate limits
  5. Use full mode - When lite mode gets detected

Example Use Cases

Personal

  • Auto-post daily updates
  • Schedule tweets
  • Engage with mentions
  • Monitor keywords

Business

  • Multi-account management
  • Content distribution
  • Customer engagement
  • Brand monitoring

Development

  • Testing social features
  • Bot development
  • Data collection
  • Research projects

Quick Reference

API Endpoints

bash
# List platforms
GET https://api.browserman.run/api/platforms

# List accounts
GET https://api.browserman.run/api/accounts

# Create task
POST https://api.browserman.run/api/tasks

# Check task status
GET https://api.browserman.run/api/tasks/:taskId

Platform Rate Limits

  • Twitter: ~300 tweets/3 hours
  • Xueqiu: ~50 posts/day
  • Eastmoney: ~100 comments/day
  • Tonghuashun: ~30 posts/day

Execution Engines

json
// Lite mode (default)
{ "preferredEngine": "lite" }

// Full mode (better compatibility)
{ "preferredEngine": "full" }

Ready to build? Dive into the full guide →