Saltar al contenido principal
POST

Autorizaciones

Authorization
string
header
requerido

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

Cuerpo

application/json
query
string
requerido

The search, up to 400 characters. Supports the operators site:example.com, -site:example.com, after:YYYY-MM-DD and before:YYYY-MM-DD; the date operators keep results to pages published between those days.

Required string length: 1 - 400
type
enum<string>
predeterminado:standard

standard answers in about two seconds. pro is a deeper search for questions that need several sources and answers in about four seconds. A standard search is 0.5 credits and a pro search 2.

Opciones disponibles:
standard,
pro
numResults
integer
predeterminado:5

How many results to return.

Rango requerido: 1 <= x <= 10
contents
object

What each result carries of its page. Every result carries text; set text.maxCharacters to change how much.

userLocation
string

The market the results are for, a two-letter country code. Leave it out unless the results must be one country's: a search without it answers fastest, in the query's language.

Pattern: ^[A-Za-z]{2}$
includeDomains
string[]

Host names. Only results on these sites, subdomains included, are returned.

Maximum array length: 20
excludeDomains
string[]

Host names. Results on these sites are left out.

Maximum array length: 20
idempotencyKey
string

Optional. Deduplicates submissions for at least 30 days after the request; a duplicate is a 409.

priority
integer
predeterminado:1

Optional. Echoed in task metadata; values outside 1-10 are clamped.

Rango requerido: 1 <= x <= 10
webhook
object

Optional. Without it, collect the result by polling.

Respuesta

The search's task with its results in response, or with error when the search failed.

success
boolean
requerido
task
object
requerido
credits
object
requerido

Credits, with up to two decimals (for example 1.25). The submit response always shows 0: nothing is charged yet, and the task's price is held from your balance when it starts. Polling shows 0 until the task is terminal, then the settled charge: the task's price for COMPLETED, 0 for FAILED. A task webhook reports the same charge in creditsCharged; on a FAILED task it reports the task's price in creditsToCharge and 0 in creditsCharged. CITATION_ANALYSIS, GOOGLE_PLACES and GOOGLE_NEWS are charged by usage, up to the hold placed when the task starts.

response
object

The engine-specific result. Absent until the task is terminal. See the Engines guide for per-engine shapes. NAVER_AI_TAB preserves the original text, markdown, sources and cards when Naver returns HTTP success, a valid stream ending in done, and nonempty answer text with unknown_error. It includes upstreamError and returns immediately without retrying or rephrasing, even with retryQuery. COMPLETED means collection finished; the answer may still be incomplete. Empty, cut-off or malformed streams still fail. Policy refusals complete with a policy_declined notice. rawContent is returned only with include.rawResponse. With include.citationAnalysis, answer results also carry citationAnalysis (see Include). CITATION_ANALYSIS returns CitationAnalysisResult; see the Citation Analysis guide. PROMPT_RESEARCH returns PromptResearchResult; see the Prompt Research guide. GEO_SCORE returns GeoScoreResult; see the GEO Score guide. Answer engines with include.analysis add analysis (AnswerAnalysis).

error
string

Present when task.status is FAILED. A plain string, not the {code, message, timestamp} object used by request-level errors.