Settings
API Keys
Manage API keys for the public API. Use these keys with the X-API-Key header.
Loading keys...
API Usage
Base URL: /api/v1
Auth Header: X-API-Key: your-key-here
POST /api/v1/crawl/start — Start a new crawl
GET /api/v1/crawl/:id — Get crawl results
GET /api/v1/crawl/list — List your crawls
GET /api/v1/health — Health check
API Documentation
All /api/v1/* endpoints require the X-API-Key header (except health check).
Authentication
Include your API key in the request header:
X-API-Key: your-api-key-hereError Responses
All errors follow this format:
// 401 - Missing or invalid API key
{ "statusCode": 401, "message": "Missing X-API-Key header" }
{ "statusCode": 401, "message": "Invalid API key" }
// 400 - Bad request
{ "statusCode": 400, "message": "URL is required" }
// 404 - Not found
{ "statusCode": 404, "message": "Crawl not found" }