Skip to main content
POST
image.search

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
query
string
required

The images you want, in a few words or a short description.

country
string

Two-letter country code like US, to favour images from that region.

Required string length: 2
Pattern: ^[A-Z]{2}$
quality
enum<string>
default:fast

"fast" is cheaper and returns in about a second; "high" takes longer and finds better-matching images for about five times the price. Default "fast".

Available options:
fast,
high
limit
number

How many images to return, 1 to 20. Default 10.

Required range: x >= 1

Response

The result

results
object[]
required

Matching images, best first.