public

Execute Web Search

Changed on

Perform a web search and immediately fetch content for the returned URLs.

Use this when you want both snippets and page contents from one call.

If you want to selectively fetch content (i.e. let the LLM decide which URLs to read), use /search-lite and then call /open-urls separately.

post/web-search/search

Request

  • Base URL
    https://cloud.onyx.app/api
  • URL
    https://cloud.onyx.app/api/web-search/search
  • Auth
    HTTP bearer

Request body

queriesstring[] required

List of search queries to send to the configured provider.

max_resultsinteger nullable

Optional cap on number of results to return per query. Defaults to 10.

Response

Successful Response

search_provider_type'google_pse' | 'serper' | 'exa' | 'searxng' required
content_provider_type'onyx_web_crawler' | 'firecrawl' | 'exa'

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • warning

      added the new exa enum value to the / response property for the response status