AGagentkey
web

Web or news search across several engines. Returns a normalized result page.

Keyword search over the web (type=web) or news (type=news). Results are normalized to WebResult; the server picks the engine and fails over. include_domains / exclude_domains route to an engine that supports them.

Fixed price: 0.2 credits per successful call, whichever provider serves it.

post/v2/ops/web.search

Request

  • Base URL
    https://api.agentkey.app
  • URL
    https://api.agentkey.app/v2/ops/web.search
  • Auth
    HTTP bearer

Request body

countrystring

ISO 3166-1 alpha-2 country code to bias results, e.g. US, CN.

cursorstring

Opaque pagination cursor from the previous response's next_cursor. Send the same query parameters with it.

exclude_domainsstring[]

Exclude results from these domains (routes to an engine that supports it).

fieldsstring[]

Projection: keep only these dotted paths of data, e.g. ["items.id", "items.text"].

include_domainsstring[]

Restrict results to these domains (routes to an engine that supports it).

include_rawboolean

Attach the raw upstream payload as raw (not a stable contract; truncated above 256 KB).

langstring

BCP 47 language tag for the results language, e.g. en, zh-Hans.

limitinteger

Maximum number of results to return.

providerstring

Shorthand for routing.only = [provider].

querystring required

Search query.

time_range'day' | 'week' | 'month' | 'year' | 'all'

Only results published within this window.

type'web' | 'news'

Result type. images and videos are planned as non-breaking additions.

Response

Success envelope

credits_chargednumber required

Credits charged for this call (the method's fixed price).

opstring required

Method name.

op_versioninteger required

Method version that served the call.

providerstring required

Provider that actually served the call.

rawunknown
raw_truncatedboolean
request_idstring required

Correlation id; quote it in support requests.

took_msinteger required
unsupported_fieldsstring[] required

Output paths this provider structurally does not supply; such fields are null for a different reason than 'missing on this record'.

Changes

No recorded changes to this operation across all 1 revision of this API.