Skip to main content
POST
Harvest a page's images

Authorizations

X-API-Key
string
header
required

Headers

Idempotency-Key
string

Any unique string up to 255 visible characters. Send the same key when you retry a request: for 12 hours a repeat returns the first answer again, with an Idempotent-Replayed: true header, without doing the work or charging a second time. A repeat that arrives while the first is still running gets 409 IDEMPOTENCY_IN_PROGRESS; the same key with a different body gets 409 IDEMPOTENCY_KEY_REUSED.

Maximum string length: 255
Example:

"3f2b8c1e-retry-safe-key"

Body

application/json
url
string
required

The URL to harvest images from. Must be http(s).

Example:

"https://example.com"

maxAge
integer

Serve from cache if a capture of this URL is younger than this many milliseconds. Omit for the default window; 0 always fetches fresh. Capped at 7 days.

Required range: 0 <= x <= 604800000

Response

data
object
required