Skip to main content
POST
Generate synthetic person data

Authorizations

Authorization
string
header
required

Bearer token authentication. Use format: Bearer YOUR_API_KEY

Body

application/x-www-form-urlencoded
count
string

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

gender
enum<string>

Optional sex parameter for generated names.

Available options:
male,
female
Example:

"female"

includeJobTitle
enum<string>

Include a generated job title on each person.

Available options:
true,
false
Example:

"true"

includeJobDetails
enum<string>

Include generated job descriptor, job area, and job type fields.

Available options:
true,
false
Example:

"false"

includeBiography
enum<string>

Include a generated short biography on each person.

Available options:
true,
false
Example:

"false"

includeMiddleName
enum<string>

Include a generated middle name on each person.

Available options:
true,
false
Example:

"false"

includePrefixSuffix
enum<string>

Include generated prefix and suffix fields on each person.

Available options:
true,
false
Example:

"false"

includePersonalDetails
enum<string>

Include generated gender identity and zodiac sign fields.

Available options:
true,
false
Example:

"false"

Response

Successfully generated person data

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