Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer token used for request authentication. Alternatively, you can send the API key in the x-api-key header. Note: A payment method is required to use the API.

Body

application/json

Request body for the Image Search API.

inputs
object[]
required

Multimodal input array. Currently only a single input is supported: either one text input or one image input.

Required array length: 1 element
topic
enum<string>
default:general

Use general for general image search, or design for design reference.

Available options:
general,
design
count
integer
default:5

Number of results to return.

Required range: 1 <= x <= 10
include_domains
string[]

Domains to include, matched against each result's source_page URL.

exclude_domains
string[]

Domains to exclude, matched against each result's source_page URL.

safesearch
enum<string>
default:strict

Controls filtering of explicit/adult content. off disables filtering; strict drops all adult content.

Available options:
off,
strict
html_snippet
object

Only effective when topic=design; controls whether an html_snippet is returned for each result.

Response

Successful image search response

request_id
string

The unique identifier for this request.

data
object

The main response payload.

meta
object

Additional metadata for the Image Search request.