▣ SEO

Basic Text Analysis API

What it does

Text Analysis helps you measure and summarize plain text in one request. Send text, optionally set a reading speed with wpm, and get back word, sentence, syllable, character, and unique-word counts plus readability and timing data.

Use it when you need to score article draft difficulty, estimate how long a passage will take to read or speak, or extract the most common keywords from user-submitted content. The response includes counts, averages, readability, top_keywords, and time_estimates, so you can feed the results straight into content dashboards, editorial workflows, or review systems.

The readability output includes a plain-language interpretation along with Flesch Reading Ease and Flesch-Kincaid Grade values. The timing estimates give you reading and speaking seconds based on the text and your chosen wpm value.

Text Analysis is a good fit anywhere you need quick linguistic statistics without building your own parser or readability calculator.

POST

Analyze text for readability, statistics, reading time, and keywords.

https://api.eu.apyhub.com/creightonnick0/analyze-text

QUICKSTART

GUIDE

Quickstart

Analyze a piece of text by sending it in the request body.

curl -X POST "https://api.eu.apyhub.com/creightonnick0/analyze-text" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"text":"The quick brown fox jumps over the lazy dog."}'

What you'll get back

Returns a JSON object with these top-level fields, as available: counts object, averages object, readability object, top_keywords array, and time_estimates object.

{
  "counts": {
    "words": 9,
    "sentences": 1,
    "syllables": 11,
    "characters": 44,
    "unique_words": 8,
    "characters_no_spaces": 35
  },
  "averages": {
    "syllables_per_word": 1.22,
    "words_per_sentence": 9,
    "characters_per_word": 3.89
  },
  "readability": {
    "interpretation": "Easy to read",
    "flesch_reading_ease": 94.3,
    "flesch_kincaid_grade": 3.1
  },
  "top_keywords": [
    {
      "word": "quick",
      "count": 1
    }
  ],
  "time_estimates": {
    "reading_seconds": 3.0,
    "speaking_seconds": 4.5
  }
}

TRY ITLIVE · 10 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Analyzes the submitted text and returns readability metrics, text statistics, keyword counts, and estimated reading/speaking time. You can also provide a words-per-minute value to adjust the reading time estimate.

Request Body

Parameter	Type	Mandatory	Description
text	String	Yes	The text to analyze.
wpm	Integer	No	Reading speed for the time estimate. Default: 200.

Response

Returns a JSON object with counts, averages, readability, top_keywords, and time_estimates fields. counts, averages, readability, and time_estimates are objects; top_keywords is an array of objects. Success status code: 200.

Parameter	Type	Mandatory	Description
counts	Object	No	Text statistics.<br>Includes `words`, `sentences`, `syllables`, `characters`, `unique_words`, and `characters_no_spaces` as integer fields.
counts.words	Integer	No	Number of words.
counts.sentences	Integer	No	Number of sentences.
counts.syllables	Integer	No	Number of syllables.
counts.characters	Integer	No	Number of characters.
counts.unique_words	Integer	No	Number of unique words.
counts.characters_no_spaces	Integer	No	Number of characters excluding spaces.
averages	Object	No	Averages derived from the submitted text.<br>Includes `syllables_per_word`, `words_per_sentence`, and `characters_per_word` as number fields.
averages.syllables_per_word	Number	No	Syllables per word.
averages.words_per_sentence	Number	No	Words per sentence.
averages.characters_per_word	Number	No	Characters per word.
readability	Object	No	Readability metrics.<br>Includes `interpretation`, `flesch_reading_ease`, and `flesch_kincaid_grade`.
readability.interpretation	String	No	Readability interpretation.
readability.flesch_reading_ease	Number	No	Flesch Reading Ease score.
readability.flesch_kincaid_grade	Number	No	Flesch-Kincaid grade level.
top_keywords	Object Array	No	Array of keyword objects.<br>Each item includes `word` and `count`.
top_keywords[].word	String	No	Keyword text.
top_keywords[].count	Integer	No	Number of occurrences for the keyword.
time_estimates	Object	No	Estimated times based on the analyzed text.<br>Includes `reading_seconds` and `speaking_seconds` as number fields.
time_estimates.reading_seconds	Number	No	Estimated reading time in seconds.
time_estimates.speaking_seconds	Number	No	Estimated speaking time in seconds.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.