Skip to content

Extract Images From Website

POST
/image-library/extract

Pull every image off one page into the library. FREE - no model runs.

It fetches the URL server-side, so the page must be publicly reachable. min_width / min_height are what keep the icons and tracking pixels out; lowering them floods the library rather than enriching it.

Asynchronous - it returns once the extraction is dispatched.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Pull images out of a website. Fetches the site; spends no credit.

object
min_height
integer
default: 200
min_width
integer
default: 200
url
required
string

Responses

202

Successful Response

object
data
required

One Studio object, open-shaped. See the module docstring.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string