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

import requests

url = "https://apix.spotzee.com/api/ext/generic/data/generate/word"

payload = {
    "count": "10",
    "locale": "en",
    "seed": "12345",
    "method": "profile",
    "length": "5",
    "lengthMin": "5",
    "lengthMax": "7",
    "strategy": "any-length",
    "wordCount": "5",
    "wordCountMin": "5",
    "wordCountMax": "10"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: new URLSearchParams({
    count: '10',
    locale: 'en',
    seed: '12345',
    method: 'profile',
    length: '5',
    lengthMin: '5',
    lengthMax: '7',
    strategy: 'any-length',
    wordCount: '5',
    wordCountMin: '5',
    wordCountMax: '10'
  })
};

fetch('https://apix.spotzee.com/api/ext/generic/data/generate/word', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://apix.spotzee.com/api/ext/generic/data/generate/word"

	payload := strings.NewReader("count=10&locale=en&seed=12345&method=profile&length=5&lengthMin=5&lengthMax=7&strategy=any-length&wordCount=5&wordCountMin=5&wordCountMax=10")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "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"
  }
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

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

import requests

url = "https://apix.spotzee.com/api/ext/generic/data/generate/word"

payload = {
    "count": "10",
    "locale": "en",
    "seed": "12345",
    "method": "profile",
    "length": "5",
    "lengthMin": "5",
    "lengthMax": "7",
    "strategy": "any-length",
    "wordCount": "5",
    "wordCountMin": "5",
    "wordCountMax": "10"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: new URLSearchParams({
    count: '10',
    locale: 'en',
    seed: '12345',
    method: 'profile',
    length: '5',
    lengthMin: '5',
    lengthMax: '7',
    strategy: 'any-length',
    wordCount: '5',
    wordCountMin: '5',
    wordCountMax: '10'
  })
};

fetch('https://apix.spotzee.com/api/ext/generic/data/generate/word', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://apix.spotzee.com/api/ext/generic/data/generate/word"

	payload := strings.NewReader("count=10&locale=en&seed=12345&method=profile&length=5&lengthMin=5&lengthMax=7&strategy=any-length&wordCount=5&wordCountMin=5&wordCountMax=10")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "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"
  }
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

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

Hide child attributes

data.words

object[]

required

Hide child attributes

data.words.method

enum<string>

required

Resolved word generation method.

Available options:

profile,

adjective,

adverb,

conjunction,

interjection,

noun,

preposition,

sample,

verb,

words

Example:

"profile"

data.words.value

string

required

Primary generated word fixture value.

Example:

"incidentally"

data.words.adjective

string

Generated adjective.

Example:

"pungent"

data.words.adverb

string

Generated adverb.

Example:

"quarrelsomely"

data.words.conjunction

string

Generated conjunction.

Example:

"since"

data.words.interjection

string

Generated interjection.

Example:

"gah"

data.words.noun

string

Generated noun.

Example:

"external"

data.words.preposition

string

Generated preposition.

Example:

"without"

data.words.sample

string

Generated sampled word.

Example:

"incidentally"

data.words.verb

string

Generated verb.

Example:

"act"

data.words.words

string

Generated space-separated words.

Example:

"before hourly patiently dribble equal"

data.words.length

number

Resolved exact expected word length.

Example:

5

data.words.lengthMin

number

Resolved minimum expected word length.

Example:

5

data.words.lengthMax

number

Resolved maximum expected word length.

Example:

7

data.words.strategy

enum<string>

Resolved word-length fallback strategy.

Available options:

fail,

closest,

shortest,

longest,

any-length

Example:

"any-length"

data.words.wordCount

number

Resolved exact word count.

Example:

5

data.words.wordCountMin

number

Resolved minimum word count.

Example:

5

data.words.wordCountMax

number

Resolved maximum word count.

Example:

10

data.generated

number

required

data.locale

string

required

data.method

enum<string>

required

Available options:

profile,

adjective,

adverb,

conjunction,

interjection,

noun,

preposition,

sample,

verb,

words

data.seed

number

performance

object

Hide child attributes

performance.generationTime

number

required

Generation time in milliseconds.

Example:

2

performance.itemsGenerated

number

required

Number of items generated.

Example:

10

performance.locale

string

required

Locale used for generation.

Example:

"en"

Overview

AI

Text

DNS

Email

SMS

Data

Generate synthetic word data

Authorizations

Body

Response