Extract HTML fragment text

Use to flatten supplied HTML snippets into readable text. Uses parse5 HTML parsing, decodes entities, excludes script/style/template/noscript, optionally includes image alt text, and collapses source whitespace. Block elements and br yield line breaks or spaces. No network, CSS/layout/visibility computation, sanitization guarantee, or browser rendering; hidden elements can remain. Input is parsed as an HTML fragment. Conservative limits: 1,000 less-than characters, 64 lexically open tags (explicitly close optional-end tags), and 4,096 visited parser nodes.

text · Operation ID: html-to-text

Choose this operation when

Parse provided HTML fragments locally and omit script/style/template/noscript text.

Outside this profile

URL scraping, browser-rendered visibility, or HTML security sanitization.

Exact release references

Static JSON contract · Markdown reference · Fixed example response

Complete input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "html": {
      "type": "string",
      "maxLength": 100000
    },
    "mode": {
      "default": "block-lines",
      "type": "string",
      "enum": [
        "block-lines",
        "single-line"
      ]
    },
    "includeImageAlt": {
      "default": false,
      "type": "boolean"
    }
  },
  "required": [
    "html"
  ],
  "additionalProperties": false
}

Complete output-envelope schema

{
  "type": "object",
  "required": [
    "operation",
    "version",
    "result",
    "provenance"
  ],
  "properties": {
    "operation": {
      "const": "html-to-text",
      "type": "string"
    },
    "version": {
      "const": "0.29.0",
      "type": "string"
    },
    "result": {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "type": "object",
      "properties": {
        "text": {
          "type": "string",
          "maxLength": 200000
        },
        "codeUnits": {
          "type": "integer",
          "minimum": 0,
          "maximum": 200000
        },
        "discardedElements": {
          "type": "integer",
          "minimum": 0,
          "maximum": 100000
        },
        "mode": {
          "type": "string",
          "enum": [
            "block-lines",
            "single-line"
          ]
        }
      },
      "required": [
        "text",
        "codeUnits",
        "discardedElements",
        "mode"
      ],
      "additionalProperties": false
    },
    "provenance": {
      "type": "object",
      "required": [
        "inputSha256",
        "outputSha256",
        "deterministic",
        "externalRequests"
      ],
      "properties": {
        "inputSha256": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "outputSha256": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "deterministic": {
          "const": true
        },
        "externalRequests": {
          "const": 0
        }
      }
    }
  },
  "additionalProperties": false
}

Fixed example

One accepted fixed example, not a custom-input trial. No operation runs when this static page is requested.

Example input

{
  "html": "<h1>Report &amp; results</h1><p>Ready <strong>now</strong>.</p><script>alert(1)</script>",
  "mode": "block-lines"
}

Example response

{
  "operation": "html-to-text",
  "version": "0.29.0",
  "result": {
    "text": "Report & results\nReady now.",
    "codeUnits": 27,
    "discardedElements": 1,
    "mode": "block-lines"
  },
  "provenance": {
    "inputSha256": "deb645af679983a18b1236c8c18ec796a8bff4badfaafcafb798490132c40238",
    "outputSha256": "27d20e905eff93c0e09ad510a44fdff2bc51684c4132d5c34b74b2674a706e67",
    "deterministic": true,
    "externalRequests": 0
  }
}

Bounds and precision

JavaScript IEEE-754 numbers; use strings for large integer IDs/exact decimals where the schema accepts strings. No lossless numeric parsing.

{
  "global": {
    "requestBytes": 131072,
    "responseBytes": 524288,
    "jsonDepth": 32,
    "jsonNodes": 20000,
    "requestsPerMinute": 60,
    "paidAttemptsPerMinute": 20,
    "idempotencyHours": 24
  },
  "operation": {
    "requestBytes": 131072,
    "responseBytes": 524288,
    "jsonDepth": 32
  }
}

Complete schemas, descriptions and cross-field validation may impose additional limits.

Proposed price and protocol definitions

{
  "unit": "one successful operation call",
  "proposedNominalUsd": "0.005",
  "sixDecimalTokenBaseUnits": "5000",
  "subscription": false,
  "includesPayerWalletOrNetworkFees": false,
  "liveQuoteVerified": false,
  "condition": "Actual SDK challenge is authoritative only within the caller's explicit authorization; configured six-decimal token peg is an operator assertion, not a conversion guarantee."
}

Protocol definitions: x402, mpp. MPP uses Tempo charge. Paid MCP execution is unsupported. All runtime readiness is not evaluated in this build.

API path templates, not endpoints on this documentation host

{
  "x402": "/v1/x402/html-to-text",
  "mpp": "/v1/mpp/html-to-text"
}

Required headers

{
  "Content-Type": "application/json",
  "Idempotency-Key": "random 16–128 character operation identifier"
}

Actual SDK challenge amount, asset, network, recipient and wallet costs must pass independent authorization. Preserve identical key, body, protocol and credential on retries; on PAYMENT_UNCERTAIN stop and reconcile.

Execution profile and provider conditions

{
  "deterministic": true,
  "externalRequests": 0,
  "maxExternalRequests": 0,
  "resultSnapshotPersisted": false,
  "fixedExampleIsIllustrativeSnapshot": false,
  "requiresPayment": true,
  "supportsMcpExecution": false
}

Deterministic supplied-input operation with no external requests or stored request/result bodies. Payment infrastructure retains payment metadata and hashes.

Failure handling

HTTP 400: Malformed JSON, missing/invalid idempotency key, or payment identifier mismatch Correct the request before payment
HTTP 402: Payment challenge or rejected payment Use official protocol SDK; inspect payment outcome before another payment
HTTP 409: Idempotency conflict, duplicate proof, or PAYMENT_UNCERTAIN Keep original key, body, and proof; reconcile uncertainty with operator; never blindly repay
HTTP 413: Input or generated output too large Reduce input; no payment attempted for validation failure
HTTP 415: Unsupported media type or compression Send uncompressed application/json
HTTP 422: Schema or service-specific semantic validation failure Correct input using returned error code; no payment attempted
HTTP 429: Request/payment-attempt rate exceeded Wait for rate limit window; preserve existing payment identity
HTTP 503: Payment configuration/provider/state unavailable, or live DNS preparation failed before settlement Check readiness; DNS preparation failures may retry the identical key/body/credential only; uncertainty requires reconciliation

Declared requirements

Before any paid call, refresh the live operation contract and POST the complete bounded budgeted plan to the separate API's /preflight. Unknown requirements block selection; compatible preflight is not permission to spend.