Getting started

Errors

Successful requests return the endpoint's JSON. Anything else returns an object with an error field.

Error shape

Account and limit errors use an HTTP error status and this shape:

401 Unauthorized

{
  "success": false,
  "error": "Invalid API Key"
}

Extraction errors — the page couldn't be loaded or processed — return an error field. Always check for it before reading the result:

Extraction error

{
  "error": "REQUEST_TIMEOUT"
}

Status	error	What to do
400	`Invalid URL`	Send a full, URL-encoded URL with `https://`.
401	`Missing API Key.` / `Invalid API Key`	Check the key in your dashboard.
401	`Please verify your account`	Confirm your email address.
401	`Your subscription is not active…`	Renew or change your plan.
429	`Too many request`	Rate limit reached. Retry later — see Rate limits.
429	`Credits quota exceeded`	Out of credits — see Credits.

These are never billed.

error	Meaning
`DOMAIN_NOT_FOUND`	The domain doesn't exist (no DNS record) — check the URL for typos. All endpoints.
`REQUEST_TIMEOUT`	The site didn't respond in time, or is down. Metadata and Markdown.
`We cannot read this link`	Metadata and Markdown: the site blocks automated access (bot protection) on every method we tried.
`UNABLE_TO_LOAD_PAGE`	The site is down, doesn't exist or blocks automated requests (Links, Images, Screenshot).
`NOT_A_WEB_PAGE`	The URL points to a file — video, image, PDF or anything over 5 MB — not a web page (Markdown). Extract returns the file name and type instead.
`SELECTOR_NOT_FOUND`	The `selector` or `wait_for_selector` of a screenshot doesn't match any element (HTTP 200 with the error, not billed).
`REQUEST_FAILED`	The extraction failed for another reason.
`Unable to extract main content`	Markdown: the page has no readable main content.

Treat any response with an error field as a failure, whatever the HTTP status.
Retry REQUEST_TIMEOUT and UNABLE_TO_LOAD_PAGE once or twice — some sites are slow or block intermittently.
On 429, read error to tell a rate limit from an empty credit balance.