{
"ok": true,
"data": {
"original": "Café au Lait & Crème Brûlée!",
"slug": "cafe-au-lait-creme-brulee"
}
}
curl --location --request POST 'https://zylalabs.com/api/14954/text+slugify+and+readability+api/39176/generate+a+url+slug' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{"text":"Café au Lait & Crème Brûlée!"}'
{
"ok": true,
"data": {
"original": "hello world example",
"type": "camel",
"result": "helloWorldExample"
}
}
curl --location --request POST 'https://zylalabs.com/api/14954/text+slugify+and+readability+api/39177/convert+identifier+or+title+case' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{"text":"hello world example","type":"camel"}'
{
"ok": true,
"data": {
"characters": 23,
"charactersNoSpaces": 18,
"words": 6,
"sentences": 1,
"paragraphs": 1,
"syllables": 6,
"averageWordsPerSentence": 6,
"averageSyllablesPerWord": 1,
"fleschReadingEase": 116.15,
"fleschKincaidGrade": -1.45,
"readingTimeMinutes": 0.03,
"note": "Flesch scores use an English syllable heuristic. They are estimates, not a human readability assessment."
}
}
curl --location --request POST 'https://zylalabs.com/api/14954/text+slugify+and+readability+api/39178/count+words+characters+sentences+and+paragraphs' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{"text":"The cat sat on the mat."}'
{
"ok": true,
"data": {
"characters": 23,
"charactersNoSpaces": 18,
"words": 6,
"sentences": 1,
"paragraphs": 1,
"syllables": 6,
"averageWordsPerSentence": 6,
"averageSyllablesPerWord": 1,
"fleschReadingEase": 116.15,
"fleschKincaidGrade": -1.45,
"readingTimeMinutes": 0.03,
"note": "Flesch scores use an English syllable heuristic. They are estimates, not a human readability assessment."
}
}
curl --location --request POST 'https://zylalabs.com/api/14954/text+slugify+and+readability+api/39179/flesch+readability+scores' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{"text":"The cat sat on the mat."}'
{
"ok": true,
"data": {
"html": "<h1>Title</h1>\n<p>A <strong>bold</strong> line with a <a href=\"https://example.com\" rel=\"nofollow noopener noreferrer\">link</a>.</p>",
"note": "A conservative CommonMark-inspired subset: headings, lists, quotes, fenced code, emphasis, links (http/https/mailto only), and strikethrough. Raw HTML is escaped, not executed."
}
}
curl --location --request POST 'https://zylalabs.com/api/14954/text+slugify+and+readability+api/39180/convert+markdown+to+html' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{"markdown":"# Title\n\nA **bold** line with a [link](https://example.com)."}'
{
"ok": true,
"data": {
"emails": [
"[email protected]"
],
"urls": [
"https://example.com/docs"
],
"hashtags": [
"UtilityAPI"
]
}
}
curl --location --request POST 'https://zylalabs.com/api/14954/text+slugify+and+readability+api/39181/extract+text+data' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{"text":"Email [email protected] and see https://example.com/docs. Tagged #UtilityAPI."}'
After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Text Slugify and Readability API simply include your bearer token in the Authorization header.
| Header | Description |
|---|---|
Authorization
|
Required
Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.
|
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
Slugify Unicode text, convert case, score English readability, turn a conservative Markdown subset into HTML, and extract emails, URLs, and hashtags.
It transliterates common Latin characters and then applies Unicode NFKD so accents are stripped. For example, Café au Lait & Crème Brûlée! becomes cafe-au-lait-creme-brulee, and Straße becomes strasse.
No. They are estimates from an English syllable heuristic. They are a poor fit for text that is not English prose, and they are not a human readability assessment.
Headings, paragraphs, lists, block quotes, horizontal rules, fenced code, bold, italic, strikethrough, and links. Tables, footnotes, and raw HTML are not supported. Raw HTML is escaped.
No. Only http, https, and mailto targets are kept. Other schemes, including javascript:, are dropped, and the link label is left as plain text.
Camel, pascal, snake, kebab, constant, title, sentence, upper, and lower.
Emails, URLs that start with http or https, and hashtags. You can request any subset with the kinds array. Duplicates are removed.
Yes. Each text field is limited to 20,000 characters, and the JSON body must be at most 32 KiB. Larger bodies return HTTP 413.
Each endpoint returns a JSON object containing a status indicator (`ok`) and a `data` field with specific information. For example, the slugify endpoint returns the original text and the generated slug, while the readability endpoints return metrics like word count and Flesch scores.
Key fields include `original` (input text), `slug` (generated slug), `characters`, `words`, `sentences`, `syllables`, and readability scores like `fleschReadingEase`. Each endpoint has tailored fields relevant to its function.
The slugify endpoint accepts parameters such as `separator` (to customize the slug separator), `lowercase` (to enforce lowercase), `strict mode` (to limit character usage), and `maxLength` (to set a maximum length for the slug).
The response data is structured as a JSON object with two main fields: `ok`, indicating success, and `data`, which contains the relevant output. For example, the `data` field in the Markdown conversion endpoint includes the generated HTML and a note about supported features.
The readability endpoints provide metrics such as total characters, words, sentences, paragraphs, syllables, average words per sentence, average syllables per word, and Flesch readability scores, which help assess text complexity.
Users can customize requests by specifying the types of data to extract (emails, URLs, hashtags) using the `kinds` array. This allows for targeted extraction based on user needs, ensuring relevant results.
Typical use cases include converting user-generated content from Markdown to HTML for web display, ensuring safe rendering of text, and escaping raw HTML to prevent execution, making it suitable for blog posts or documentation.
Users can leverage the returned metrics, such as word count and Flesch scores, to evaluate text readability and structure. This information is useful for content creators aiming to optimize their writing for specific audiences or platforms.
To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
The free trial lasts for 7 days and allows you to make up to 50 API requests.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
You can monitor your API usage through the response headers included with every request:
x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.
Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.
Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund