Base URL
All API requests should be made to:Authentication
All endpoints require authentication using a Bearer token in theAuthorization header:
Get Your API Key
Sign up and subscribe to get your API key.
Available Endpoints
Crawleo provides two main API endpoints:Search API
GET /searchReal-time web search with optional automatic crawling of results.
Crawler API
GET /crawlerDirect URL crawling with JavaScript rendering support.
Output Formats
Both APIs support multiple output formats optimized for different use cases:| Format | Description | Best For |
|---|---|---|
| Raw HTML | Original page source | Full content preservation |
| AI-Enhanced HTML | Clean HTML (no ads, scripts) | Cleaner processing |
| Plain Text | Extracted text content | Simple text processing |
| Markdown | Structured markdown | RAG pipelines, LLMs |
Response Format
All responses are returned as JSON. Successful responses include the requested data, while errors return an error object:HTTP Status Codes
| Code | Description |
|---|---|
200 | Success |
400 | Bad Request - Invalid parameters |
401 | Unauthorized - Invalid or missing API key |
403 | Forbidden - Insufficient permissions |
429 | Too Many Requests - Rate limit exceeded |
500 | Internal 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 periodX-RateLimit-Remaining: Remaining requests in current periodX-RateLimit-Reset: Time when the rate limit resets
MCP Integration
For AI assistants and IDEs, Crawleo also provides a Model Context Protocol (MCP) endpoint:MCP Integration
Learn how to connect AI assistants directly to Crawleo.
