Quick Start

Get up and running with Text Analysis Toolkit API in under a minute.

1. Get your API key

2. Analyse readability

Send a POST request with any text to get Flesch, Gunning Fog, SMOG, and other readability scores instantly.

curl -X POST "https://textanalysis.toolkitapi.io/v1/text/readability" \
  -H "X-API-Key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text": "The quick brown fox jumps over the lazy dog."}'

import httpx

resp = httpx.post(
    "https://textanalysis.toolkitapi.io/v1/text/readability",
    headers={"X-API-Key": "YOUR_KEY"},
    json={"text": "The quick brown fox jumps over the lazy dog."},
)
result = resp.json()
print(result["scores"]["flesch_reading_ease"], result["interpretation"]["level"])

const resp = await fetch("https://textanalysis.toolkitapi.io/v1/text/readability", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": "YOUR_KEY",
  },
  body: JSON.stringify({ text: "The quick brown fox jumps over the lazy dog." }),
});
const data = await resp.json();
console.log(data.scores.flesch_reading_ease, data.interpretation.level);

3. Mask sensitive data

Automatically redact emails, phone numbers, credit card numbers, and other PII from any text body.

curl -X POST "https://textanalysis.toolkitapi.io/v1/text/mask" \
  -H "X-API-Key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text": "Call me at 555-867-5309 or email [email protected]"}'

resp = httpx.post(
    "https://textanalysis.toolkitapi.io/v1/text/mask",
    headers={"X-API-Key": "YOUR_KEY"},
    json={"text": "Call me at 555-867-5309 or email [email protected]"},
)
result = resp.json()
print(result["masked_text"], result["matches_found"])

const resp = await fetch("https://textanalysis.toolkitapi.io/v1/text/mask", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": "YOUR_KEY",
  },
  body: JSON.stringify({ text: "Call me at 555-867-5309 or email [email protected]" }),
});
const data = await resp.json();
console.log(data.masked_text, data.matches_found);

4. Detect language

Submit any snippet and receive the detected language code and confidence score.

curl -X POST "https://textanalysis.toolkitapi.io/v1/text/detect-language" \
  -H "X-API-Key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text": "Bonjour le monde, comment allez-vous?"}'

resp = httpx.post(
    "https://textanalysis.toolkitapi.io/v1/text/detect-language",
    headers={"X-API-Key": "YOUR_KEY"},
    json={"text": "Bonjour le monde, comment allez-vous?"},
)
result = resp.json()
print(result["language"], result["confidence"])

const resp = await fetch("https://textanalysis.toolkitapi.io/v1/text/detect-language", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": "YOUR_KEY",
  },
  body: JSON.stringify({ text: "Bonjour le monde, comment allez-vous?" }),
});
const data = await resp.json();
console.log(data.language, data.confidence);

5. Explore all endpoints

Browse the full tool listing to discover all 9 endpoints — including word frequency, text similarity, diff, summarisation, profanity filtering, and transliteration.