Integrating WebRun into your applications is straightforward with our REST API. This guide walks you through everything you need to get started.

Prerequisites

Before you begin, make sure you have:

  • A WebRun account (sign up at app.webrun.ai)
  • Your API key from the dashboard
  • A tool for making HTTP requests (curl, Postman, or your favorite programming language)

Your First Request

The simplest way to test the API is with a basic extraction request:

POST https://api.webrun.ai/v1/extract
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "url": "https://example.com",
  "prompt": "Extract the main heading and first paragraph"
}

Understanding the Response

WebRun returns structured data based on your prompt:

{
  "success": true,
  "data": {
    "heading": "Example Domain",
    "paragraph": "This domain is for use in illustrative examples..."
  },
  "session_id": "sess_abc123"
}

Common Use Cases

The REST API is perfect for:

  • Data extraction - Pull structured data from any webpage
  • Form automation - Fill and submit forms programmatically
  • Screenshot capture - Get visual snapshots of pages
  • Content monitoring - Track changes over time

Rate Limits

Free tier accounts have the following limits:

  • 100 requests per hour
  • 1,000 requests per month
  • 30-second timeout per request

Upgrade to a paid plan for higher limits and priority processing.

Next Steps

Now that you understand the basics, explore our advanced features:

  • WebSocket integration for real-time sessions
  • OpenAI-compatible API for seamless LLM integration
  • MCP Server for Claude integration

Check the full API reference at docs.webrun.ai/api-reference.