Skip to main content
POST
creators.search-image

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
platform
enum<string>
required

Social platform.

Available options:
instagram,
tiktok,
youtube,
x,
twitch,
snapchat
fileId
string
required

Id of an uploaded file holding a JPEG or PNG image up to 5 MB, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
limit
number

Maximum returned creators, up to 50.

Required range: x >= 1
page
integer
default:0

Zero-based result page.

Required range: 0 <= x <= 499
filters
object

Structured filters. Unsupported combinations are declined before a paid request.

ref
string

One source-bound nonstandard filter handle, if needed.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

results
object[]
required

The matching items.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.