🔧 Synthetic Data Generator - API Documentation

All endpoints that generate synthetic data require a short-living code obtained via the UI or /create_code endpoint. Field names can have dot notation for nested JSON. Default suggestion: when you pick a field type (except uuid) the input box may be prefilled with _function_name as default.

/app_io/generate_json

Method: POST

Generates synthetic data and returns a downloadable JSON file. Requires `code` in payload (generated from UI).

Example Request Payload:

{
    "code": "\u003cyour-code-here\u003e",
    "fields": {
        "id": "incremental_id",
        "name": "name"
    },
    "limit": 3
}

/app_io/generate_csv

Method: POST

Generates synthetic data and returns a downloadable CSV file. Use header:true/false. Requires `code` in payload.

Example Request Payload:

{
    "code": "\u003cyour-code-here\u003e",
    "fields": {
        "contact.email": "email",
        "id": "incremental_id"
    },
    "header": true,
    "limit": 3
}

/app_io/generate_api

Method: POST

Creates a secure API endpoint that can be called with the returned secret to fetch data as JSON. The secret-download requires `code` when calling the secure endpoint.

Example Request Payload:

{
    "fields": {
        "id": "incremental_id",
        "name": "name"
    },
    "limit": 5
}

/app_io/api/synthetic/<secret>

Method: POST

Download the dataset using the secret returned from generate_api (JSON payload). Requires `code` parameter in payload.

Example Request Payload:

{
    "code": "\u003cyour-code-here\u003e",
    "secret": "\u003csecret\u003e"
}

Live Example Command Output

The following box will display the Python command with the generated code when you perform actions on the UI.

No example yet.

Notes