Skip to content

introduction.mdx

Latest commit

 

History

History
61 lines (46 loc) · 1.42 KB

introduction.mdx

File metadata and controls

61 lines (46 loc) · 1.42 KB
Raw
title API Reference
description Complete reference for the WebLinq API

API Reference

Welcome to the WebLinq API documentation. Our REST API enables powerful web automation, content extraction, and data transformation capabilities.

Base URL

https://api.weblinq.dev/v1

Authentication

All endpoints require authentication using a Bearer token:

curl -H "Authorization: Bearer YOUR_API_KEY" https://api.weblinq.dev/v1/...

Get your API key from the dashboard.

Quick Start

[Create an API key](https://weblinq.dev/dashboard/api-keys) from your dashboard. Try extracting content from a webpage: 
```bash
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"}'
```
Check out the [overview](/api-reference/overview) for all available endpoints.

Response Format

All responses follow a consistent structure:

{
  "success": true,
  "data": {
    // Response data
  },
  "creditsCost": 1
}

For detailed information about endpoints, error handling, and rate limits, see the API overview.