COcontext
Web Scraping

Scrape Images

Changed on

Extract image assets from a web page, including standard URLs, inline SVGs, data URIs, responsive image sources, metadata, CSS backgrounds, video posters, and embeds. The base request costs 1 credit, or 2 credits with browser actions. When enrichment is enabled, the entire call costs 5 credits, including requests that also use actions.

get/web/scrape/images

Request

  • Base URL
    https://api.context.dev/v1
  • URL
    https://api.context.dev/v1/web/scrape/images
  • Auth
    HTTP bearer

Query parameters

urlstring uri required

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

maxAgeMsinteger nullable

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

resolutionboolean

Measure image width and height when possible.

hostedUrlboolean

Host materializable images on the Brand.dev CDN and return their URL and MIME type.

classificationboolean

Classify each image by visual asset type.

maxTimePerMsinteger

Per-image enrichment timeout in milliseconds. Default: 30000. Maximum: 60000.

dedupeboolean

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.

waitForMsinteger nullable

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

headersobject

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.

timeoutMSinteger

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).

tagsstring[]

Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

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.

[
  "production",
  "team-alpha"
]

Response

Successful response

successtrue required

Always true on success.

urlstring required

Page URL that was scraped.

Changes