HTML to Text API Documentation

The HTML to Text API allows you to convert HTML content into plain text format. It provides a simple and efficient way to extract textual data from HTML documents, web pages, or any HTML-encoded content.

Convert HTML to Text

Endpoint

POST /api/convert

This endpoint accepts a JSON payload with the HTML content and converts it to plain text.

Request Parameters

Example Request

POST /api/convert
Content-Type: application/json

{
  "html": "<h1>Hello, World!</h1><p>This is an example HTML content.</p>",
  "whitelist": ["h1", "p"]
}

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "text": "Hello, World! This is an example HTML content."
}

Error Responses

Usage Notes

• The API accurately parses HTML tags and extracts the textual data, excluding formatting and presentation elements.
• The whitelist parameter allows you to specify the HTML tags that should be included in the conversion process.
• The blacklist parameter allows you to specify the HTML tags that should be excluded from the conversion process.
• The response contains the converted plain text in the text field.

Code Samples

JavaScript (fetch)

fetch('https://api.example.com/api/convert', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    html: '<h1>Hello, World!</h1><p>This is an example HTML content.</p>',
    whitelist: ['h1', 'p']
  })
})
  .then(response =&gt; response.json())
  .then(data =&gt; {
    console.log(data.text);
  })
  .catch(error =&gt; {
    console.error(error);
  });