Get your first API response in minutes with this step-by-step guide.
1

Get your API key

  1. Sign up for WebLinq - it’s free to start
  2. Go to API Keys in your dashboard
  3. Click “Create API Key” and give it a name
Copy your API key immediately - you won’t see it again after creation.
2

Make your first request

Let’s extract content from a webpage using the markdown endpoint:
curl -X POST "https://api.weblinq.dev/v1/web/markdown" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'
Replace YOUR_API_KEY with the actual API key from your dashboard.
3

Understanding the response

You’ll receive a JSON response with the extracted content:
{
  "success": true,
  "data": {
    "markdown": "# Example Domain\n\nThis domain is for use in illustrative examples...",
    "metadata": {
      "title": "Example Domain",
      "description": "This domain is for use in illustrative examples...",
      "url": "https://example.com",
      "timestamp": "2024-01-15T10:30:00Z",
      "wordCount": 42
    }
  },
  "creditsCost": 1
}
The data.markdown field contains the extracted content, while metadata provides additional page information.
4

Try other endpoints

Now explore these popular endpoints:

Take Screenshot

Capture page screenshots

Extract Data

Get structured JSON data

Search Web

Search the internet

Generate PDF

Create PDF documents

​
Quick tips

​
Need help?

Get Support

Email us for technical support and questions