Overview
DNS
- POSTGenerate SPF record
- POSTLookup SPF record
- POSTLookup MX records
- POSTTest SMTP server
- POSTTest SMTP email sending
- POSTValidate email syntax
- POSTGenerate DMARC record
- POSTLookup DMARC record
- POSTLookup sender score
- POSTCheck for temporary email
- POSTCheck email provider
- GETGet email tester endpoint
- GETGet email tester results
- POSTComprehensive email health check
- POSTCheck URL for malicious content
- POSTValidate email address
- POSTCheck IP blacklist status
- POSTCheck domain blacklist status
Data
- POSTGenerate synthetic person data
- POSTGenerate synthetic contact data
- POSTGenerate synthetic phone data
- POSTGenerate synthetic company data
- POSTGenerate synthetic commerce data
- POSTGenerate synthetic finance data
- POSTGenerate synthetic food data
- POSTGenerate synthetic git data
- POSTGenerate synthetic animal data
- POSTGenerate synthetic book data
- POSTGenerate synthetic vehicle data
- POSTGenerate synthetic system data
- POSTGenerate synthetic color data
- POSTGenerate synthetic text data
- POSTGenerate synthetic word data
- POSTGenerate synthetic string data
- POSTGenerate synthetic number data
- POSTGenerate synthetic airline data
- POSTGenerate synthetic database data
- POSTGenerate synthetic datatype data
- POSTGenerate synthetic technical jargon data
- POSTGenerate synthetic image reference data
- POSTGenerate synthetic music data
- POSTGenerate synthetic science data
- POSTGenerate bounded helper data
- POSTGenerate synthetic name data
- POSTGenerate date and time data
- POSTGenerate synthetic location data
- POSTGenerate synthetic internet data
Generate bounded helper data
curl --request POST \
--url https://apix.spotzee.com/api/ext/generic/data/generate/helpers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data method=arrayElement{
"status": "success",
"data": {
"helpers": [
{
"method": "arrayElement",
"value": "alpha",
"input": {
"itemCount": 3
}
}
],
"generated": 1,
"locale": "en",
"method": "arrayElement"
},
"performance": {
"generationTime": 1,
"itemsGenerated": 1,
"locale": "en"
}
}Data
Generate bounded helper data
Applies approved bounded helper operations for test fixtures, custom sample sets, weighted selections, object selections, slug and symbol templates, and constrained pattern strings. Callback and template-dispatch helpers are not exposed.
POST
/
generic
/
data
/
generate
/
helpers
Generate bounded helper data
curl --request POST \
--url https://apix.spotzee.com/api/ext/generic/data/generate/helpers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data method=arrayElement{
"status": "success",
"data": {
"helpers": [
{
"method": "arrayElement",
"value": "alpha",
"input": {
"itemCount": 3
}
}
],
"generated": 1,
"locale": "en",
"method": "arrayElement"
},
"performance": {
"generationTime": 1,
"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
Bearer token authentication. Use format: Bearer YOUR_API_KEY
Body
application/x-www-form-urlencoded
Approved safe helper method to apply.
Available options:
arrayElement, arrayElements, weightedArrayElement, shuffle, objectKey, objectValue, objectEntry, enumValue, rangeToNumber, replaceSymbols, replaceCreditCardSymbols, slugify, fromRegExp, uniqueArray Example:
"arrayElement"
Number of helper records to generate (1-100). Passed as string but must be numeric.
Pattern:
^[1-9]\d?$|^100$Example:
"10"
Locale for generated data (e.g., en, es, fr, de, pt_BR, zh_CN)
Example:
"en"
Seed for deterministic generation. Same seed produces same results.
Example:
"12345"
JSON array of scalar values for arrayElement, arrayElements, shuffle, and uniqueArray. Maximum 100 entries.
Example:
"[\"alpha\",\"bravo\",\"charlie\"]"
JSON object with scalar values for objectKey, objectValue, objectEntry, and enumValue. Maximum 100 entries.
Example:
"{\"small\":1,\"medium\":2,\"large\":3}"
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, symbol template, card-pattern template, slug input, or bounded pattern string for text-backed helper methods.
Maximum string length:
256Example:
"Hello world"
Helper output length for arrayElements and uniqueArray. Capped at 100.
Pattern:
^[1-9]\d*$Example:
"2"
Minimum count or numeric input for arrayElements and rangeToNumber.
Pattern:
^-?(?:\d+|\d*\.\d+)$Example:
"1"
Maximum count for arrayElements or maximum numeric range value for rangeToNumber.
Pattern:
^-?(?:\d+|\d*\.\d+)$Example:
"3"
Single replacement symbol for replaceCreditCardSymbols.
Maximum string length:
256Example:
"#"
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
Available options:
success Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Resolved helper method.
Available options:
arrayElement, arrayElements, weightedArrayElement, shuffle, objectKey, objectValue, objectEntry, enumValue, rangeToNumber, replaceSymbols, replaceCreditCardSymbols, slugify, fromRegExp, uniqueArray Example:
"arrayElement"
Primary scalar helper output when the method returns one value.
Example:
"alpha"
Generated helper output when the method returns multiple values.
Example:
["bravo", "alpha"]Selected object key for object-backed methods.
Example:
"medium"
Selected object entry as key and value.
Example:
["medium", 2]Summary of bounded input used by the helper.
Hide child attributes
Hide child attributes
Number of input array items.
Example:
3
Number of input object keys.
Example:
3
Number of weighted input entries.
Example:
2
Length of the supplied text input.
Example:
11
Requested helper output length.
Example:
2
Minimum numeric input used by the helper.
Example:
1
Maximum numeric input used by the helper.
Example:
3
Replacement symbol used by the helper.
Example:
"#"
Whether shuffle used in-place behavior internally.
Example:
false
Available options:
arrayElement, arrayElements, weightedArrayElement, shuffle, objectKey, objectValue, objectEntry, enumValue, rangeToNumber, replaceSymbols, replaceCreditCardSymbols, slugify, fromRegExp, uniqueArray Was this page helpful?
⌘I
Assistant
Responses are generated using AI and may contain mistakes.