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

import requests

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

payload = {
    "count": "10",
    "locale": "en",
    "seed": "12345",
    "method": "profile",
    "length": "12",
    "lengthMin": "8",
    "lengthMax": "16",
    "casing": "mixed",
    "prefix": "id_",
    "characters": "ABC123",
    "exclude": "0O1l",
    "allowLeadingZeros": "true",
    "refDate": "2024-01-01T00:00:00.000Z"
}
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: '12',
    lengthMin: '8',
    lengthMax: '16',
    casing: 'mixed',
    prefix: 'id_',
    characters: 'ABC123',
    exclude: '0O1l',
    allowLeadingZeros: 'true',
    refDate: '2024-01-01T00:00:00.000Z'
  })
};

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

	payload := strings.NewReader("count=10&locale=en&seed=12345&method=profile&length=12&lengthMin=8&lengthMax=16&casing=mixed&prefix=id_&characters=ABC123&exclude=0O1l&allowLeadingZeros=true&refDate=2024-01-01T00%3A00%3A00.000Z")

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

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

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

import requests

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

payload = {
    "count": "10",
    "locale": "en",
    "seed": "12345",
    "method": "profile",
    "length": "12",
    "lengthMin": "8",
    "lengthMax": "16",
    "casing": "mixed",
    "prefix": "id_",
    "characters": "ABC123",
    "exclude": "0O1l",
    "allowLeadingZeros": "true",
    "refDate": "2024-01-01T00:00:00.000Z"
}
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: '12',
    lengthMin: '8',
    lengthMax: '16',
    casing: 'mixed',
    prefix: 'id_',
    characters: 'ABC123',
    exclude: '0O1l',
    allowLeadingZeros: 'true',
    refDate: '2024-01-01T00:00:00.000Z'
  })
};

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

	payload := strings.NewReader("count=10&locale=en&seed=12345&method=profile&length=12&lengthMin=8&lengthMax=16&casing=mixed&prefix=id_&characters=ABC123&exclude=0O1l&allowLeadingZeros=true&refDate=2024-01-01T00%3A00%3A00.000Z")

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

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

Hide child attributes

data.strings

object[]

required

Hide child attributes

data.strings.method

enum<string>

required

Resolved string generation method.

Available options:

profile,

alpha,

alphanumeric,

binary,

fromCharacters,

hexadecimal,

nanoid,

numeric,

octal,

sample,

symbol,

ulid,

uuid

Example:

"profile"

data.strings.value

string

required

Primary generated string fixture value.

Example:

"Zo6Bye8"

data.strings.alpha

string

Generated alphabetic string.

Example:

"aZbQc"

data.strings.alphanumeric

string

Generated alphanumeric string.

Example:

"A9b2Z7"

data.strings.binary

string

Generated binary string.

Example:

"0b101011"

data.strings.fromCharacters

string

Generated string from the supplied character source.

Example:

"AC13BA"

data.strings.hexadecimal

string

Generated hexadecimal string.

Example:

"0xA4d9"

data.strings.nanoid

string

Generated Nano ID style identifier.

Example:

"VsvwSdm_Am"

data.strings.numeric

string

Generated numeric string.

Example:

"315079"

data.strings.octal

string

Generated octal string.

Example:

"0o15263"

data.strings.sample

string

Generated sampled ASCII string.

Example:

"FeKunG"

data.strings.symbol

string

Generated symbol string.

Example:

"#*!.~"

data.strings.ulid

string

Generated lexicographically sortable identifier.

Example:

"01DXF6DT00CX9QNNW7PNXQ3YR8"

data.strings.uuid

string

Generated UUID v4 identifier.

Example:

"4136cd0b-d90b-4af7-b485-5d1ded8db252"

data.strings.length

number

Resolved exact string length.

Example:

12

data.strings.lengthMin

number

Resolved minimum string length.

Example:

8

data.strings.lengthMax

number

Resolved maximum string length.

Example:

16

data.strings.casing

enum<string>

Resolved casing option.

Available options:

upper,

lower,

mixed

Example:

"mixed"

data.strings.prefix

string

Resolved prefix option.

Example:

"id_"

data.strings.characters

string

Resolved character source option.

Example:

"ABC123"

data.strings.exclude

string

Resolved excluded characters option.

Example:

"0O1l"

data.strings.allowLeadingZeros

boolean

Resolved leading-zero option.

Example:

true

data.strings.refDate

string

Resolved reference date.

Example:

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

data.generated

number

required

data.locale

string

required

data.method

enum<string>

required

Available options:

profile,

alpha,

alphanumeric,

binary,

fromCharacters,

hexadecimal,

nanoid,

numeric,

octal,

sample,

symbol,

ulid,

uuid

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

Authorizations

Body

Response