{
"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."}'
Após se cadastrar, cada desenvolvedor recebe uma chave de acesso à API pessoal, uma combinação única de letras e dígitos para acessar nosso endpoint de API. Para autenticar com a Texto Slugify e Legibilidade API basta incluir seu token Bearer no cabeçalho Authorization.
| Cabeçalho | Descrição |
|---|---|
Authorization
|
Obrigatório
Deve ser Bearer access_key. Veja "Sua chave de acesso à API" acima quando você estiver inscrito.
|
Sem compromisso de longo prazo. Faça upgrade, downgrade ou cancele a qualquer momento. O teste gratuito inclui até 50 requisições.
Translitera caracteres latinos comuns e depois aplica NFKD do Unicode para que os acentos sejam removidos Por exemplo Café au Lait & Crème Brûlée! se torna cafe-au-lait-creme-brulee e Straße se torna strasse
Não. Eles são estimativas de uma heurística de sílabas em inglês. Eles não se encaixam bem em textos que não são prosa em inglês e não são uma avaliação de legibilidade humana
Títulos parágrafos listas citações em bloco regras horizontais código cercado negrito itálico riscado e links. Tabelas notas de rodapé e HTML bruto não são suportados. HTML bruto é escapado
Não Apenas destinos http https e mailto são mantidos Outros esquemas incluindo javascript: são descartados e o rótulo do link é deixado como texto simples
Camel, pascal, snake, kebab, constante, título, frase, maiúsculo, e minúsculo
Emails URLs que começam com http ou https e hashtags Você pode solicitar qualquer subconjunto com o array de tipos Duplicatas são removidas
Sim Cada campo de texto é limitado a 20.000 caracteres e o corpo JSON deve ter no máximo 32 KiB Corpos maiores retornam HTTP 413
Cada endpoint retorna um objeto JSON contendo um indicador de status (`ok`) e um campo `data` com informações específicas Por exemplo o endpoint slugify retorna o texto original e o slug gerado enquanto os endpoints de legibilidade retornam métricas como contagem de palavras e pontuações de Flesch
Os campos principais incluem `original` (texto de entrada), `slug` (slug gerado), `caracteres`, `palavras`, `frases`, `sílabas` e pontuações de legibilidade como `fleschReadingEase` Cada endpoint tem campos personalizados relevantes para sua função
O endpoint slugify aceita parâmetros como `separator` (para personalizar o separador do slug), `lowercase` (para forçar letras minúsculas), `strict mode` (para limitar o uso de caracteres) e `maxLength` (para definir um comprimento máximo para o slug)
Os dados da resposta estão estruturados como um objeto JSON com dois campos principais: `ok`, indicando sucesso, e `data`, que contém a saída relevante. Por exemplo, o campo `data` no endpoint de conversão Markdown inclui o HTML gerado e uma nota sobre os recursos suportados
Os endpoints de legibilidade fornecem métricas como total de caracteres, palavras, frases, parágrafos, sílabas, palavras médias por frase, sílabas médias por palavra e pontuações de legibilidade de Flesch que ajudam a avaliar a complexidade do texto
Os usuários podem personalizar solicitações especificando os tipos de dados a serem extraídos (emails, URLs, hashtags) usando o array `kinds` Isso permite uma extração direcionada com base nas necessidades do usuário garantindo resultados relevantes
Casos de uso típicos incluem a conversão de conteúdo gerado pelo usuário de Markdown para HTML para exibição na web garantindo a renderização segura do texto e escapando HTML bruto para prevenir execução tornando-o adequado para postagens de blog ou documentação
Os usuários podem aproveitar as métricas retornadas, como contagem de palavras e pontuações de Flesch, para avaliar a legibilidade e a estrutura do texto Essa informação é útil para criadores de conteúdo que visam otimizar sua escrita para públicos ou plataformas específicas