keyword_research

Call keyword_research.sweep

Kick off a new keyword sweep on a seed term — 'research keywords for coffee shops near me', 'look up search volume for this term'. Run a NEW keyword sweep on a seed term and file it on a board. This calls a paid provider and CHARGES the workspace credits, so check keyword_research.read first — a sweep we already ran costs nothing to re-read. When the member asked for it themselves it runs; otherwise they see an approve card first. Never say data came back until the tool has returned rows. Not for sweeps already run — that is keyword_research.read. Over the API it answers in two calls: without confirmation_id it proposes — says what would happen, returns a confirmation_id and changes, spends and sends nothing; the same arguments again with that confirmation_id, on a member's own API key, do it.

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/keyword_research.sweep

Request

  • Base URL: https://app.goosybear.ai
  • URL: https://app.goosybear.ai/api/v1/tools/keyword_research.sweep
  • 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.

Request body

querystring required

The seed term to sweep, in the operator's own words.

limitinteger

How many keyword rows to ask for. 1-50; defaults to 10.

board_idstring uuid

The board to file the sweep on, by id. Omit on a board conversation — the board you are standing on is used.

board_namestring

The board to file the sweep on, by NAME — use this off a board when the operator names one (e.g. 'Launch ideas'). If neither this nor board_id is given and you are not on a board, the tool answers with the boards to choose from.

confirmation_idstring uuid

Omit to propose: the first call says what would happen, returns a confirmation_id and changes nothing. To go ahead, send the same arguments again with that confirmation_id, on a member's own API key; a service account's key can propose but never confirm.

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 8 revisions of this API.