Skip to main content
POST
/
generic
/
data
/
generate
/
lorem
Generate synthetic text data
curl --request POST \
  --url https://apix.spotzee.com/api/ext/generic/data/generate/lorem \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data count=10 \
  --data locale=en \
  --data seed=12345 \
  --data method=profile \
  --data lineCount=3 \
  --data lineCountMin=1 \
  --data lineCountMax=5 \
  --data sentenceCount=3 \
  --data sentenceCountMin=2 \
  --data sentenceCountMax=6 \
  --data paragraphCount=3 \
  --data paragraphCountMin=1 \
  --data paragraphCountMax=3 \
  --data wordCount=5 \
  --data wordCountMin=3 \
  --data wordCountMax=10 \
  --data wordLength=5 \
  --data wordLengthMin=4 \
  --data wordLengthMax=8 \
  --data strategy=any-length \
  --data 'separator=\n'
{
  "status": "success",
  "data": {
    "lorem": [
      {
        "method": "profile",
        "value": "Doloribus autem non quis vero quia.",
        "word": "temporibus",
        "words": "qui praesentium pariatur",
        "sentence": "Laborum voluptatem officiis est et.",
        "sentences": "First generated sentence. Second generated sentence.",
        "paragraph": "Non architecto nam unde sint. Ex tenetur dolor facere optio aut consequatur.",
        "paragraphs": "First paragraph.\\nSecond paragraph.",
        "lines": "Rerum quia aliquam pariatur.\\nVoluptatem repellat consequatur.",
        "slug": "dolores-illo-est",
        "text": "Doloribus autem non quis vero quia.",
        "wordCount": 5,
        "sentenceCount": 3,
        "paragraphCount": 2,
        "separator": "\\n"
      }
    ],
    "generated": 1,
    "locale": "en",
    "seed": 12345,
    "method": "profile"
  },
  "performance": {
    "generationTime": 2,
    "itemsGenerated": 1,
    "locale": "en"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.spotzee.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Use format: Bearer YOUR_API_KEY

Body

application/x-www-form-urlencoded
​
count
string

Number of text records to generate (1-100). Passed as string but must be numeric.

Pattern: ^[1-9]\d?$|^100$
Example:

"10"

​
locale
string

Locale for generated data (e.g., en, es, fr, de, pt_BR, zh_CN)

Example:

"en"

​
seed
string

Seed for deterministic generation. Same seed produces same results.

Example:

"12345"

​
method
enum<string>

Text generation method. Defaults to profile.

Available options:
profile,
lines,
paragraph,
paragraphs,
sentence,
sentences,
slug,
text,
word,
words
Example:

"profile"

​
lineCount
string

Exact number of lines for lines or profile output. Range: 1-20.

Pattern: ^[1-9]\d*$
Example:

"3"

​
lineCountMin
string

Minimum line count for lines or profile output. Range: 1-20.

Pattern: ^[1-9]\d*$
Example:

"1"

​
lineCountMax
string

Maximum line count for lines or profile output. Range: 1-20.

Pattern: ^[1-9]\d*$
Example:

"5"

​
sentenceCount
string

Exact sentence count for paragraph, sentences, or profile output. Range: 1-20.

Pattern: ^[1-9]\d*$
Example:

"3"

​
sentenceCountMin
string

Minimum sentence count for paragraph, sentences, or profile output. Range: 1-20.

Pattern: ^[1-9]\d*$
Example:

"2"

​
sentenceCountMax
string

Maximum sentence count for paragraph, sentences, or profile output. Range: 1-20.

Pattern: ^[1-9]\d*$
Example:

"6"

​
paragraphCount
string

Exact paragraph count for paragraphs or profile output. Range: 1-5.

Pattern: ^[1-9]\d*$
Example:

"3"

​
paragraphCountMin
string

Minimum paragraph count for paragraphs or profile output. Range: 1-5.

Pattern: ^[1-9]\d*$
Example:

"1"

​
paragraphCountMax
string

Maximum paragraph count for paragraphs or profile output. Range: 1-5.

Pattern: ^[1-9]\d*$
Example:

"3"

​
wordCount
string

Exact word count for sentence, slug, words, or profile output. Range: 1-50.

Pattern: ^[1-9]\d*$
Example:

"5"

​
wordCountMin
string

Minimum word count for sentence, slug, words, or profile output. Range: 1-50.

Pattern: ^[1-9]\d*$
Example:

"3"

​
wordCountMax
string

Maximum word count for sentence, slug, words, or profile output. Range: 1-50.

Pattern: ^[1-9]\d*$
Example:

"10"

​
wordLength
string

Exact word length for word or profile output. Range: 1-14.

Pattern: ^[1-9]\d*$
Example:

"5"

​
wordLengthMin
string

Minimum word length for word or profile output. Range: 1-14.

Pattern: ^[1-9]\d*$
Example:

"4"

​
wordLengthMax
string

Maximum word length for word or profile output. Range: 1-14.

Pattern: ^[1-9]\d*$
Example:

"8"

​
strategy
enum<string>

Word-length fallback strategy for word or profile output.

Available options:
fail,
closest,
shortest,
longest,
any-length
Example:

"any-length"

​
separator
string

Separator for sentences, paragraphs, or profile output. Maximum 16 characters.

Maximum string length: 16
Example:

"\\n"

Response

Successfully generated text data

​
status
enum<string>
required
Available options:
success
​
data
object
required
​
performance
object