HTML Clean Text API

Fetches a web page and returns the article as clean text and markdown, with its declared metadata.

Updated

Agents read this page asGET /v1/html-clean-text/schemafree: schema, examples, errors, price

Endpoint
POST /v1/html-clean-text
Price
$0.002 per call
Timeout
12 s
max_timeout_seconds
33 (the whole call as the 402 envelope sells it: the timeout, plus payment verification and settlement around it)
Response cap
1 MB (1,048,576 bytes)

When to use it

It needs the network and a real DOM: boilerplate removal, legacy charset decoding and HTML-to-markdown are three heavy libraries an agent does not carry, and feeding raw HTML to a model instead costs far more in tokens than this call costs.

Your source is HTML and you need Markdown or plain text.

When not to use it

  • The input is over 1 MB (1,048,576 bytes): html-clean-text answers too_large (413).
  • The destination needs more than 12 s to answer: the call ends with upstream_timeout (424).
  • The destination is on a private or local network: the network guard refuses it with blocked_target (403).

Parameters

One JSON body. The schema is free at GET /v1/html-clean-text/schema.

FieldTypeRequiredDescription
urlstringnoURL of an HTML, XHTML or plain-text page to fetch, up to 2048 characters; redirects are followed, the body is capped at 1 MB, and exactly one of url or html is required.
htmlstringnoInline HTML source to clean instead of fetching, up to 262,144 characters; binary content such as PDF or JSON is refused.
base_urlstringnoBase URL for resolving relative links in the html input; not allowed together with url, where the final fetched URL is the base.
include_linksbooleannoAlso return the links inside the extracted content, each with its text, rel and same-host flag, resolved against the fetched URL or base_url when there is one, else kept as authored. Default: false.
readabilitybooleannoRun Readability to keep only the main article; false, or an article Readability cannot find, converts the whole body, navigation and footer included. Default: true.
max_charsintegernoMaximum length of text and markdown, 200 to 200,000 Unicode code points (default 50,000); a longer result is cut and flagged as truncated. Default: 50000.

Limits

LimitValue
Largest source file1 MB (1,048,576 bytes)
Timeout12 s
Source formatsHTML
Output formatsMarkdown, plain text
Show the JSON Schema the handler validates against
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "url": {
      "description": "URL of an HTML, XHTML or plain-text page to fetch, up to 2048 characters; redirects are followed, the body is capped at 1 MB, and exactly one of url or html is required.",
      "type": "string",
      "maxLength": 2048,
      "format": "uri"
    },
    "html": {
      "description": "Inline HTML source to clean instead of fetching, up to 262,144 characters; binary content such as PDF or JSON is refused.",
      "type": "string",
      "minLength": 1,
      "maxLength": 262144
    },
    "base_url": {
      "description": "Base URL for resolving relative links in the html input; not allowed together with url, where the final fetched URL is the base.",
      "type": "string",
      "maxLength": 2048,
      "format": "uri"
    },
    "include_links": {
      "default": false,
      "description": "Also return the links inside the extracted content, each with its text, rel and same-host flag, resolved against the fetched URL or base_url when there is one, else kept as authored.",
      "type": "boolean"
    },
    "readability": {
      "default": true,
      "description": "Run Readability to keep only the main article; false, or an article Readability cannot find, converts the whole body, navigation and footer included.",
      "type": "boolean"
    },
    "max_chars": {
      "default": 50000,
      "description": "Maximum length of text and markdown, 200 to 200,000 Unicode code points (default 50,000); a longer result is cut and flagged as truncated.",
      "type": "integer",
      "minimum": 200,
      "maximum": 200000
    }
  },
  "additionalProperties": false
}

Example

The published example, verbatim: the request and the response it returns.

Request
POST /v1/html-clean-text
content-type: application/json
payment-signature: <base64 x402 payload>

{
  "url": "https://grist.tools/samples/web/render-article.html",
  "include_links": true,
  "readability": true,
  "max_chars": 2000
}

Without the payment-signature header the call answers 402 with the payment requirements, including this endpoint's price and its max_timeout_seconds, so the deadline is known before anything is paid. The payment is verified before the handler runs and settled only after it succeeds, so a call refused by the gate, or one that fails inside the handler, is never settled. The single case we cannot state for you is a settlement call that fails without answering: the error message says so when that is what happened.

Response200 OK
200 OK
payment-response: <base64 settlement receipt>

{
  "requested_url": "https://grist.tools/samples/web/render-article.html",
  "source_url": "https://grist.tools/samples/web/render-article.html",
  "final_url": "https://grist.tools/samples/web/render-article.html",
  "content_type": "text/html",
  "charset": "utf-8",
  "http_status": 200,
  "title": "Measuring Rainfall with a Simple Gauge",
  "byline": "Sample Author",
  "excerpt": "A short guide to reading a cylinder rain gauge at the same hour every day.",
  "site_name": "Grist Samples",
  "lang": "en",
  "lang_source": "html_lang",
  "text": "A cylinder rain gauge is a clear tube with a scale printed on the side. Rain falls through a funnel at the top and collects in the tube, where the water level shows how much fell since the last reading.\nThe most useful habit is consistency. Read the gauge at the same hour every day, ideally in the morning, so that each number covers one full day.\nPlacing the gauge\nPut the gauge in an open spot, away from walls, trees and roofs. A good rule is to keep it at least twice as far from any obstacle as the obstacle is tall.\nMount it level, so the scale reads true.\nKeep the funnel clear of leaves and insects.\nEmpty the tube right after each reading.\nReading the scale\nBend down until your eye is level with the water. The surface curves slightly where it meets the tube; read the number at the bottom of that curve.\nWrite the reading in a notebook with the date and time. A printable schedule helps when several people share the job.",
  "markdown": "A cylinder rain gauge is a clear tube with a scale printed on the side. Rain falls through a funnel at the top and collects in the tube, where the water level shows how much fell since the last reading.\n\nThe most useful habit is consistency. Read the gauge at the same hour every day, ideally in the morning, so that each number covers one full day.\n\n## Placing the gauge\n\nPut the gauge in an open spot, away from walls, trees and roofs. A good rule is to keep it at least twice as far from any obstacle as the obstacle is tall.\n\n-   Mount it level, so the scale reads true.\n-   Keep the funnel clear of leaves and insects.\n-   Empty the tube right after each reading.\n\n## Reading the scale\n\nBend down until your eye is level with the water. The surface curves slightly where it meets the tube; read the number at the bottom of that curve.\n\nWrite the reading in a notebook with the date and time. A [printable schedule](https://grist.tools/samples/web/render-print.html) helps when several people share the job.",
  "word_count": 178,
  "char_count": 933,
  "truncated": false,
  "readability_applied": true,
  "links": [
    {
      "href": "https://grist.tools/samples/web/render-print.html",
      "text": "printable schedule",
      "rel": null,
      "is_internal": true
    }
  ],
  "link_count": 1,
  "fetched_at": "2026-09-01T12:00:00.000Z"
}

Sample file: web/render-article.html. Short English article page about reading a rain gauge, with a nav bar, footer boilerplate and a full head of description, canonical, hreflang, favicon, Open Graph and Twitter tags. Sample file: web/render-print.html. Printable one-page HTML table with inline CSS: a weekly rain gauge reading schedule.

In web/render-article.html, the document declares language en and the title "Measuring Rainfall with a Simple Gauge"; 1 style element carries 1 CSS rule; the body holds 6 p, 3 a, 3 li, 2 h2, 1 article, 1 footer, 1 h1, 1 header, 1 main, 1 nav and 1 ul elements; no script element; its headings read "Measuring Rainfall with a Simple Gauge", "Placing the gauge" and "Reading the scale"; its 3 links point to render-article.html, render-print.html and render-print.html. Across the whole file, the markup opens 44 tags, 20 of them inside the head. In web/render-print.html, the document declares language en and the title "Rain Gauge Reading Schedule"; 1 style element carries 8 CSS rules; the body holds 28 td, 8 tr, 4 th, 1 a, 1 footer, 1 h1, 1 p, 1 table, 1 tbody and 1 thead elements; no script element; its heading reads "Rain Gauge Reading Schedule"; the table header cells are Day, Reader, Reading (mm) and Notes; its one link points to render-article.html. Across the whole file, the markup opens 53 tags, 3 of them inside the head. The returned Markdown splits into 8 blocks separated by blank lines, with 2 headings (2 at level 2) reading "Placing the gauge" and "Reading the scale" and 3 bullet list items. Plain paragraphs make up 5 blocks. Its headings total 6 words, its paragraphs 157 words.

Response fields

FieldTypeIn the example
requested_urlstring"https://grist.tools/samples/web/render-article.html"
source_urlstring"https://grist.tools/samples/web/render-article.html"
final_urlstring"https://grist.tools/samples/web/render-article.html"
content_typestring"text/html"
charsetstring"utf-8"
http_statusnumber200
titlestring"Measuring Rainfall with a Simple Gauge"
bylinestring"Sample Author"
excerptstring"A short guide to reading a cylinder rain gauge at the same hour every day."
site_namestring"Grist Samples"
langstring"en"
lang_sourcestring"html_lang"
textstringa string of 933 characters
markdownstringa string of 1011 characters
word_countnumber178
char_countnumber933
truncatedbooleanfalse
readability_appliedbooleantrue
linksarray1 item, each with href, text, rel and is_internal
link_countnumber1
fetched_atstring"2026-09-01T12:00:00.000Z"

Deterministic: the same input returns the same output. Clock-derived fields, when present, are declared in the response.

Call it from code

The client reads the 402, signs the payment and retries on its own.

// html-clean-text: $0.002 per call, paid in USD Coin on eip155:8453 via x402
// Install: npm install @x402/fetch@2 @x402/evm@2 viem@2
// Save as client.mjs (ES module, Node 18+), export EVM_PRIVATE_KEY with the paying wallet's key in your shell, then run: node client.mjs
// The wrapper reads the 402 (payment-required), signs and retries with payment-signature.
import { wrapFetchWithPayment, x402Client, decodePaymentResponseHeader } from '@x402/fetch'
import { ExactEvmScheme } from '@x402/evm/exact/client'
import { privateKeyToAccount } from 'viem/accounts'

const account = privateKeyToAccount(process.env.EVM_PRIVATE_KEY)
const client = new x402Client().register('eip155:8453', new ExactEvmScheme(account))
const fetchWithPayment = wrapFetchWithPayment(fetch, client)

const body = {
  "url": "https://grist.tools/samples/web/render-article.html",
  "include_links": true,
  "readability": true,
  "max_chars": 2000
}

const res = await fetchWithPayment('https://grist.tools/v1/html-clean-text', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify(body),
})
console.log(res.status, await res.json())
const settle = res.headers.get('payment-response')
if (settle) console.log(decodePaymentResponseHeader(settle).transaction)

Errors

Every error is typed JSON. Only a successful call is settled.

CodeHTTPWhen
invalid_input400The body does not match the schema on this page. Nothing is charged. The body does not match the schema; its fields are url, html, base_url, include_links, readability and max_chars.
blocked_target403The destination is refused by the network guard: a disallowed address, or, for HTTP requests, a scheme other than http/https, a port other than 80/443, or credentials in the URL.
unreachable_target424The destination you named did not resolve or refused the connection.
upstream_status424The destination you named answered with a status this endpoint cannot use.
upstream_timeout424The destination you named did not answer before the declared timeout for this endpoint expired.
unsupported_content_type415The destination returned a type this endpoint does not handle. The source is not a type html-clean-text reads; it reads HTML.
too_large413The response exceeded the size cap while streaming, or decompressed at more than the allowed ratio.
unprocessable422The bytes arrived but could not be processed, for instance a malformed document.
internal500Our fault, and in almost every case nothing is charged. The exceptions come after the call has run and the settlement call was made: the message "The work was done but settlement could not be completed", and the messages starting with "Payment settlement returned". There, whether the payment moved is unknown to us as well. The payment moves at most once: its nonce is single-use and settlement is idempotent, so a retry with it is never charged twice. A retry is normally refused with a 402: replay_consumed, an expiry reason, or a reason saying the nonce was already used once the transfer is on-chain. Only if our server restarted before the transfer was final can a retry run the call again. Even then, the payment moves at most once. To see whether it was settled, read the EIP-3009 authorizationState of its nonce on-chain; to call again, sign a new payment.
rate_limited429Too many calls from the same payer, or too many calls towards the same destination domain. Nothing is charged.
concurrency_limit,
registry_at_capacity,
upstream_unavailable
503We could not serve the call right now. Retryable: wait the number of seconds in the retry-after header, then repeat the call. concurrency_limit and registry_at_capacity mean we were at capacity: the call did not run. You can send the same payment again if its validBefore is still far enough away to cover another call. If it is not, the retry gets a 402 authorization_validity_too_short: sign a new payment. upstream_unavailable means our internal service failed or did not answer in time: the call may already have run and the payment may have been settled. A retry with the same payment can get a 402 whose error field says why. authorization_validity_too_short: too little time is left before validBefore to cover another call. This check comes before the replay check, so it does not tell whether the first payment was settled. replay_consumed (the payment was used and may have been settled) or replay_exhausted (too many attempts): sign a new payment. replay_in_flight: the first call is still running, so wait and do not pay again. invalid_exact_evm_nonce_already_used: the transfer is already on-chain, so this payment cannot move again. Sign a new payment. An authorization can be settled only once, since its nonce is single-use. To see whether it was settled, read the EIP-3009 authorizationState of its nonce on-chain.
misconfigured503The service is not configured to serve calls. The call did not run and nothing is charged. It needs a fix on our side, so there is no retry delay to wait for.

Input that is rejected before the tool runs (malformed JSON, schema mismatch, body over the size limit) is never charged.

Conversions

Ready-made calls to this API, one page each.

ConversionRecorded sampleSourceOutput
HTML to Markdownweb/render-article.html2.7 KB1,011 bytes
HTML to plain textweb/render-article.html2.7 KB933 bytes

Questions

How much does a call to the HTML Clean Text API cost?

$0.002 per call, paid in USD Coin on Base via x402. There is no account and no API key: the price is in the 402 answer, before anything is paid.

What is the timeout of html-clean-text?

The endpoint itself runs for at most 12 s. max_timeout_seconds in the 402 answer is 33: that covers the whole call, including payment verification and settlement around it.

How large can a response from html-clean-text be?

The response-size cap is 1 MB (1,048,576 bytes).

Is the html-clean-text input schema free to read?

Yes. GET https://grist.tools/v1/html-clean-text/schema returns the input schema for free, paid endpoints included.

What happens if a call to html-clean-text fails?

The payment is verified before the handler runs and settled only after it succeeds, so a call refused by the gate, or one that fails inside the handler, is never settled. The single case that cannot be stated in advance is a settlement call that fails without answering: the error message says so when that is what happened.

What does html-clean-text return?

A JSON object with 21 top-level fields: requested_url, source_url, final_url, content_type, charset, http_status, title, byline, excerpt, site_name, lang, lang_source, text, markdown, word_count, char_count, truncated, readability_applied, links, link_count and fetched_at. The example on this page is a real call over web/render-article.html and web/render-print.html.