Skip to content
moxon home

Text

The /text endpoint provides text manipulation and generation utilities.

gethttps://api.moxon.dev/v6/text
Try itget/v6/text

Parameters

  • methodstringrequired

    Text method (see available methods below)

    • stats
    • slug
    • lorem
    • number
  • valuestringoptional

    Source text (required for stats, slug, number)

  • type"words" | "sentences" | "paragraphs"optional

    Lorem type: words, sentences, paragraphs

  • countnumberoptional

    Number of elements for lorem (1–500, default: 5)

  • lang"en" | "fr"optional

    Language for number: en or fr

Available Methods

MethodDescriptionRequired Parameters
statsText statisticsvalue
slugConvert to URL slugvalue
loremGenerate Lorem Ipsumtype, count
numberNumber to wordsvalue, lang

Response Fields

  • methodstring

    The text method used

  • resultstring|object

    The processed result

When using stats, the result field is an object with the following properties:

  • charactersnumber

    Total number of characters

  • charactersNoSpacesnumber

    Number of characters excluding spaces

  • wordsnumber

    Number of words

  • sentencesnumber

    Number of sentences

  • paragraphsnumber

    Number of paragraphs

  • readingTimestring

    Estimated reading time

  • mostFrequentCharstring

    Most frequently used character

For number, the maximum supported value is 999,999,999.

Code Examples

Error Handling

If parameters are missing or invalid, the API will return an error:

  • 400Please provide a valid method (?method={slug|stats|lorem|number})The method parameter is missing or invalid
  • 400A value is requiredThe value parameter is missing when required