web

Call web.search

Run a bounded managed web search for the credential-bound workload — 'search for local coffee roasters', 'find recent news on this topic'. Not for reading one page you already have the address of — that is web.api_read.

Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with workspace_ambiguous and lists the choices — offer them, never pick one.

post/api/v1/tools/web.search

Request

  • Base URL: https://app.goosybear.ai
  • URL: https://app.goosybear.ai/api/v1/tools/web.search
  • Auth: HTTP bearer

Headers

x-request-idstring

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Idempotency-Keystring

Your key for this write: send the same key when you retry and the first result comes back instead of a second action. Keys are honoured for at least 24 hours. 1–200 visible ASCII characters. Replaces the idempotency_key body field, which still works until 2026-12-31.

Request body

querystring

The web search query.

mode'answer' | 'semantic' | 'serp'

Use answer for synthesis, semantic for relevance, or serp for ranked web results.

maxResultsinteger

The maximum number of search results to return.

freshnessDaysinteger

Optional maximum age in days for search results when supported.

includeDomainsstring[]

Optional domains to include in the search.

excludeDomainsstring[]

Optional domains to exclude from the search.

confirmation_idstring uuid

Confirms the stored exact call. When supplied, the stored request replaces all other body fields.

idempotency_keystring

Deprecated on REST: send the Idempotency-Key header instead. Still accepted until 2026-12-31; if both are sent they must match.

workspacestring

Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

Response

The call was admitted and dispatched. ok says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

OR

Changes

No recorded changes to this operation across all 4 revisions of this API.