API reference
API reference
All endpoints live under http://localhost:4000 and authenticate with the x-api-key header.
Base URL & authentication
curl "http://localhost:4000/v1/usage" -H "x-api-key: YOUR_API_KEY"| Endpoint | Description | Credits |
|---|---|---|
| Capture (Screenshot)GET /v1/capture | Capture any webpage as PNG, JPEG, WebP or PDF — full page, element, or 18 real devices. | 1 |
| ContentGET /v1/content | Extract metadata, links, HTML, Markdown and sitemap from any rendered webpage. | 1 |
| Analyze (AI)GET /v1/analyze | AI insights: summary, value proposition, features, categories, use cases, audience and contact signals. | 1 |
| Website CrawlerGET /v1/website/crawler | Fetch raw HTML (request mode, no rendering) with status, headers and redirect chain. | 1 |
| JobsGET /v1/jobs/{id} | Poll status, progress (0–100) and result of an async job. Free. | 0 |
| UsageGET /v1/usage | Remaining subscription quota, packs, credits, rate limits and key details. Free. | 0 |
| StatsGET /v1/stats | Platform infrastructure health for an engine or path over the last hour. Free. | 0 |
Billable endpoints also accept the global parameters soft_fail, is_async, fields, webhook_url. See status codes for errors.