Skip to main content
POST
/
generic
/
data
/
generate
/
string
Generate synthetic string data
curl --request POST \
  --url https://apix.spotzee.com/api/ext/generic/data/generate/string \
  --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=12 \
  --data lengthMin=8 \
  --data lengthMax=16 \
  --data casing=mixed \
  --data prefix=id_ \
  --data characters=ABC123 \
  --data exclude=0O1l \
  --data allowLeadingZeros=true \
  --data refDate=2024-01-01T00:00:00.000Z
{
  "status": "success",
  "data": {
    "strings": [
      {
        "method": "profile",
        "value": "Zo6Bye8",
        "alpha": "aZbQc",
        "alphanumeric": "A9b2Z7",
        "binary": "id_101011",
        "fromCharacters": "AC13BA",
        "hexadecimal": "id_A4d9",
        "nanoid": "VsvwSdm_Am",
        "numeric": "315079",
        "octal": "id_15263",
        "sample": "FeKunG",
        "symbol": "#*!.~",
        "ulid": "01DXF6DT00CX9QNNW7PNXQ3YR8",
        "uuid": "4136cd0b-d90b-4af7-b485-5d1ded8db252",
        "length": 6,
        "casing": "mixed",
        "prefix": "id_",
        "characters": "ABC123",
        "allowLeadingZeros": true,
        "refDate": "2024-01-01T00:00:00.000Z"
      }
    ],
    "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 string 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>

String generation method. Defaults to profile.

Available options:
profile,
alpha,
alphanumeric,
binary,
fromCharacters,
hexadecimal,
nanoid,
numeric,
octal,
sample,
symbol,
ulid,
uuid
Example:

"profile"

​
length
string

Exact string length for supported methods. Range: 1-256.

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

"12"

​
lengthMin
string

Minimum string length for supported methods. Range: 1-256.

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

"8"

​
lengthMax
string

Maximum string length for supported methods. Range: 1-256.

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

"16"

​
casing
enum<string>

Casing for letter-based and hexadecimal output.

Available options:
upper,
lower,
mixed
Example:

"mixed"

​
prefix
string

Optional prefix for binary, octal, or hexadecimal output. Max 16 safe characters.

Maximum string length: 16
Example:

"id_"

​
characters
string

Character source for fromCharacters output. Required when method=fromCharacters. Max 128 non-control characters.

Maximum string length: 128
Example:

"ABC123"

​
exclude
string

Characters to exclude from alpha, alphanumeric, or numeric output. Max 128 non-control characters.

Maximum string length: 128
Example:

"0O1l"

​
allowLeadingZeros
enum<string>

Allow leading zeros for numeric output.

Available options:
true,
false
Example:

"true"

​
refDate
string<date-time>

Reference date for generated sortable identifier output.

Example:

"2024-01-01T00:00:00.000Z"

Response

Successfully generated string data

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