Skip to main content
POST
/
generic
/
data
/
generate
/
word
Generate synthetic word data
curl --request POST \
  --url https://apix.spotzee.com/api/ext/generic/data/generate/word \
  --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 length=5 \
  --data lengthMin=5 \
  --data lengthMax=7 \
  --data strategy=any-length \
  --data wordCount=5 \
  --data wordCountMin=5 \
  --data wordCountMax=10
{
  "status": "success",
  "data": {
    "words": [
      {
        "method": "profile",
        "value": "incidentally",
        "adjective": "pungent",
        "adverb": "quarrelsomely",
        "conjunction": "since",
        "interjection": "gah",
        "noun": "external",
        "preposition": "without",
        "sample": "incidentally",
        "verb": "act",
        "words": "before hourly patiently dribble equal",
        "length": 5,
        "strategy": "any-length",
        "wordCount": 5
      }
    ],
    "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 word 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>

Word generation method. Defaults to profile.

Available options:
profile,
adjective,
adverb,
conjunction,
interjection,
noun,
preposition,
sample,
verb,
words
Example:

"profile"

​
length
string

Exact expected word length for single-word methods or profile output. Range: 1-100.

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

"5"

​
lengthMin
string

Minimum expected word length for single-word methods or profile output. Range: 1-100.

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

"5"

​
lengthMax
string

Maximum expected word length for single-word methods or profile output. Range: 1-100.

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

"7"

​
strategy
enum<string>

Word-length fallback strategy for single-word methods or profile output.

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

"any-length"

​
wordCount
string

Exact number of words for words or profile output. Range: 1-50.

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

"5"

​
wordCountMin
string

Minimum number of words for words or profile output. Range: 1-50.

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

"5"

​
wordCountMax
string

Maximum number of words for words or profile output. Range: 1-50.

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

"10"

Response

Successfully generated word data

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