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

# Call seo.onpage_audit

`POST /api/v1/tools/seo.onpage_audit`

## Request

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

Audit one live page for SEO issues — 'audit our pricing page', 'what's wrong with this page's SEO'. Audit ONE live page: its title and description with their lengths, every H1, the canonical, whether it is served over HTTPS, whether it carries structured data and whether that data has errors, word count, internal and external link counts, load time, page size, and a list of what is wrong — critical issues first, then warnings. This calls a paid provider and CHARGES the workspace credits per page, so audit the page the operator named rather than crawling around it. `url` in the result is the page ACTUALLY audited and may differ from the one asked for when it redirected — if it does, say so. An empty `issues` list means the checks that were run all passed, not that the page is perfect. Not for the site's link authority — that is `seo.backlinks_summary`. 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 full page address to audit, including https://. One page per call.
  - `render_javascript` boolean: Whether to run the page's JavaScript before auditing. Leave it out — the default is on, which is right for almost every modern page. Pass false only when the operator specifically wants the raw HTML measured.
  - `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.
    - `url` string
    - `fetched_at` string
    - `status_code` number, nullable
    - `onpage_score` number, nullable
    - `title` string, nullable
    - `title_length` number, nullable
    - `description` string, nullable
    - `description_length` number, nullable
    - `h1` string[]
    - `canonical` string, nullable
    - `is_https` boolean, nullable
    - `has_structured_data` boolean, nullable
    - `structured_data_has_errors` boolean, nullable
    - `word_count` number, nullable
    - `internal_links_count` number, nullable
    - `external_links_count` number, nullable
    - `images_count` number, nullable
    - `load_time_ms` number, nullable
    - `time_to_interactive_ms` number, nullable
    - `page_size_bytes` number, nullable
    - `has_broken_resources` boolean, nullable
    - `has_broken_links` boolean, nullable
    - `issues` object[]
      - `check` string, required
      - `severity` 'critical' | 'warning', required
    - `credits_consumed_thousandths` integer
    - `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/bd8f793b36b5?raw)