Skip to content

overview.mdx

Latest commit

 

History

History
166 lines (134 loc) · 4.37 KB

overview.mdx

File metadata and controls

166 lines (134 loc) · 4.37 KB
title API Overview
description Complete reference for the WebLinq API endpoints

The WebLinq API provides powerful endpoints for web automation and content extraction. All endpoints use REST principles and require authentication.

Need to get started quickly? Check our quickstart guide.

Base URL

https://api.weblinq.dev/v1

Always use HTTPS and include the /v1 prefix for all API requests.

Authentication

Include your API key in the Authorization header:

```bash cURL curl -X POST "https://api.weblinq.dev/v1/web/screenshot" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"url": "https://example.com"}' ``` 
const response = await fetch('https://api.weblinq.dev/v1/web/screenshot', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ url: 'https://example.com' }),
});
import requests

response = requests.post(
    'https://api.weblinq.dev/v1/web/screenshot',
    headers={'Authorization': 'Bearer YOUR_API_KEY'},
    json={'url': 'https://example.com'}
)

Available Endpoints

Web Operations

Capture webpage screenshots Convert pages to clean Markdown AI-powered structured data extraction Create PDFs from web pages Retrieve raw HTML content Extract specific elements with selectors Get all links from a page Search the web programmatically

API Keys

Generate a new API key View all your API keys View details of a specific key Revoke an API key

User

Get current user details

Files

View stored files Remove stored files

Response Format

All responses follow a standard format:

{
  "success": true,
  "data": {
    // Your response data here
  },
  "creditsCost": 1
}
{
  "success": false,
  "error": {
    "message": "Error description",
    "code": "error_code"
  }
}

Rate Limits

Rate limits are enforced per API key:

  • Free plan: 100 requests/hour
  • Pro plan: 1,000 requests/hour

Rate limit headers are included in responses:

  • X-RateLimit-Limit: Total requests allowed
  • X-RateLimit-Remaining: Remaining requests
  • X-RateLimit-Reset: Reset timestamp

Need Help?

Email us for technical support Learn about error codes