Skip to main content

Squillify development is paused indefinitely. Read why, and discover what this experiment achieved. Read the story

MicroSkills Reference

Readability Analyzer

text.measure_readability

ProductionHeuristic (Class C)Deterministicbest-effortfastv1.0.0
File inputNo network

Overview

Computes readability scores using configurable formulas. Language scope differs per formula: Flesch Reading Ease and Flesch-Kincaid Grade are syllable-based and calibrated for ENGLISH only (syllable estimation uses an English heuristic requiring explicit opt-in); Automated Readability Index and Coleman-Liau are character/word-based and less English-specific but still calibrated on English corpora. Scores are indices, not verified reading levels. Accepts file input via file_ref — no need to extract file content first.

Readability scores depend on exact word, sentence, and syllable counts — we apply published formulas so your numbers are defensible, not estimated.

Reliability

BEST_EFFORT for syllable-based formulas when allow_heuristic_syllables is true (heuristic syllable estimation). Character-based formulas (ARI, Coleman-Liau) are VERIFIABLE on this deployment. Flesch formulas are skipped when allow_heuristic_syllables is false (default). Input validation (not retryable): unsupported formula name; text or file_ref missing.

Context footprint

Accepts inline text up to 1M chars or file input via file_ref (up to 2 MB). Upload files via POST /v1/files/upload before passing file_ref. Single call replaces multi-step LLM computation that would need word counts, sentence counts, syllable estimates, and formula application. A successful call costs 1 execution credit.

When to use it

When you need numeric readability indices (Flesch, Flesch-Kincaid, ARI, Coleman-Liau) and want to choose which formulas to compute.

Do not use for non-English syllable-based scoring (heuristic is English-only) or subjective writing-quality judgment.

Scope

Note
We compute readability scores from your text using explicit formulas (Flesch, Flesch-Kincaid, ARI, Coleman-Liau) with transparent component reporting.

Non-goals

  • Does not provide reading level labels or grade-band classifications
  • Does not support non-English syllable counting natively
  • Does not assess writing quality, clarity, or style

Properties

IdempotentRetry safeStreaming supportedFile input supportedRequires external service

Capabilities

analysistext-processing

Cost & billing

Flat rate per invocation

MetercallsBillable onsuccessCost per call1 credit

File handling

Accepts file_refProduces file_refMax input976.6 KBMax file size1.9 MB

File limits

Constraints this skill applies to your input and generated files. The “Limited by” column shows the static source of each cap; none of these can be raised by upgrading your plan.

LimitValueLimited by
Maximum size per input file1.9 MiBSkill maximum

How we handle your data

Sensitive input, safe output
What this means

This skill may receive sensitive content, but it does not target sensitive data and returns only a structured non-sensitive result.

Squillify guarantees
  • Runs inside Squillify
  • This skill runs inside Squillify.
  • Payloads are not sent to an external service by this skill.
  • Squillify does not permanently store submitted payloads.
  • Telemetry records metadata only, not submitted content.
  • Submitted payloads are not used for training.
  • Submitted payloads are not reviewed by humans.
  • This skill does not target sensitive data.
  • The response does not contain submitted content.
Your responsibility

Squillify does not determine whether submitted content is sensitive. Your application is responsible for deciding what data it is allowed to submit. Your application is responsible for securing the response.

Read the Microskill Data Handling Policy

Input schema

FieldTypeRequiredDescription
textstringNoInline text up to one million characters; required unless file_ref is supplied.
file_refstringNoTenant-scoped managed text file up to 2 MB; required unless text is supplied.
localestringNoBCP 47 segmentation locale.
formulasarrayNoFrom 0 through 100 supported formula-name strings; empty or omission means all supported formulas.
allow_heuristic_syllablesbooleanNoWhether English heuristic syllable estimates may be used.
return_detailsbooleanNoWhether successful formula results include component counts.

Output schema

FieldTypeRequiredDescription
skillstringYesStable skill key, always text.measure_readability.
unitstringYesScore unit, always readability_score.
policystringYesApplied scoring policy, always formula_based.
localestringYesLanguage tag used for segmentation.
formulasarrayYesFrom 0 through 100 closed computed-score or insufficient-text objects in requested order.
warningsarrayYesFrom 0 through 10 non-fatal syllable-estimation and formula-caveat strings.

API contract

POST /v1/execute
curl
curl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"text.measure_readability","input":{"text":"The quick brown fox jumps over the lazy dog.","allow_heuristic_syllables":true}}'
Integrations
TypeScript SDK
import { Squillify } from "@squillify/sdk";

const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });

const { output } = await sq.execute("text.measure_readability", {"text":"Kubernetes orchestrates containerized applications across clusters of machines. It automates deployment, scaling, and management of containerized workloads and services.","formulas":["flesch_reading_ease"],"allow_heuristic_syllables":true,"return_details":false});

Errors

CodeHTTPRetryableDescription
VALIDATION_ERROR400NoThe request payload failed schema validation.
UNAUTHORIZED401NoMissing or invalid API key.
SKILL_NOT_ACCESSIBLE403NoThe API key is not granted access to this skill.
SKILL_NOT_AVAILABLE_FOR_PLAN403NoThis skill is not included in your current plan.
PLAN_ELIGIBILITY_UNAVAILABLE503YesPlan eligibility could not be decided. Retry after backoff.
SKILL_NOT_FOUND404NoThe requested skill or version does not exist.
TENANT_RATE_LIMITED429YesRequest rate limit exceeded. Retry after backoff.
QUOTA_EXCEEDED429YesPlan quota exhausted. Retryable once the quota period resets.
EXECUTION_TIMEOUT504YesExecution exceeded the allowed time budget.

Other limits

LimitValue
Recommended inline bytes32 KiB

Limitations

  • Does not provide reading level labels or grade-band classifications
  • Does not support non-English syllable counting natively
  • Does not assess writing quality, clarity, or style
  • Non-English readability (syllable heuristic is English-only)
  • Literary or stylistic analysis
  • Writing quality assessment (use a human reviewer)

How to call

POST /v1/execute (requires authentication)

Request bodyjson
{
  "skillKey": "text.measure_readability",
  "input": {
    "text": "Kubernetes orchestrates containerized applications across clusters of machines. It automates deployment, scaling, and management of containerized workloads and services.",
    "formulas": [
      "flesch_reading_ease"
    ],
    "allow_heuristic_syllables": true,
    "return_details": false
  }
}

Examples

Assess technical documentation

Inputjson
{
  "text": "Kubernetes orchestrates containerized applications across clusters of machines. It automates deployment, scaling, and management of containerized workloads and services.",
  "formulas": [
    "flesch_reading_ease"
  ],
  "allow_heuristic_syllables": true,
  "return_details": false
}
Expected outputjson
{
  "skill": "text.measure_readability",
  "policy": "formula_based",
  "formulas": [
    {
      "name": "flesch_reading_ease",
      "score": -34.3,
      "reliability": "BEST_EFFORT"
    }
  ],
  "locale": "en-US",
  "warnings": [
    "Syllable count is estimated heuristically for locale en-US. Readability score is approximate."
  ],
  "unit": "readability_score"
}
Tip
Technical content with complex vocabulary scores low — college-level difficulty

Simple narrative prose

Inputjson
{
  "text": "The sun rose over the hills. Birds sang in the trees. A gentle breeze blew through the open window.",
  "formulas": [
    "flesch_reading_ease"
  ],
  "allow_heuristic_syllables": true,
  "return_details": false
}
Expected outputjson
{
  "skill": "text.measure_readability",
  "policy": "formula_based",
  "formulas": [
    {
      "name": "flesch_reading_ease",
      "score": 93.5,
      "reliability": "BEST_EFFORT"
    }
  ],
  "locale": "en-US",
  "warnings": [
    "Syllable count is estimated heuristically for locale en-US. Readability score is approximate."
  ],
  "unit": "readability_score"
}
Tip
Simple sentences score high — 5th grade reading level

Character-based score from an uploaded document

Inputjson
{
  "return_details": false,
  "formulas": [
    "coleman_liau_index"
  ],
  "file_ref": "squillify://files/f-9c2b41ea"
}
Expected outputjson
{
  "skill": "text.measure_readability",
  "policy": "formula_based",
  "formulas": [
    {
      "name": "coleman_liau_index",
      "score": 11.4,
      "reliability": "VERIFIABLE"
    }
  ],
  "locale": "en-US",
  "warnings": [],
  "unit": "readability_score"
}
Tip
Coleman-Liau needs no syllables, so it runs without opting into the estimator
  • Content complexity assessment for editorial workflows
  • Grade-level targeting for educational content
  • Accessibility compliance checking
  • Pre-publish readability gating in content pipelines

Avoid for

  • Non-English readability (syllable heuristic is English-only)
  • Literary or stylistic analysis
  • Writing quality assessment (use a human reviewer)

Composable with

Safety & privacy

  • Runs without calling any external service.
  • Your payloads are never stored permanently.
  • Telemetry captures metadata only — never your payload contents.
  • We never train models on your payloads.
  • No human reviews your payloads.

Tags

textanalysisstatistics