Skip to main content
POST
Generate bounded helper data

Authorizations

Authorization
string
header
required

Bearer token authentication. Use format: Bearer YOUR_API_KEY

Body

application/x-www-form-urlencoded
method
enum<string>
required

Approved safe helper method to apply.

Available options:
arrayElement,
arrayElements,
weightedArrayElement,
shuffle,
objectKey,
objectValue,
objectEntry,
enumValue,
rangeToNumber,
replaceSymbols,
replaceCreditCardSymbols,
slugify,
fromRegExp,
uniqueArray
Example:

"arrayElement"

count
string

Number of helper 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"

items
string

JSON array of scalar values for arrayElement, arrayElements, shuffle, and uniqueArray. Maximum 100 entries.

Example:

"[\"alpha\",\"bravo\",\"charlie\"]"

object
string

JSON object with scalar values for objectKey, objectValue, objectEntry, and enumValue. Maximum 100 entries.

Example:

"{\"small\":1,\"medium\":2,\"large\":3}"

weights
string

JSON array of weighted scalar values for weightedArrayElement. Each entry must include positive finite weight and scalar value.

Example:

"[{\"weight\":5,\"value\":\"sunny\"},{\"weight\":1,\"value\":\"rainy\"}]"

text
string

Text, symbol template, card-pattern template, slug input, or bounded pattern string for text-backed helper methods.

Maximum string length: 256
Example:

"Hello world"

length
string

Helper output length for arrayElements and uniqueArray. Capped at 100.

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

"2"

min
string

Minimum count or numeric input for arrayElements and rangeToNumber.

Pattern: ^-?(?:\d+|\d*\.\d+)$
Example:

"1"

max
string

Maximum count for arrayElements or maximum numeric range value for rangeToNumber.

Pattern: ^-?(?:\d+|\d*\.\d+)$
Example:

"3"

symbol
string

Single replacement symbol for replaceCreditCardSymbols.

Maximum string length: 256
Example:

"#"

inplace
enum<string>

Whether shuffle should use in-place behavior internally. The request input is never persisted.

Available options:
true,
false
Example:

"false"

Response

Successfully generated helper data

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