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'

import requests

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

payload = {
    "count": "10",
    "locale": "en",
    "seed": "12345",
    "method": "profile",
    "lineCount": "3",
    "lineCountMin": "1",
    "lineCountMax": "5",
    "sentenceCount": "3",
    "sentenceCountMin": "2",
    "sentenceCountMax": "6",
    "paragraphCount": "3",
    "paragraphCountMin": "1",
    "paragraphCountMax": "3",
    "wordCount": "5",
    "wordCountMin": "3",
    "wordCountMax": "10",
    "wordLength": "5",
    "wordLengthMin": "4",
    "wordLengthMax": "8",
    "strategy": "any-length",
    "separator": "\n"
}
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',
    lineCount: '3',
    lineCountMin: '1',
    lineCountMax: '5',
    sentenceCount: '3',
    sentenceCountMin: '2',
    sentenceCountMax: '6',
    paragraphCount: '3',
    paragraphCountMin: '1',
    paragraphCountMax: '3',
    wordCount: '5',
    wordCountMin: '3',
    wordCountMax: '10',
    wordLength: '5',
    wordLengthMin: '4',
    wordLengthMax: '8',
    strategy: 'any-length',
    separator: '\n'
  })
};

fetch('https://apix.spotzee.com/api/ext/generic/data/generate/lorem', 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/lorem"

	payload := strings.NewReader("count=10&locale=en&seed=12345&method=profile&lineCount=3&lineCountMin=1&lineCountMax=5&sentenceCount=3&sentenceCountMin=2&sentenceCountMax=6&paragraphCount=3&paragraphCountMin=1&paragraphCountMax=3&wordCount=5&wordCountMin=3&wordCountMax=10&wordLength=5&wordLengthMin=4&wordLengthMax=8&strategy=any-length&separator=%5Cn")

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

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

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'

import requests

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

payload = {
    "count": "10",
    "locale": "en",
    "seed": "12345",
    "method": "profile",
    "lineCount": "3",
    "lineCountMin": "1",
    "lineCountMax": "5",
    "sentenceCount": "3",
    "sentenceCountMin": "2",
    "sentenceCountMax": "6",
    "paragraphCount": "3",
    "paragraphCountMin": "1",
    "paragraphCountMax": "3",
    "wordCount": "5",
    "wordCountMin": "3",
    "wordCountMax": "10",
    "wordLength": "5",
    "wordLengthMin": "4",
    "wordLengthMax": "8",
    "strategy": "any-length",
    "separator": "\n"
}
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',
    lineCount: '3',
    lineCountMin: '1',
    lineCountMax: '5',
    sentenceCount: '3',
    sentenceCountMin: '2',
    sentenceCountMax: '6',
    paragraphCount: '3',
    paragraphCountMin: '1',
    paragraphCountMax: '3',
    wordCount: '5',
    wordCountMin: '3',
    wordCountMax: '10',
    wordLength: '5',
    wordLengthMin: '4',
    wordLengthMax: '8',
    strategy: 'any-length',
    separator: '\n'
  })
};

fetch('https://apix.spotzee.com/api/ext/generic/data/generate/lorem', 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/lorem"

	payload := strings.NewReader("count=10&locale=en&seed=12345&method=profile&lineCount=3&lineCountMin=1&lineCountMax=5&sentenceCount=3&sentenceCountMin=2&sentenceCountMax=6&paragraphCount=3&paragraphCountMin=1&paragraphCountMax=3&wordCount=5&wordCountMin=3&wordCountMax=10&wordLength=5&wordLengthMin=4&wordLengthMax=8&strategy=any-length&separator=%5Cn")

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

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

Hide child attributes

data.lorem

object[]

required

Hide child attributes

data.lorem.method

enum<string>

required

Resolved text generation method.

Available options:

profile,

lines,

paragraph,

paragraphs,

sentence,

sentences,

slug,

text,

word,

words

Example:

"profile"

data.lorem.value

string

required

Primary generated text fixture value.

Example:

"Doloribus autem non quis vero quia."

data.lorem.lines

string

Generated newline-separated lines.

Example:

"Rerum quia aliquam pariatur.\\nVoluptatem repellat consequatur."

data.lorem.paragraph

string

Generated paragraph.

Example:

"Non architecto nam unde sint. Ex tenetur dolor facere optio aut consequatur."

data.lorem.paragraphs

string

Generated paragraphs joined by the requested separator.

Example:

"First paragraph.\\nSecond paragraph."

data.lorem.sentence

string

Generated sentence.

Example:

"Laborum voluptatem officiis est et."

data.lorem.sentences

string

Generated sentences joined by the requested separator.

Example:

"First generated sentence. Second generated sentence."

data.lorem.slug

string

Generated URL-friendly slug text.

Example:

"dolores-illo-est"

data.lorem.text

string

Generated generic text fixture.

Example:

"Doloribus autem non quis vero quia."

data.lorem.word

string

Generated single word.

Example:

"temporibus"

data.lorem.words

string

Generated space-separated words.

Example:

"qui praesentium pariatur"

data.lorem.lineCount

number

Resolved exact line count.

Example:

3

data.lorem.lineCountMin

number

Resolved minimum line count.

Example:

1

data.lorem.lineCountMax

number

Resolved maximum line count.

Example:

5

data.lorem.sentenceCount

number

Resolved exact sentence count.

Example:

3

data.lorem.sentenceCountMin

number

Resolved minimum sentence count.

Example:

2

data.lorem.sentenceCountMax

number

Resolved maximum sentence count.

Example:

6

data.lorem.paragraphCount

number

Resolved exact paragraph count.

Example:

3

data.lorem.paragraphCountMin

number

Resolved minimum paragraph count.

Example:

1

data.lorem.paragraphCountMax

number

Resolved maximum paragraph count.

Example:

3

data.lorem.wordCount

number

Resolved exact word count.

Example:

5

data.lorem.wordCountMin

number

Resolved minimum word count.

Example:

3

data.lorem.wordCountMax

number

Resolved maximum word count.

Example:

10

data.lorem.wordLength

number

Resolved exact word length.

Example:

5

data.lorem.wordLengthMin

number

Resolved minimum word length.

Example:

4

data.lorem.wordLengthMax

number

Resolved maximum word length.

Example:

8

data.lorem.strategy

enum<string>

Resolved word-length fallback strategy.

Available options:

fail,

closest,

shortest,

longest,

any-length

Example:

"any-length"

data.lorem.separator

string

Resolved sentence or paragraph separator.

Example:

"\\n"

data.generated

number

required

data.locale

string

required

data.method

enum<string>

required

Available options:

profile,

lines,

paragraph,

paragraphs,

sentence,

sentences,

slug,

text,

word,

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 text data

Authorizations

Body

Response