Skip to main content

Base URL

All API requests should be made to:
https://api.crawleo.dev/api/v1

Authentication

All endpoints require authentication using a Bearer token in the Authorization header:
Authorization: Bearer YOUR_API_KEY

Get Your API Key

Sign up and subscribe to get your API key.

Available Endpoints

Crawleo provides two main API endpoints:

Output Formats

Both APIs support multiple output formats optimized for different use cases:
FormatDescriptionBest For
Raw HTMLOriginal page sourceFull content preservation
AI-Enhanced HTMLClean HTML (no ads, scripts)Cleaner processing
Plain TextExtracted text contentSimple text processing
MarkdownStructured markdownRAG pipelines, LLMs
Use Markdown output for AI/LLM applications to minimize token usage.

Response Format

All responses are returned as JSON. Successful responses include the requested data, while errors return an error object:
{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message"
  }
}

HTTP Status Codes

CodeDescription
200Success
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing API key
403Forbidden - Insufficient permissions
429Too Many Requests - Rate limit exceeded
500Internal Server Error

Rate Limiting

API requests are rate-limited based on your subscription plan. Rate limit information is included in response headers:
  • X-RateLimit-Limit: Maximum requests per period
  • X-RateLimit-Remaining: Remaining requests in current period
  • X-RateLimit-Reset: Time when the rate limit resets

MCP Integration

For AI assistants and IDEs, Crawleo also provides a Model Context Protocol (MCP) endpoint:
https://api.crawleo.dev/mcp

MCP Integration

Learn how to connect AI assistants directly to Crawleo.