Skip to content

Overview

Extract structured data from webpages with custom parsers or prebuilt APIs, then run work synchronously, in batches, on schedules, or as workflows.

Authentication

API endpoints accept an API key in the X-API-Key header (recommended) or the api_key query parameter. The public API catalog does not require authentication. MCP at POST /mcp also accepts Authorization: Bearer <api-key> and may support Clerk OAuth; /v1/* remains API-key only.

Credits and limits

Credit cost depends on the operation and scrape configuration. Scrape and prebuilt responses expose X-Credits-Used and X-Credits-Remaining. Use GET /v1/status for credits, reservations, class-specific concurrency, pending jobs, and active batches.

Errors and ownership

New endpoints return JSON error envelopes with error and optional field, detail, and hint. Resources not owned by the caller return 404, not 403. Validation failures return 422.

Recommended API-key transport.

Security scheme type: apiKey

Header parameter name: X-API-Key

API key in the query string. Prefer the header so keys are not written to URLs and logs.

Security scheme type: apiKey

Query parameter name: api_key