pageaudit

Read up to 50 sites owned by the signed-in account. Follow next_cursor.

{
  "type": "object",
  "properties": {
    "cursor": {
      "type": "string",
      "description": "next_cursor from the preceding page."
    },
    "host": {
      "type": "string",
      "description": "Exact lowercase domain without www. Returns at most one owned site, Search Console, Analytics and site-package state in the same response. Does not create a site."
    }
  }
}

Add a site to the account. No site count limit. This creates no subscription or payment. An account holds up to 1,000 sites (409 site_limit). Adding a site creates no subscription or payment. The existing guest audit workspace stays separate.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "Public HTTP(S) URL, without credentials."
    }
  },
  "required": [
    "url"
  ]
}

Read one site owned by the signed-in account.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Site ID from list_sites or add_site."
    }
  },
  "required": [
    "id"
  ]
}

Read own-site keywords, opportunities at average positions 4–20, up to 20 tracked queries and daily history. Check dates, partial coverage and collection failure before proposing edits. These are not market search volumes. The sample covers 28 days, at most 50 queries and 50 pages. Use queries for keyword research and opportunities for average positions 4–20. The terms array adds daily history and 7-day comparisons for up to 20 selected queries. Coverage is partial: impressions are for this property, not market search volume. Positions are impression-weighted averages, not fixed SERP ranks. Credentials and raw provider responses are not returned.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Site ID from list_sites or add_site."
    }
  },
  "required": [
    "id"
  ]
}

Replace the site's tracked query selection (up to 20). Read search_console first to preserve existing selections. Removed queries keep their stored history. E-mail alerts require an active site package. Accepts up to 20 exact queries. Removed queries become inactive; their stored history is retained. Saving schedules the Search Console connection for collection. E-mail delivery requires an active site package.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Site ID from list_sites or add_site."
    },
    "terms": {
      "type": "array",
      "maxItems": 20,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 300
      },
      "description": "Unique exact queries, each 1–300 characters."
    }
  },
  "required": [
    "id",
    "terms"
  ]
}

Start read-only Google consent. The account owner must follow redirect in their browser. Follow redirect in the account's browser. Consent expires after five minutes. The callback is single-use and bound to the account and site. The property must match the site and Google must authorize it before the connection is saved.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Site ID from list_sites or add_site."
    },
    "property": {
      "type": "string",
      "description": "Exact Search Console domain or URL-prefix property."
    },
    "language": {
      "type": "string",
      "enum": [
        "en",
        "pt"
      ],
      "description": "en (default) or pt. Browser consent returns in this language."
    }
  },
  "required": [
    "id",
    "property"
  ]
}

Collect a due sample. Repeated calls cannot bypass the daily reservation. The hourly schedule uses the same durable reservation. A failure preserves the last good sample and schedules the next attempt 24 hours later. This route cannot force an extra collection.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Site ID from list_sites or add_site."
    }
  },
  "required": [
    "id"
  ]
}

Remove the local Google credential and stop collection. Keep the last good sample. The last good sample stays available. An in-flight callback or collection cannot reconnect the site.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Site ID from list_sites or add_site."
    }
  },
  "required": [
    "id"
  ]
}

Read remaining prompt units before generating. This does not use credit.

{
  "type": "object",
  "properties": {
    "guest_token": {
      "type": "string"
    }
  }
}

Prepare a coding-agent prompt from an owned report. One check uses one unit; full uses three. Three units are free once. Then US$0.10 per unit, or included in an active PageAudit plan. Read prompt_allowance first. Only send credit_token after explicit spending authorization; preserve request_id for retries. Three lifetime free units per account or anonymous network. A check uses one; full uses three. Extra units cost US$0.10 each. Active Starter, Pro and Agency plans include prompts while valid, within 60 requests/hour. No partial free debit: a full prompt needs three free units or is charged in full. The licensed prompt is saved for this owner and organization. Reopening the same selector is free even after plan expiry. Preserve its text and license; use it only for license.domain. Reuse the UUID v4 request_id and identical body after a delivery failure. Payment uses X-Credito or the x402 challenge. Never charge without the user's authorization.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Owned saved audit ID."
    },
    "guest_token": {
      "type": "string"
    },
    "scope": {
      "type": "string",
      "enum": [
        "check",
        "full"
      ],
      "description": "check or full."
    },
    "check_id": {
      "type": "string",
      "description": "ID from the report's checks; required for check, absent for full."
    },
    "language": {
      "type": "string",
      "enum": [
        "en",
        "pt"
      ],
      "description": "Language of the prompt instructions and check names: en for English, pt for Portuguese."
    },
    "request_id": {
      "type": "string",
      "format": "uuid",
      "description": "New UUID v4 per generation. Keep it unchanged for retries."
    },
    "credit_token": {
      "type": "string",
      "description": "Prepaid cred_… token. Requires explicit user authorization."
    }
  },
  "required": [
    "id",
    "scope",
    "language",
    "request_id"
  ]
}

Generate a fix prompt from saved domain observations. Prepare a coding-agent prompt from an owned report. One check uses one unit; full uses three. Three units are free once. Then US$0.10 per unit, or included in an active PageAudit plan. Read prompt_allowance first. Only send credit_token after explicit spending authorization; preserve request_id for retries. Three lifetime free units per account or anonymous network. A check uses one; full uses three. Extra units cost US$0.10 each. Active Starter, Pro and Agency plans include prompts while valid, within 60 requests/hour. No partial free debit: a full prompt needs three free units or is charged in full. The licensed prompt is saved for this owner and organization. Reopening the same selector is free even after plan expiry. Preserve its text and license; use it only for license.domain. Reuse the UUID v4 request_id and identical body after a delivery failure. Payment uses X-Credito or the x402 challenge. Never charge without the user's authorization. Uses saved observations only; does not start a new collection. Missing evidence is not charged.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Owned tab in the active organization ID."
    },
    "guest_token": {
      "type": "string"
    },
    "scope": {
      "type": "string",
      "enum": [
        "check",
        "full"
      ],
      "description": "check or full."
    },
    "check_id": {
      "type": "string",
      "description": "registration, certificate, dns or email. Required for check; absent for full."
    },
    "language": {
      "type": "string",
      "enum": [
        "en",
        "pt"
      ],
      "description": "Language of the prompt instructions and check names: en for English, pt for Portuguese."
    },
    "request_id": {
      "type": "string",
      "format": "uuid",
      "description": "New UUID v4 per generation. Keep it unchanged for retries."
    },
    "credit_token": {
      "type": "string",
      "description": "Prepaid cred_… token. Requires explicit user authorization."
    },
    "source": {
      "type": "string",
      "enum": [
        "domain"
      ],
      "description": "domain: the saved registration, certificate, DNS and email observations of the tab."
    }
  },
  "required": [
    "id",
    "scope",
    "language",
    "request_id",
    "source"
  ]
}

Generate a fix prompt for a weekly finding or a Search Console opportunity. Prepare a coding-agent prompt from an owned report. One check uses one unit; full uses three. Three units are free once. Then US$0.10 per unit, or included in an active PageAudit plan. Read prompt_allowance first. Only send credit_token after explicit spending authorization; preserve request_id for retries. Three lifetime free units per account or anonymous network. A check uses one; full uses three. Extra units cost US$0.10 each. Active Starter, Pro and Agency plans include prompts while valid, within 60 requests/hour. No partial free debit: a full prompt needs three free units or is charged in full. The licensed prompt is saved for this owner and organization. Reopening the same selector is free even after plan expiry. Preserve its text and license; use it only for license.domain. Reuse the UUID v4 request_id and identical body after a delivery failure. Payment uses X-Credito or the x402 challenge. Never charge without the user's authorization. Uses saved observations only; does not start a new collection. Missing evidence is not charged.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Owned site ID."
    },
    "guest_token": {
      "type": "string"
    },
    "scope": {
      "type": "string",
      "enum": [
        "check",
        "full"
      ],
      "description": "check or full."
    },
    "check_id": {
      "type": "string",
      "description": "Weekly finding type, or opportunity for Search Console. Required for check; absent for full."
    },
    "language": {
      "type": "string",
      "enum": [
        "en",
        "pt"
      ],
      "description": "Language of the prompt instructions and check names: en for English, pt for Portuguese."
    },
    "request_id": {
      "type": "string",
      "format": "uuid",
      "description": "New UUID v4 per generation. Keep it unchanged for retries."
    },
    "credit_token": {
      "type": "string",
      "description": "Prepaid cred_… token. Requires explicit user authorization."
    },
    "source": {
      "type": "string",
      "enum": [
        "weekly",
        "search_console"
      ],
      "description": "weekly: a finding of a saved weekly report. search_console: a saved Search Console opportunity."
    },
    "report_id": {
      "type": "string",
      "description": "Required for weekly: saved report ID."
    },
    "query": {
      "type": "string",
      "maxLength": 1024,
      "description": "Exact opportunity query; required for Search Console check."
    }
  },
  "required": [
    "id",
    "scope",
    "language",
    "request_id",
    "source"
  ]
}

Read a saved prompt. It costs nothing, even after plan expiry. Preserve the complete prompt and license. Use it only for license.domain. This does not authorize deployments or infrastructure changes. Uses the authenticated owner and active organization. Returns the immutable text. A missing or foreign prompt returns 404. Does not consume allowance, credit or require an active plan.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Saved prompt ID from generation or the private list."
    },
    "guest_token": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ]
}

Find saved audits prompts before generation. Listing is free. Keep language and source filters when following the cursor. At most 100 saved rows per page, plus up to three earlier free audit receipts. Follow _links.next. A legacy receipt has id=null and legacy=true; the matching generation recovers it without a debit. The result belongs to the authenticated owner and active organization.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Owned source ID."
    },
    "guest_token": {
      "type": "string"
    },
    "language": {
      "type": "string",
      "enum": [
        "en",
        "pt"
      ],
      "description": "Prompt language: en (default) for English or pt for Portuguese."
    },
    "after": {
      "type": "string",
      "description": "Cursor from the preceding page."
    }
  },
  "required": [
    "id"
  ]
}

Find saved tabs prompts before generation. Listing is free. Keep language and source filters when following the cursor. At most 100 saved rows per page, plus up to three earlier free audit receipts. Follow _links.next. A legacy receipt has id=null and legacy=true; the matching generation recovers it without a debit. The result belongs to the authenticated owner and active organization.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Owned source ID."
    },
    "guest_token": {
      "type": "string"
    },
    "language": {
      "type": "string",
      "enum": [
        "en",
        "pt"
      ],
      "description": "Prompt language: en (default) for English or pt for Portuguese."
    },
    "after": {
      "type": "string",
      "description": "Cursor from the preceding page."
    },
    "source": {
      "type": "string",
      "enum": [
        "domain"
      ],
      "description": "domain: the saved domain observations of the tab."
    }
  },
  "required": [
    "id",
    "source"
  ]
}

Find saved sites prompts before generation. Listing is free. Keep language and source filters when following the cursor. At most 100 saved rows per page, plus up to three earlier free audit receipts. Follow _links.next. A legacy receipt has id=null and legacy=true; the matching generation recovers it without a debit. The result belongs to the authenticated owner and active organization.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Owned source ID."
    },
    "guest_token": {
      "type": "string"
    },
    "language": {
      "type": "string",
      "enum": [
        "en",
        "pt"
      ],
      "description": "Prompt language: en (default) for English or pt for Portuguese."
    },
    "after": {
      "type": "string",
      "description": "Cursor from the preceding page."
    },
    "source": {
      "type": "string",
      "enum": [
        "weekly",
        "search_console"
      ],
      "description": "weekly: a saved weekly report. search_console: saved Search Console opportunities."
    },
    "report_id": {
      "type": "string",
      "description": "Required for weekly."
    }
  },
  "required": [
    "id",
    "source"
  ]
}

Read the weekly report of a site: what changed since last week, the new pages of up to 3 competitors and every finding. Reading never runs the report. Once a week the report checks the first 500 URLs of the site's sitemap, says what changed since the week before (new and fixed problems, new pages) and lists the new pages of up to 3 competitor sitemaps. It comes with the watch packages: one site for every 25 paid pages. Reading never runs the report.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Site owned by this account."
    },
    "lang": {
      "type": "string",
      "description": "optional: pt for the texts in Portuguese"
    }
  },
  "required": [
    "id"
  ]
}

Turn the weekly report of a site on or off and set up to 3 competitors. Turning on needs a watch package in force. Turning on needs a watch package in force and a free site in it (409 with `limit` and `plans` otherwise). The first report runs right away; later ones run a week after the last. A new competitor gets its base this week and its new pages from the next. Saves use the expected version.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Site owned by this account."
    },
    "version": {
      "type": "integer",
      "minimum": 0,
      "description": "0 the first time; then `settings.version`."
    },
    "paused": {
      "type": "boolean",
      "description": "`false` turns the weekly report on; `true` turns it off."
    },
    "competitors": {
      "type": "array",
      "maxItems": 3,
      "items": {
        "type": "string",
        "maxLength": 300
      },
      "description": "Up to 3 competitor sites (any address; the report reads the origin's /sitemap.xml)."
    }
  },
  "required": [
    "id",
    "version",
    "paused",
    "competitors"
  ]
}

Read one weekly report of a site's history by its id.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Site owned by this account."
    },
    "report": {
      "type": "string",
      "description": "A report id from history."
    },
    "lang": {
      "type": "string",
      "description": "optional: pt for the texts in Portuguese"
    }
  },
  "required": [
    "id",
    "report"
  ]
}

Check whether the site's page appears in AI search for each target search, at which position, and which sites appear in its place, with plain recommendations. Uses the saved searches or the ones the page suggests when queries is omitted. Send {} to use the saved searches, or the searches the page title and H1 suggest; send {queries} to choose. One index check plus one search per query, each USD 0.00075 when it returns results. A run with the same searches in the last 24 hours comes back with reused: true and no cost. Without a watch package: one run per week, three searches. With one: twenty runs per UTC day, ten searches. Result titles and snippets are third-party data.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Site owned by this account."
    },
    "lang": {
      "type": "string",
      "enum": [
        "en",
        "pt"
      ],
      "description": "Language of the recommendations."
    },
    "queries": {
      "type": "array",
      "minItems": 1,
      "maxItems": 10,
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128
      },
      "description": "Optional. One to ten searches, 1 to 128 characters each."
    }
  },
  "required": [
    "id"
  ]
}

Read the plan, the saved searches, the last runs and the position trend of each search. Reads never call the search engine. The trend compares each search of the newest run with the previous run that had it: up, down, same, new or lost.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Site owned by this account."
    }
  },
  "required": [
    "id"
  ]
}

Save up to ten searches for the weekly report to track (three without a watch package). Saves use the expected version. Without a current watch package, an account tracks up to three searches. Uses the shared 240 writes per site and UTC day.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Site owned by this account."
    },
    "version": {
      "type": "integer",
      "minimum": 0,
      "description": "0 initially; then the current settings version."
    },
    "queries": {
      "type": "array",
      "minItems": 1,
      "maxItems": 10,
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128
      },
      "description": "One to ten distinct searches, 1 to 128 characters each."
    }
  },
  "required": [
    "id",
    "version",
    "queries"
  ]
}

Read the owned site's installation, actions, paths and ordered conversion funnel for the last seven days. Requires the account's browser session. Only this site's owner can read it. Data updates through the shared realtime transport. No user identity, typed text or screen recording.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Owned Site.id."
    }
  },
  "required": [
    "id"
  ]
}

Enable or pause an owned site's collection, or set up to eight ordered project_action steps. Activation requires an existing paid site package; this call never buys one. Configure optional Google credentials in the UI. Activation requires the existing site package or an operator-authorised internal benefit. A 402 opens the package offer when available. It never buys automatically. Keep Google secrets out of URLs and browser scripts.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Owned Site.id."
    },
    "active": {
      "type": "boolean",
      "description": "Enable or pause collection."
    },
    "project": {
      "type": "string",
      "description": "Required on creation: 2–20 lowercase letters, digits or underscores, starting with a letter. Cannot change."
    },
    "steps": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 8,
      "description": "Up to eight ordered project_action IDs."
    }
  },
  "required": [
    "id",
    "active"
  ]
}

Requires the account session, current X-Organization-Id and CSRF for writes. Read today's private TLS review without starting a scan. One review per account, organization, origin and UTC day. Starting requires current domain monitoring rights. The account has three starts per UTC day. Retries return the same review. The scanner samples one public IP, with three stages and a 170-second deadline. Partial results do not establish safety. GET never starts a scan. The shared realtime channel reports stage changes. Reports expire after 26 hours.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Owned tab ID from list_tabs."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Requires the account session, current X-Organization-Id and CSRF for writes. Start a TLS review of the saved HTTPS origin using current domain monitoring rights. At most three starts per account and UTC day, one per site. A repeated request reuses today's review. Do not claim complete safety from a partial result. One review per account, organization, origin and UTC day. Starting requires current domain monitoring rights. The account has three starts per UTC day. Retries return the same review. The scanner samples one public IP, with three stages and a 170-second deadline. Partial results do not establish safety. GET never starts a scan. The shared realtime channel reports stage changes. Reports expire after 26 hours.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Owned tab ID from list_tabs."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Requires the account session, current X-Organization-Id and CSRF for writes. Cancel the current TLS review and preserve completed evidence. One review per account, organization, origin and UTC day. Starting requires current domain monitoring rights. The account has three starts per UTC day. Retries return the same review. The scanner samples one public IP, with three stages and a 170-second deadline. Partial results do not establish safety. GET never starts a scan. The shared realtime channel reports stage changes. Reports expire after 26 hours.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Owned tab ID from list_tabs."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Requires the account session, current X-Organization-Id and CSRF for writes. Read cached domain monitoring and deadlines for selected saved pages. Does not start external collection or activate monitoring. Every tab must belong to the current account and organization. Reads by primary key without collection, activation or billing. Repeat with the next group of IDs for a larger workspace.

{
  "type": "object",
  "properties": {
    "tabs": {
      "type": "array",
      "minItems": 1,
      "maxItems": 100,
      "uniqueItems": true,
      "items": {
        "type": "string"
      },
      "description": "One to 100 owned tab IDs."
    }
  },
  "required": [
    "tabs"
  ],
  "additionalProperties": false
}

Requires the account session, current X-Organization-Id and CSRF for writes. Review the exact selected domains before changing renewal notices. Does not activate monitors, purchase access or change certificate notice timing. Select up to 25 saved pages. Repeated registrable domains count once. The server checks the account, organization and current revisions again. A stale preview changes nothing. This does not activate monitoring or purchase access.

{
  "type": "object",
  "properties": {
    "tabs": {
      "type": "array",
      "minItems": 1,
      "maxItems": 25,
      "uniqueItems": true,
      "items": {
        "type": "string"
      },
      "description": "One to 25 owned tab IDs."
    },
    "lead_days": {
      "type": "integer",
      "enum": [
        7,
        14,
        30
      ],
      "description": "Days before domain expiry for renewal notices."
    }
  },
  "required": [
    "tabs",
    "lead_days"
  ],
  "additionalProperties": false
}

Requires the account session, current X-Organization-Id and CSRF for writes. Apply the reviewed selection. Requires the preview from preview_domain_alerts. A stale preview changes nothing. Does not activate monitors, purchase access or change certificate notice timing. Select up to 25 saved pages. Repeated registrable domains count once. The server checks the account, organization and current revisions again. A stale preview changes nothing. This does not activate monitoring or purchase access.

{
  "type": "object",
  "properties": {
    "tabs": {
      "type": "array",
      "minItems": 1,
      "maxItems": 25,
      "uniqueItems": true,
      "items": {
        "type": "string"
      },
      "description": "One to 25 owned tab IDs."
    },
    "lead_days": {
      "type": "integer",
      "enum": [
        7,
        14,
        30
      ],
      "description": "Days before domain expiry for renewal notices."
    },
    "preview": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$",
      "description": "Exact preview from the POST response for these tabs and lead_days."
    }
  },
  "required": [
    "tabs",
    "lead_days",
    "preview"
  ],
  "additionalProperties": false
}

Read registration, contact visibility, TLS, DNS, CAA, mail policies, certificate issuance and a limited server comparison. Read source dates and collection gaps. Private options require the account session. A discovered name never starts monitoring automatically. Pages share public observations by registry domain and HTTPS origin. Private settings and history stay with the account and organization. Missing data is not a healthy result.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Owned tab ID from list_tabs."
    },
    "guest_token": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ]
}

Refresh due registration, contacts, TLS, DNS, mail policies, certificate issuance and a limited DNS/TLS sample. Reuses fresh public data. Does not enable monitoring or make a purchase. Reuse fresh observations. A failed or partial query preserves the last complete observation and its date. Up to 100 cold page reads per owner and UTC day. This call does not enable a monitor or buy access.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Owned tab ID from list_tabs."
    },
    "guest_token": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ]
}

Requires the account session, current X-Organization-Id and CSRF for writes. Set or remove the private manual expiry. It does not change the registry data or confirm renewal payment. Send manual_expires_on, dns, or both. Omitted settings are preserved. DNS requires both selectors and rotating_addresses. A manual date does not change registry data or confirm renewal payment. An identical retry is idempotent. A conflicting revision returns 409.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Owned tab ID from list_tabs."
    },
    "revision": {
      "type": "integer",
      "minimum": 0,
      "description": "Current revision from the corresponding settings or monitor. Use zero for the first change."
    },
    "manual_expires_on": {
      "type": [
        "string",
        "null"
      ],
      "description": "YYYY-MM-DD, or null to remove."
    }
  },
  "required": [
    "id",
    "revision",
    "manual_expires_on"
  ]
}

Requires the account session, current X-Organization-Id and CSRF for writes. Set up to three known DKIM selectors and choose whether IP rotation is expected. Expected rotation keeps history without notices; alias changes still notify. Does not discover selectors, enable monitoring or authenticate sent messages. Send manual_expires_on, dns, or both. Omitted settings are preserved. DNS requires both selectors and rotating_addresses. A manual date does not change registry data or confirm renewal payment. An identical retry is idempotent. A conflicting revision returns 409.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Owned tab ID from list_tabs."
    },
    "revision": {
      "type": "integer",
      "minimum": 0,
      "description": "Current revision from the corresponding settings or monitor. Use zero for the first change."
    },
    "dns": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "dkim_selectors": {
          "type": "array",
          "maxItems": 3,
          "uniqueItems": true,
          "items": {
            "type": "string",
            "maxLength": 63,
            "pattern": "^[a-z0-9][a-z0-9._-]*$"
          }
        },
        "rotating_addresses": {
          "type": "boolean"
        }
      },
      "required": [
        "dkim_selectors",
        "rotating_addresses"
      ],
      "description": "Known selectors and expected IP rotation. Selector discovery is not performed."
    }
  },
  "required": [
    "id",
    "revision",
    "dns"
  ],
  "additionalProperties": false
}

Requires the account session, current X-Organization-Id and CSRF for writes. Enable or stop domain monitoring, or pause notices for maintenance. Uses existing rights; 402 supplies checkout instructions and never buys automatically. Stopping a monitor does not cancel a subscription. Activation requires a current domain benefit, a preserved prepaid watch benefit or the account trial. Count a registry domain once per account, including its organization copies. Add only the tab's origin. HTTP receives DNS checks only. Stopping monitoring keeps history and does not cancel a subscription. Maintenance pauses notices while collection continues. Confirm enabled, no suspension and next_check_at after saving.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Owned tab ID from list_tabs."
    },
    "revision": {
      "type": "integer",
      "minimum": 0,
      "description": "Current revision from the corresponding settings or monitor. Use zero for the first change."
    },
    "enabled": {
      "type": "boolean",
      "description": "True enables collection; false stops it."
    },
    "maintenance_until": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Future Unix milliseconds within 30 days, or null."
    }
  },
  "required": [
    "id",
    "revision",
    "enabled",
    "maintenance_until"
  ]
}

Requires the account session, current X-Organization-Id and CSRF for writes. Read up to 50 private incidents with notice delivery. Send the last event number as before for the next page. A first observed risk is an initial incident, not evidence of an external change. The first DNS and certificate-issuance snapshots are silent baselines. DNS changes, incompatible server samples and connection failures need two distinct observations. Expected IP rotation is silent. Repeated observations do not duplicate a notice. Contact changes expose field states only. Issuance does not prove installation. DNS records do not prove authentication of sent mail.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Owned tab ID from list_tabs."
    },
    "before": {
      "type": "integer",
      "minimum": 1,
      "description": "Return events with a number below this cursor."
    }
  },
  "required": [
    "id"
  ]
}

Requires the account session, current X-Organization-Id and CSRF for writes. Acknowledge an expected event. Suppress its notice only if sending has not started. Preserve the event and its evidence. Preserve the event and observation. Acknowledgement does not erase a confirmed risk or retract a sent notice. Repetition is idempotent.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Owned tab ID from list_tabs."
    },
    "number": {
      "type": "integer",
      "minimum": 1,
      "description": "Positive history event number."
    }
  },
  "required": [
    "id",
    "number"
  ]
}

Check the first 20 URLs of a site's sitemap: status, redirects, robots.txt, noindex, canonical, titles and descriptions. It also flags a plan with different prices on different pages. Free, without an account. The same site within one hour returns the stored sample. URLs of another host are counted, never requested. The free sample of the SEO audit. It reads `/sitemap.xml` (an index opens up to 5 sitemaps), checks the first 20 URLs of the same host and reports: not 200, redirects (to the home page or to a broken page), robots.txt blocks, `noindex`, a missing or foreign canonical, HTML without content, a title that is missing, generic or outside 40–60 characters, a missing description, repeated titles and descriptions, and the same plan with different prices (pages, JSON-LD and llms.txt). URLs of another host are counted, never requested. The same site within one hour returns the stored sample (`cached_at`) without requesting the site again and without spending the allowance. A new sample spends one audit of the daily allowance; past it, **402 with `accepts[]`**, as in `POST /api/audit`.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "any address of the site"
    },
    "lang": {
      "type": "string",
      "description": "optional: pt for the texts in Portuguese"
    },
    "guest_token": {
      "type": "string",
      "description": "optional pa_…"
    }
  },
  "required": [
    "url"
  ]
}

Request a page as Googlebot, Bingbot and the AI crawlers (OAI-SearchBot, Claude-SearchBot, PerplexityBot, ChatGPT-User, GPTBot, ClaudeBot) and see who gets a 403, a 429 or a firewall challenge that robots.txt does not show. Also returns the date of the newest sitemap lastmod and whether Cloudflare is in front. Free, without an account. The same page within one hour returns the stored result. The page is requested with the published user agent of Googlebot, Bingbot, OAI-SearchBot, Claude-SearchBot, PerplexityBot, ChatGPT-User, GPTBot, ClaudeBot, and once as a browser. A 403, a 429 or a firewall challenge that only a crawler gets is the block that robots.txt does not show. The sitemap is the one that robots.txt declares, or `/sitemap.xml`; it is stale when its newest `lastmod` is more than 30 days old. Limit: Cloudflare recognises the real crawler by its IP address, so a rule that trusts verified bots can treat the real crawler differently. The same page within one hour returns the stored result (`cached_at`) without requesting the site again.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "the page to check"
    }
  },
  "required": [
    "url"
  ]
}

Discovers the whole PageAudit API (self-describing index).

{
  "type": "object",
  "properties": {}
}

Liveness and the commit deployed right now — it is how the smoke waits for its own deploy.

{
  "type": "object",
  "properties": {}
}

Lists the micro-tools (title, meta, canonical, OG, JSON-LD…).

{
  "type": "object",
  "properties": {
    "language": {
      "type": "string",
      "enum": [
        "en",
        "pt"
      ],
      "description": "Content language: pt (also pt-BR) for Portuguese; any other value or none returns English."
    }
  }
}

Copy and checks of one micro-tool by slug (e.g. title-tag-checker).

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "tool slug"
    },
    "language": {
      "type": "string",
      "enum": [
        "en",
        "pt"
      ],
      "description": "Content language: pt (also pt-BR) for Portuguese; any other value or none returns English."
    }
  },
  "required": [
    "slug"
  ]
}

Check a web page's search metadata, crawl access, structured data and selected discovery files. Return evidence, limits and suggested changes without creating a saved tab. A blocked target returns HTTP 502 with target_blocked. The report does not certify security or accessibility. This is the product for agents. Past the account or anonymous network's daily allowance the response is **402 with `accepts[]`** and `code: allowance_spent` — pay and repeat the same call. There is no captcha: people and agents pay the same way. The free alternative: a person signs in with an account to get the trial.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "absolute URL to audit"
    },
    "guest_token": {
      "type": "string",
      "description": "optional pa_…"
    },
    "compare_with": {
      "type": "string",
      "description": "optional ID of an earlier audit of the same owner; returns what appeared and disappeared"
    }
  },
  "required": [
    "url"
  ]
}

Creates a guest token pa_… for the tab workspace. Keep the token: it is the identity of the tabs and of the audits tied to them.

{
  "type": "object",
  "properties": {}
}

Lists the owner's saved pages (guest or session), with the active page's last report. Group pages by site to match the Projects table. One call loads the saved pages and the active page's last report. The UI groups pages by site in Projects and opens each site in a work tab. The introduction stays in Welcome. A signed-in account sends `X-Organization-Id`; a guest has one temporary workspace.

{
  "type": "object",
  "properties": {
    "guest_token": {
      "type": "string"
    }
  },
  "required": [
    "guest_token"
  ]
}

Opens a saved URL. Set queue_audit=false to monitor a discovered origin without a page audit. Past the free tab allowance it answers 402 with `accepts[]`: pay and repeat.

{
  "type": "object",
  "properties": {
    "guest_token": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "description": "The URL the tab will follow."
    },
    "alias": {
      "type": "string",
      "description": "Label to recognise the tab in the list."
    },
    "queue_audit": {
      "type": "boolean",
      "default": true,
      "description": "Defaults to true. Use false to save an idle page for domain monitoring without queuing a page audit. Existing pages keep their current state."
    }
  },
  "required": [
    "guest_token",
    "url"
  ]
}

Re-audits the tab's URL. Consumes the same daily allowance as `POST /api/audit` — past it, 402 with `accepts[]`.

{
  "type": "object",
  "properties": {
    "guest_token": {
      "type": "string"
    },
    "id": {
      "type": "string",
      "description": "ID of the tab to re-audit."
    }
  },
  "required": [
    "guest_token",
    "id"
  ]
}

The tab's previous runs and what changed between each one and the one before it (score delta, findings that appeared and that disappeared). Every run has always been kept; this is where you read the series. Each entry carries the score, the counts and a `change` with the point delta and the findings that appeared (`broke`) or disappeared (`fixed`) since the previous run — compared by finding code, never by message. Runs older than the watch feature are matched by URL.

{
  "type": "object",
  "properties": {
    "guest_token": {
      "type": "string"
    },
    "id": {
      "type": "string",
      "description": "ID of the tab whose runs you want."
    },
    "limit": {
      "type": "number",
      "description": "how many runs, newest first (default 20, max 100)"
    }
  },
  "required": [
    "guest_token",
    "id"
  ]
}

Turns the daily watch on or off for a tab: it re-audits the page once a day and e-mails when the score drops or a new error/warning appears. Needs the signed-in account (its browser session cookie); a guest token gets 403 `account_required`. When a plan ends, the pages beyond the account's limit pause until the next purchase. With `monitor: true` the page is re-audited once a day and an e-mail goes out when the score drops or a new error/warning appears — never on an improvement. Watching needs an account (the alert has to reach someone) and each account watches a limited number of pages. When a plan ends, the pages beyond the account's limit pause (the oldest stay) until the next purchase.

{
  "type": "object",
  "properties": {
    "guest_token": {
      "type": "string",
      "description": "guest pa_… — refused: a guest has no e-mail to warn"
    },
    "id": {
      "type": "string",
      "description": "ID of the tab to change."
    },
    "monitor": {
      "type": "boolean",
      "description": "true watches, false stops watching"
    },
    "monitor_email": {
      "type": "string",
      "description": "where the alert goes; empty = account e-mail"
    }
  },
  "required": [
    "guest_token",
    "id",
    "monitor"
  ]
}

Starts a lab test of an audit's page: Lighthouse run by Google PageSpeed Insights (performance, accessibility, best practices, SEO). Answers 202 at once; the test takes ~25 s to 2+ minutes — then read it with lab_result. Does not change the audit score. Answers **202** at once; the test runs for ~25 s to over 2 minutes and its summary is stored in the audit (`summary.lab.<strategy>`), so it comes back in `GET /api/audits/:id`, in the tab and in the shared report. It does not change the audit score. Calling again while the same strategy is running does not start a second test. Limits: 4 tests at a time on the server, 6 per network per hour and 500 per day for the whole product. Free: no x402 charge.

{
  "type": "object",
  "properties": {
    "guest_token": {
      "type": "string"
    },
    "id": {
      "type": "string",
      "description": "audit id"
    },
    "strategy": {
      "type": "string",
      "description": "mobile (default) or desktop"
    }
  },
  "required": [
    "guest_token",
    "id"
  ]
}

The lab tests of an audit (mobile and desktop): running, finished with scores, metrics and biggest savings, or failed. With wait (up to 25) it answers as soon as a running test finishes. Long-poll: with `wait` the answer comes as soon as a running test finishes, or after `wait` seconds with `status: running`. Repeat until it is not running.

{
  "type": "object",
  "properties": {
    "guest_token": {
      "type": "string"
    },
    "id": {
      "type": "string",
      "description": "audit id"
    },
    "wait": {
      "type": "number",
      "description": "seconds to wait for a running test, 0–25"
    }
  },
  "required": [
    "guest_token",
    "id"
  ]
}

Re-read an audit with its findings and evidence. Use generate_fix_prompt for correction steps. Re-reading costs nothing and does not count against the allowance — the page's HTML is not kept, but the report is.

{
  "type": "object",
  "properties": {
    "guest_token": {
      "type": "string"
    },
    "id": {
      "type": "string",
      "description": "Audit ID, from `Audit.id`."
    }
  },
  "required": [
    "guest_token",
    "id"
  ]
}

Metadata and markdown of the SVG badge of a shared report.

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "24-char public slug"
    }
  },
  "required": [
    "slug"
  ]
}

The embeddable widget's snippet, already assembled with the site's name and colour — one script tag, no account, no lead capture. One script tag puts the audit form on your own site, with your name and colour, and no account or key. Send the same query you would send to `/embed` and the answer comes back with `snippet` already assembled. The widget never asks the visitor for an e-mail.

{
  "type": "object",
  "properties": {
    "brand": {
      "type": "string",
      "description": "site name shown above the form"
    },
    "color": {
      "type": "string",
      "description": "accent colour in hex"
    },
    "theme": {
      "type": "string",
      "description": "auto, light or dark"
    },
    "url": {
      "type": "string",
      "description": "optional URL to pre-fill"
    }
  }
}

Read free allowances, prices and the account's 7-day trial. Each audit beyond the daily allowance costs $0.02. Hourly limits still apply.

{
  "type": "object",
  "properties": {}
}

The plans for sale, with price and term, and the account's active plan. Each purchase lasts 30 days, with no automatic renewal. Each purchase lasts 30 days, with no automatic renewal. Without an account or wallet credential, `account` is `null`. Daily monitoring requires an account and its e-mail. Claim a wallet purchase after sign-in to use it there. Active Starter, Pro and Agency plans also include agent prompts for that account, within 60 requests/hour.

{
  "type": "object",
  "properties": {}
}

Buy a plan: starter (25 more pages), pro (100 more pages), agency (300 more pages). Each purchase lasts 30 days, with no automatic renewal. Answers 402 with the price; pay with x402 or prepaid credit and repeat. Each purchase lasts 30 days, with no automatic renewal. Without payment, the answer is 402 with the price. Pay with prepaid credit (`X-Credito`) or x402 (`PAYMENT-SIGNATURE` v2 or `X-PAYMENT` v1). Without an account, the verified paying wallet owns the purchase. Use wallet agent authentication to read its plan, or claim it after account sign-in. The `compra` mark prevents repeat credit debits. An x402 nonce can settle only once; keep the receipt after a delivery error.

{
  "type": "object",
  "properties": {
    "plan": {
      "type": "string",
      "enum": [
        "starter",
        "pro",
        "agency"
      ],
      "description": "`starter` (25 more pages), `pro` (100 more pages), `agency` (300 more pages)"
    }
  },
  "required": [
    "plan"
  ]
}

Cancel the active plan now. What it added ends, including a paid period that has not started; that period and a purchase under 7 days are refunded. Requires accept_data_removal: true. Send `{ "accept_data_removal": true }`: what the plan added ends now (`account.cancel.losses` in `GET /api/plans` says what), including a period already paid that has not started yet, such as a renewal. A purchase made less than 7 days ago and a paid period that has not started go back the same way they were paid (card or Pix); USDC is refunded by the team.

{
  "type": "object",
  "properties": {
    "accept_data_removal": {
      "type": "boolean",
      "const": true,
      "description": "Must be `true`: you accept losing what the plan added."
    }
  },
  "required": [
    "accept_data_removal"
  ]
}

Write to the people behind the product: a question, or a sponsorship/partnership/advertising proposal. Free, no captcha and no payment; one message every 10 s per network (one that arrives sooner waits its turn). One route for a question and for a sponsorship, partnership or ad proposal (`tipo`, with the placements of `GET /api/partners`). No captcha, no account, no payment. One message every 10 seconds per network: one that arrives sooner waits its turn and then goes out — no error. The message reaches the team by e-mail, with `email` as the reply address. For voice, send multipart/form-data: `dados` is this JSON (up to 32 KiB), and `audio` is one WebM, Ogg or M4A audio file (up to 2 MB). Audio can replace message. The browser records up to two minutes. Audio is attached to the owner's e-mail.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "What to call the person writing."
    },
    "email": {
      "type": "string",
      "description": "Where to reply."
    },
    "message": {
      "type": "string",
      "description": "What you want to say."
    },
    "whatsapp": {
      "type": "string",
      "description": "Optional reply number with country code, such as +5561999999999."
    },
    "prefer_whatsapp": {
      "type": "boolean",
      "description": "Request a WhatsApp reply. Requires whatsapp."
    },
    "tipo": {
      "type": "string",
      "enum": [
        "patrocinio",
        "parceria",
        "anuncio",
        "consultoria"
      ],
      "description": "Proposal: `patrocinio`, `parceria`, `anuncio` or `consultoria`. Turns on the fields below."
    },
    "empresa": {
      "type": "string",
      "description": "Who is proposing, when it is a company."
    },
    "site": {
      "type": "string",
      "description": "Website of who is proposing."
    },
    "orcamento": {
      "type": "string",
      "enum": [
        "ate_100",
        "100_500",
        "500_2000",
        "2000_mais",
        "a_combinar",
        "ate_2000",
        "2000_5000",
        "5000_10000",
        "10000_mais",
        "nao_sei"
      ],
      "description": "Advertising: `ate_100`, `100_500`, `500_2000`, `2000_mais` or `a_combinar`. Consulting, in US dollars: `ate_2000`, `2000_5000`, `5000_10000`, `10000_mais` or `nao_sei`."
    },
    "espaco": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Placement ids from `GET /api/partners`, up to 6."
    },
    "duracao": {
      "type": "string",
      "enum": [
        "30",
        "90",
        "365"
      ],
      "description": "Exposure in days: `30`, `90` or `365`."
    },
    "pagamento": {
      "type": "string",
      "enum": [
        "usdc",
        "deposito",
        "a_combinar"
      ],
      "description": "`usdc`, `deposito` or `a_combinar`."
    },
    "projeto": {
      "type": "string",
      "enum": [
        "llm_privado",
        "voz",
        "dados_sensiveis",
        "gpu",
        "integracao",
        "outro"
      ],
      "description": "Consulting: the kind of project (`llm_privado`, `voz`, `dados_sensiveis`, `gpu`, `integracao` or `outro`)."
    },
    "prazo": {
      "type": "string",
      "enum": [
        "agora",
        "1_mes",
        "1_3_meses",
        "explorando"
      ],
      "description": "Consulting: when to start (`agora`, `1_mes`, `1_3_meses` or `explorando`)."
    },
    "formato": {
      "type": "string",
      "enum": [
        "projeto",
        "mensal",
        "assessoria"
      ],
      "description": "Consulting: `projeto` (per scope), `mensal` (monthly) or `assessoria` (advisory)."
    },
    "pais": {
      "type": "string",
      "description": "Consulting: the country of the person asking."
    },
    "fuso": {
      "type": "string",
      "description": "Consulting: the IANA time zone, such as `America/New_York`."
    },
    "horarios": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Consulting: up to 3 times for the call, `YYYY-MM-DDTHH:MM` in that time zone."
    }
  },
  "required": [
    "name",
    "email",
    "message"
  ]
}

Current public prices and free allowances; no charge.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Audits one page for an agent, paid per call: no account, no allowance and no tab. The report of `POST /api/audit`, sold per call to agents. A request without payment gets the 402 with the price; a paid one gets the report in the same response, with the payment in `cobranca`. Nothing is stored: the report has no `id` and no tab. A page that does not open is not charged.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "The page to audit, `http` or `https`."
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}