Page scans

Scan a page

Opens the page in a browser on Iminify's servers, waits for it to load, scrolls to the bottom and collects every image it loaded, then compresses each one with the settings you send. It answers straight away with the status queued; a scan takes from a few seconds to a few minutes. Each scan counts one against your daily scans and your page scans a minute, and the images it finds don't count against your daily images. A scan stops at your plan's images per scan, skips SVG and AVIF files and anything over your plan's file size, and compresses an image that appears twice once.

The address can leave out https://. A page on a private network is refused. A page behind a login, or one that blocks automated browsers, usually comes back with no images, because the scanner sees what a signed-out visitor would.

post/scans

Request

  • Base URL: https://www.iminify.com/api/v1
  • URL: https://www.iminify.com/api/v1/scans
  • Auth: HTTP bearer

Request body

urlstring uri required

The page to scan. https:// can be left out.

level'none' | 'lossless' | 'ultra' | 'smart'
format'auto' | 'webp' | 'avif' | 'png' | 'jpg'
keep_metadataboolean

Keep the EXIF metadata (camera, date, location) in the optimized copy. Off by default, which strips it; the orientation is applied to the pixels first, so a photo never comes back on its side.

widthinteger nullable

Resize to this width in pixels. Alone, the height follows the aspect ratio. With height too, the image is resized to exactly that size, and its proportions change if they differ. Up to 65535.

heightinteger nullable

Resize to this height in pixels, the same way as width. Up to 65535.

scaleinteger nullable

Resize to this percentage of the original, 1 to 100. Cannot be combined with width or height.

alt_textboolean

Write an AI alt text for each image the page shows with no alt attribute at all, from its compressed copy, for the report's suggested_alt. On by default; send false to leave it out. Images marked decorative (alt="") or that already have alt text get none. Each one counts against your daily AI alt texts. See Alt text and file names.

alt_text_language'en' | 'es' | 'fr' | 'de' | 'it' | 'pt' | 'nl' | 'pl' | 'sv' | 'tr' | 'ru' | 'uk' | 'ar' | 'fa' | 'he' | 'hi' | 'id' | 'vi' | 'th' | 'ja' | 'ko' | 'zh-Hans' | 'zh-Hant'

The language to write the alt text in, as one of these tags: en (English), es (Spanish), fr (French), de (German), it (Italian), pt (Portuguese), nl (Dutch), pl (Polish), sv (Swedish), tr (Turkish), ru (Russian), uk (Ukrainian), ar (Arabic), fa (Persian), he (Hebrew), hi (Hindi), id (Indonesian), vi (Vietnamese), th (Thai), ja (Japanese), ko (Korean), zh-Hans (Simplified Chinese), zh-Hant (Traditional Chinese). The suggested file name follows it when the language is written in the Latin alphabet, and is in English otherwise.

Response

Queued. Location points at the new record.

Changes

No recorded changes to this operation across all 1 revision of this API.