HTML to Text API
Overview
To use HTML to Text, you need an API key. You can get one by creating a free account and visiting your dashboard.
POST Endpoint
https://api.apiverve.com/v1/htmltotextExample
How to call the HTML to Text API in different programming languages.
curl -X POST \
"https://api.apiverve.com/v1/htmltotext" \
-H "X-API-Key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"html": "<!doctype html> <html> <head> <title>This is the title of the webpage!</title> </head> <body> <p>This is an example paragraph. Anything in the <strong>body</strong> tag will appear on the page, just like this <strong>p</strong> tag and its contents.</p> </body> </html>"
}'const response = await fetch('https://api.apiverve.com/v1/htmltotext', {
method: 'POST',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
},
body: JSON.stringify({
"html": "<!doctype html> <html> <head> <title>This is the title of the webpage!</title> </head> <body> <p>This is an example paragraph. Anything in the <strong>body</strong> tag will appear on the page, just like this <strong>p</strong> tag and its contents.</p> </body> </html>"
})
});
const data = await response.json();
console.log(data);import requests
headers = {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
payload = {
"html": "<!doctype html> <html> <head> <title>This is the title of the webpage!</title> </head> <body> <p>This is an example paragraph. Anything in the <strong>body</strong> tag will appear on the page, just like this <strong>p</strong> tag and its contents.</p> </body> </html>"
}
response = requests.post('https://api.apiverve.com/v1/htmltotext', headers=headers, json=payload)
data = response.json()
print(data)package main
import (
"fmt"
"io"
"net/http"
"bytes"
"encoding/json"
)
func main() {
payload := map[string]interface{}{
"html": "<!doctype html> <html> <head> <title>This is the title of the webpage!</title> </head> <body> <p>This is an example paragraph. Anything in the <strong>body</strong> tag will appear on the page, just like this <strong>p</strong> tag and its contents.</p> </body> </html>"
}
jsonPayload, _ := json.Marshal(payload)
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/htmltotext", bytes.NewBuffer(jsonPayload))
req.Header.Set("X-API-Key", "your_api_key_here")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}{
"status": "ok",
"error": null,
"data": {
"text": "This is an example paragraph. Anything in the body tag will appear on the page, just like this p tag and its contents.",
"parsed": true,
"detectedLanguage": {
"language": "english",
"confidence": 0.3507446808510638
},
"characterCount": 118,
"wordCount": 22
}
}Authentication
The HTML to Text API requires authentication via API key. Include your API key in the request header:
X-API-Key: your_api_key_hereInteractive API Playground
Test the HTML to Text API directly in your browser with live requests and responses.
Parameters
The following parameters are available for the HTML to Text API:
Convert HTML to Text
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
html | string | required | The HTML to convert to text | - |
Response
The HTML to Text API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.
Other Response Formats
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>ok</status>
<error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<data>
<text>This is an example paragraph. Anything in the body tag will appear on the page, just like this p tag and its contents.</text>
<parsed>true</parsed>
<detectedLanguage>
<language>english</language>
<confidence>0.3507446808510638</confidence>
</detectedLanguage>
<characterCount>118</characterCount>
<wordCount>22</wordCount>
</data>
</response>
status: ok
error: null
data:
text: >-
This is an example paragraph. Anything in the body tag will appear on the
page, just like this p tag and its contents.
parsed: true
detectedLanguage:
language: english
confidence: 0.3507446808510638
characterCount: 118
wordCount: 22
| key | value |
|---|---|
| text | This is an example paragraph. Anything in the body tag will appear on the page, just like this p tag and its contents. |
| parsed | true |
| detectedLanguage | {language:english,confidence:0.3507446808510638} |
| characterCount | 118 |
| wordCount | 22 |
Response Structure
All API responses follow a consistent structure with the following fields:
| Field | Type | Description | Example |
|---|---|---|---|
status | string | Indicates whether the request was successful ("ok") or failed ("error") | ok |
error | string | null | Contains error message if status is "error", otherwise null | null |
data | object | null | Contains the API response data if successful, otherwise null | {...} |
Learn more about response formats →
Response Data Fields
When the request is successful, the data object contains the following fields:
| Field | Type | Sample Value | Description |
|---|---|---|---|
text | string | - | |
parsed | boolean | - | |
detectedLanguagePremium | object | Detected language with confidence score | |
â”” language | string | - | |
â”” confidence | number | - | |
characterCount | number | Number of characters in extracted text | |
wordCount | number | Number of words in extracted text |
Headers
Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →
GraphQL AccessALPHA
Access HTML to Text through GraphQL to combine it with other API calls in a single request. Query only the html to text data you need with precise field selection, and orchestrate complex data fetching workflows.
Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.
POST https://api.apiverve.com/v1/graphqlquery {
htmltotext(
input: {
html: "<!doctype html> <html> <head> <title>This is the title of the webpage!</title> </head> <body> <p>This is an example paragraph. Anything in the <strong>body</strong> tag will appear on the page, just like this <strong>p</strong> tag and its contents.</p> </body> </html>"
}
) {
text
parsed
detectedLanguage {
language
confidence
}
characterCount
wordCount
}
}Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.
CORS Support
The HTML to Text API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →
Rate Limiting
HTML to Text requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →
Error Codes
The HTML to Text API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →
SDKs for HTML to Text
Official HTML to Text packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →
No-Code Integrations
HTML to Text works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →
Frequently Asked Questions
How do I get an API key for HTML to Text?
How many credits does HTML to Text cost?
Each successful HTML to Text API call consumes credits based on plan tier. Check the pricing section above for the exact credit cost. Failed requests and errors don't consume credits, so you only pay for successful html to text lookups.
Can I use HTML to Text in production?
The free plan is for testing and development only. For production use of HTML to Text, upgrade to a paid plan (Starter, Pro, or Mega) which includes commercial use rights, no attribution requirements, and guaranteed uptime SLAs. All paid plans are production-ready.
Can I use HTML to Text from a browser?
What happens if I exceed my HTML to Text credit limit?
When you reach your monthly credit limit, HTML to Text API requests will return an error until you upgrade your plan or wait for the next billing cycle. You'll receive notifications at 80% and 95% usage to give you time to upgrade if needed.
People who used this also used...
Based on your interest in HTML to Text, you might also like these APIs:
