---
title: "Call browser.read"
method: POST
path: "/api/v1/tools/browser.read"
tags: ["browser"]
---

# Call browser.read

`POST /api/v1/tools/browser.read`

## Request

- Base URL: `https://app.goosybear.ai`
- URL: `https://app.goosybear.ai/api/v1/tools/browser.read`
- Auth: HTTP bearer

Drive a real browser to a page on a site this workspace has APPROVED for browsing and pull named fields off it — 'use the browser to pull the prices off our supplier's page', 'open our approved site in the browser and read the plan table'. Open a web page this workspace has approved for browsing and READ it — pull named fields off it, or answer a question about what is on it. This one is for the approved sites that need a real browser. It only reaches sites the workspace has added on Settings → Assistant → Browser; anything else is refused with the domain to add. It reads and never types, clicks through a form, signs in, or changes anything on the page. Not for an ordinary link someone pastes, or any site to just read — that is `web.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.

## Headers

- `x-request-id` string

## Request body

- object
  - `url` string, required: The page to open, as a full https:// address. It must be on a site the workspace has approved for browsing; anything else is refused with the site to add.
  - `task` string, required: What to do on the page, in plain words — for example 'read the pricing table' or 'does this page still say the plan includes support?'.
  - `extract` object[]: The named fields to pull off the page. Omit for a plain look, which returns the page's own answer to the task instead of a structured object.
    - `name` string, required: The key this field lands under in the result.
    - `description` string, required: What to look for on the page.
    - `type` 'string' | 'number' | 'boolean': The shape to coerce it to. Defaults to string.
  - `max_minutes` integer: Wall-clock ceiling for this one read, 1-5. Defaults to 2. The account's own limits still apply and are lower in some cases.
  - `resume_read_id` string: Only when an earlier call said the browser is still reading this page: the read id it gave, with the same url, task and extract, to collect that read rather than start another. Omit it otherwise.
  - `confirmation_id` string, 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.
  - `workspace` string: 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 `200`

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.

- union
  - object: The tool ran and answered.
    - `ok` true, required
    - `state` 'confirmation_required'
    - `confirmation_id` string, uuid
    - `expires_in_seconds` integer
    - `request_summary` string: What will happen, in one sentence, for a person to approve before confirming.
    - `run_id` string
    - `adapter` string
    - `hosts_touched` string[]
    - `extracted` unknown
    - `summary` string, nullable
    - `screenshot_ids` string[]
    - `action_count` number
    - `workspace` string, required: The slug of the workspace this call ran in.
    - `working_in` object, required: Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.
      - `label` string, required: The chip words — e.g. "working in: Acme Main".
      - `note` string, required: Why this workspace — e.g. "your default", "this call only".
      - `workspace` string, required: The resolved workspace's slug.
      - `source` 'call-override' | 'key-pin' | 'stored-default' | 'sole-reachable', required: Which rung of the R7 precedence resolved the workspace.
  - ToolRefusal: A call that was admitted and dispatched, and did not succeed.
    - `ok` false, required
    - `code` string, required: The typed reason — e.g. `workspace_ambiguous`, `invalid_arguments`, or the tool's own failure code.
    - `message` string, required: A sentence a person can act on.
    - `workspaces` string[]: On a workspace refusal: the slugs this key may pass as `workspace`.
    - `issues` object[]: On `invalid_arguments`: which fields failed, and why.
      - `path` string, required
      - `message` string, required
    - `path` string: On an authoring refusal: where in your call's input it points, e.g. `steps.<key>.params.<field>`.
    - `fix` string: On an authoring refusal: the change to your call that would pass.
    - `instruction` string: On an authoring refusal: what to do next with it.

## Other responses

- `400`: The request could not be used: the body is present but not a JSON object (`tenant_api.malformed_body`); it is a top-level array carrying more messages than this endpoint accepts (`tenant_mcp.batch_too_large`); or the `Idempotency-Key` header is malformed (`tenant_api.idempotency_key_invalid`), disagrees with the body's `idempotency_key` (`tenant_api.idempotency_key_conflict`), or was sent to an action that cannot replay a retry (`tenant_api.idempotency_unsupported`). Nothing ran.
- `401`: No bearer credential, or one that did not resolve. Deliberately ONE undifferentiated answer for absent / unknown / revoked / expired, so the endpoint is never an oracle over the key space.
- `403`: The credential is good but the surface is not open to it — the platform or account API switch is off, or the holder lacks the `api.access` capability. The `code` says which.
- `404`: No such tool. The body names no tool and is identical for every unrecognised name.
- `429`: Over this key's per-minute cap. Carries `Retry-After` and `error.retry_after_seconds`.

---

[API](https://skmtc.dev/goosybear/apis/goosy-bear-api.md) · [All operations](https://skmtc.dev/goosybear/apis/goosy-bear-api/llms.txt) · [OpenAPI document](https://skmtc.dev/goosybear/apis/goosy-bear-api/revisions/f9b4aeb83edc?raw)