Staan

Schemas


SearchWebResponseQuery

q
​string · required
market
​string · required
count
​number · required
offset
​number · required
altered_query
​string

SearchWebChunkScore

chunk
​string · required

Reranked text chunk.

score
​number · min: 0 · max: 1 · required

Relevance score between 0 and 1.

SearchWebResult

title
​string · required
url
​string · uri · required
snippet
​string · required

Original snippet from the search provider.

display_url
​string · required
hostname
​string · required
favicon_url
​string · uri
thumbnail
​string · uri
​SearchWebChunkScore[]

Present only when extra_snippets=true.

​object

Present only when full_content is set.

published_date
​string · date-time

Publication date (ISO 8601).

SearchWebResults

​SearchWebResult[] · required

SearchWebResponse

search_id
​string · required

Request / trace identifier.

​SearchWebResponseQuery · required
​SearchWebResults · required

SearchWebRequestBody

q
​string · required
market
​string · enum

Defaults to fr-FR.

Enum values:
fr-fr
de-de
en-us
en-gb
en-fr
en-ca
en-au
en-in
count
​number

Defaults to 10.

offset
​number

Defaults to 0.

extra_snippets
​boolean

Defaults to false.

full_content
​string · enum

If provided, fetches pages for each SERP result and returns the full page content on each link. markdown returns the extracted body as Markdown; html returns the raw page HTML. When combined with extra_snippets, results follow the reranked order.

Enum values:
markdown
html
max_snippets
​number

Maximum number of scored chunks retained per URL in the output. Defaults to 3.

min_score
​number

Minimum reranker score (0–1) for a chunk to be retained. Defaults to 0.10.

include_domains
​string[] · maxItems: 20

Restrict results to these domains or site sections (e.g. linkedin.com/in). POST only. Up to 20 entries. Mutually exclusive with exclude_domains. Equivalent to site: operators in q.

Example: ["lemonde.fr","lesechos.fr"]
exclude_domains
​string[] · maxItems: 20

Exclude these domains or site sections from results. POST only. Up to 20 entries. Equivalent to -site: operators in q.

Example: ["reddit.com"]