On this page

POST/tools/enrich-website

Fetch a public website’s homepage (and a few recommended pages) for personalization context: title, description, headings, and a text snippet.

0 credits. Rate class: enrich_website (default 20/min). No Idempotency-Key.

Private, loopback, link-local, and similar hosts are rejected. The response status is unreachable (not a separate error code). Redirects use the same host policy.

Request

POST /tools/enrich-website
X-API-Key: sk_live_...
Content-Type: application/json
{ "website": "https://acme.com" }
FieldRequiredNotes
websiteYesMax 500. Protocol optional (acme.com → https://acme.com)

Response

{
  "website": "https://acme.com",
  "status": "ok",
  "title": "Acme",
  "description": "…",
  "headings": ["…"],
  "textSnippet": "…",
  "hasLlmsTxt": false,
  "llmsTxt": "",
  "sitemapFound": true,
  "recommendedPages": [{ "url": "https://acme.com/about", "path": "/about" }],
  "pages": [{ "url": "https://acme.com/about", "title": "About", "snippet": "…" }],
  "creditsCharged": 0
}

status: ok | unreachable | no-website.

Errors

Error codeWhen
validation_errorMissing website, unknown keys, or over max length
rate_limitedenrich_website RPM exceeded

MCP

Tool: enrich_website (readOnlyHint: true).