Skip to main content
GET
JavaScript
1 Credit With actions: 2 Credits Enriched: 5 Credits

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

url
string<uri>
required

Page URL to inspect. Must include http:// or https://.

Minimum string length: 1
maxAgeMs
integer | null
default:86400000

Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1 day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days).

Required range: 0 <= x <= 2592000000
enrichment
object | null

Optional per-image processing, sent as deep-object query params such as enrichment[resolution]=true.

dedupe
default:false

When true, visually duplicate images are removed: every image is loaded and perceptually hashed, and only the highest-resolution copy of each duplicate group is kept. Images that cannot be downloaded or hashed are kept. Default: false.

waitForMs
integer | null

Optional browser wait time in milliseconds after initial page load before collecting images. Min: 0. Max: 30000 (30 seconds).

Required range: 0 <= x <= 30000
actions
(Wait · object | Perform · object)[] | null

Optional browser actions executed in array order after the page loads and before content is captured. Requires a paid plan. Send a JSON array in the query parameter. Maximum: 5 actions.

Maximum array length: 5

Browser action discriminated by do. Each variant exposes only its applicable fields.

headers
object

Optional outbound HTTP headers forwarded only to the target URL, sent as deep-object query params such as headers[X-Custom]=value. When provided, caching is bypassed: the result is neither read from nor written to cache.

timeoutMS
integer

Optional timeout in milliseconds for the request. If the request takes longer than this value, it will be aborted with a 408 status code. Maximum allowed value is 300000ms (5 minutes).

Required range: 1 <= x <= 300000
tags
string[]

Optional comma-separated caller-defined tags for tracking this request. Tags are recorded on the request's usage log and can be used to filter usage on the dashboard usage page. Up to 20 tags, each 1-50 characters. Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

Maximum array length: 20
Required string length: 1 - 50
Example:

Response

Successful response

success
enum<boolean>
required

Always true on success.

Available options:
true
images
object[]
required

Images found on the page.

url
string
required

Page URL that was scraped.

key_metadata
object

Metadata about the API key used for the request. Included in every response whenever a valid API key is provided, even when the response status is not 200.