Skip to main content

HTTP Status Codes

The ProWebLook API uses conventional HTTP response codes to indicate the success or failure of a request.

Error Response Format

All errors return a JSON body with an error key:
Some errors include additional context fields:

Common Errors

Cause: The api_key parameter is missing or does not match any registered user account.Resolution: Double-check your API key from the ProWebLook dashboard and ensure it is passed correctly as a query parameter or body field.
Cause: Your credit balance for the requested service has been depleted.Resolution: Top up your credits from the ProWebLook dashboard. Use the Balance API to check your current balance before bulk operations.
Cause: A required parameter is missing from the request.Resolution: Check the endpoint documentation and ensure all required fields are present.
Cause: More than 1,000 phone numbers were submitted in a single batch request.Resolution: Split your list into batches of 1,000 or fewer.
Cause: The batch_id does not exist or does not belong to the provided API key.Resolution: Ensure you are polling with the same api_key that submitted the batch, and that the batch_id is correct.
Cause: One or more values in the formats array are not supported by the Scraping API.Resolution: Use only valid formats: markdown, html, rawHtml, links, metadata, screenshot.
Cause: The url field is missing or is not a valid http/https URL.Resolution: Ensure your url starts with http:// or https:// and is a well-formed URL.
Cause: The upstream scraping service returned an error (e.g., the target site is unreachable or timed out).Resolution: Retry the request once. If it persists, check that the target URL is reachable, or increase the timeout value.