Saltar para o conteúdo principal
POST
Look up a product on AI shopping engines

Autorizações

Authorization
string
header
obrigatório

Your API key, sent as Authorization: Bearer <key>.

Corpo

application/json
product
string
obrigatório

The product's name, such as belif Moisturizing Eye Bomb. A product page URL or a GTIN is a 400 VALIDATION_ERROR.

Required string length: 1 - 200
country
enum<string>
obrigatório

Market: US (United States) or KR (South Korea), case-insensitive. Any other value is a 422 REGION_UNSUPPORTED.

Opções disponíveis:
US,
KR
competitors
string[]

Other products' names, asked what the product is asked. A name that is the product's or is listed twice is a 400; names that differ only in case, punctuation or spacing are the same name.

Maximum array length: 5
Required string length: 1 - 200
prompts
string[]

Shopper prompts, such as best moisturizing eye cream. Each is asked of each engine once, as written.

Maximum array length: 3
Required string length: 1 - 300
engines
enum<string>[]

The engines to ask, case-insensitive. Default for US: CHATGPT, GOOGLE, AIMODE and BING_COPILOT. Default for KR: NAVER_AI_TAB, CHATGPT and AIMODE. NAVER_AI_TAB in a US lookup is a 400.

Required array length: 1 - 6 elements

An engine a product lookup can ask. GOOGLE is Google AI Overviews and AIMODE is Google AI Mode. NAVER_AI_TAB answers in KR only.

Opções disponíveis:
CHATGPT,
GOOGLE,
AIMODE,
GEMINI,
BING_COPILOT,
NAVER_AI_TAB
idempotencyKey
string

Names the lookup; without it the server picks a UUID. Sending the lookup again under the same key admits only the asks that are missing.

Required string length: 1 - 200
priority
integer
padrão:1

Set on every ask. Values outside 1-10 are clamped. It does not guarantee execution order.

Intervalo necessário: 1 <= x <= 10
webhook
object

Optional. Each ask's task is posted here when it reaches a terminal state.

Resposta

Asks processed. Each entry of asks[] holds its task, or the error that refused it.

success
boolean
lookup
object
summary
object
credits
object

creditsToCharge adds up the prices of the asks in asks[], held from your balance until each ask finishes. creditsCharged is what those asks have been charged already: 0 on a first submit, and on a resend the charges of the asks that had finished.

asks
object[]