Search

Search site content

Returns semantically relevant pages and snippets for the selected Search widget.

post/api/v1/search/{searchWidgetId}/query

Request

  • Base URL: https://brew.marketbrew.ai/api/v1
  • URL: https://brew.marketbrew.ai/api/v1/api/v1/search/{searchWidgetId}/query
  • Auth: API key in header API-Key

Path parameters

searchWidgetIdinteger required

Query parameters

websiteHoststring

Headers

X-Search-Session-Tokenstring

Search Widget browser-session credential used for history ownership and session throttling.

Request body

querystring
inferLanguageboolean
localeobject
offsetinteger
limitinteger

Response

Search results with reference URLs and snippets

querystring
totalResultsinteger
metricsobject

Example response

{
  "results": [
    {
      "lastSuccessfulCrawlAt": "2022-03-10T12:15:50",
      "lastAttemptAt": "2022-03-10T12:15:50"
    }
  ]
}

Changes

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