API URL
POST /api/v1/sample-data, POST /api/v1/generate, POST /api/v1/generate-batch
Headers
Code
Content-Type: application/jsonBody Parameters
Param
Type
Description
type
required
string
Data schema type (user, company, product, transaction, etc.)
count
optional
integer
Number of records to generate (1-10000, default: 10)
fields
optional
string
Comma-separated field names or array of fields
format
optional
string
Output format: json or csv (default: json)
requests
required
array
Batch request definitions for batch operations
Example Request
Code
{
"type": "user",
"count": 3,
"fields": [
"name",
"email",
"phone"
]
}Successful Response
Status
HTML
200 OKBody
Code
{
"success": true,
"type": "user",
"count": 3,
"data": [
{
"name": "John Doe",
"email": "john@example.com",
"phone": "+1-555-0123"
}
]
}Field
Type
Description
success
boolean
Data generation operation status indicating successful creation of mock dataset
type
string
Schema type used for data generation matching requested business entity (user, company, product, etc.)
count
integer
Actual number of records generated in the response dataset
format
string
—
data
array
Array of generated mock objects with realistic business-appropriate field values
csvData
string
—
results
array
—
correlationId
string
—
timestamp
string
—
error
string
—
Error Response
Example
Code
400 INVALID_INPUT – Invalid parameters or missing required fields
500 INTERNAL_ERROR – Data generation or CSV export failed
429 TOO_MANY_REQUESTS – Rate limit exceededLast Updated: May 4, 2026