DataSynth PL — API Docs

Generate GDPR-compliant synthetic data programmatically. 15 templates · 3 locales (PL/US/DE) · CSV, JSON, Excel.

Overview

The DataSynth PL API lets you generate realistic, RODO/GDPR-compliant synthetic datasets on demand. Each request returns a downloadable file (CSV, JSON, or Excel) with a unique random seed — data never repeats across calls.

Every generated dataset is statistically realistic but contains no real personal data — safe to use for AI training, testing, and demos.

Authentication

All API requests require an API key passed as a Bearer token in the Authorization header.

Copy# All requests must include this header:
Authorization: Bearer ds_live_your_api_key_here

Get your API key from the client dashboard → Klucze API. Keys start with ds_live_ and are shown only once at creation.

Quick Start

cURL

Copycurl -X POST https://datasynth.pl/api/generate \
  -H "Authorization: Bearer ds_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"template":"ecommerce_customer_pl","rows":1000,"format":"csv"}' \
  --output customers.csv

Python

Copyimport requests

API_KEY  = "ds_live_YOUR_KEY"
BASE_URL = "https://datasynth.pl/api/generate"

response = requests.post(
    BASE_URL,
    headers={"Authorization": f"Bearer {API_KEY}"},
    json={
        "template": "ecommerce_customer_pl",
        "rows":     5000,
        "format":   "csv",
    }
)

with open("customers.csv", "wb") as f:
    f.write(response.content)

print(f"Generated {response.headers.get('X-Records-Generated')} records")
# Generated 5000 records

JavaScript / Node.js

Copyconst fs = require('fs');

const response = await fetch('https://datasynth.pl/api/generate', {
  method:  'POST',
  headers: {
    'Authorization': 'Bearer ds_live_YOUR_KEY',
    'Content-Type':  'application/json',
  },
  body: JSON.stringify({
    template: 'hr_employee_us',
    rows:     2000,
    format:   'json',
  }),
});

const buffer = await response.arrayBuffer();
fs.writeFileSync('employees.json', Buffer.from(buffer));
console.log('Done!', response.headers.get('X-Records-Generated'), 'records');

POST /api/generate

Generate a synthetic dataset and return it as a downloadable file.

Templates

Each template generates a different type of data. The locale suffix (_pl, _us, _de) determines language, currency, and region-specific formatting.

Formats

Plan Limits

Record counters reset monthly on your subscription renewal date.

Error Codes

Copy# Example error response (JSON body):
{
  "error": "Przekroczono limit rekordów dla Twojego planu.",
  "upgrade": "https://datasynth.pl/#cennik"
}

Python SDK (minimal)

No package yet — copy this helper class into your project:

Copyimport requests

class DataSynth:
    BASE = "https://datasynth.pl/api/generate"

    def __init__(self, api_key: str):
        self.headers = {
            "Authorization": f"Bearer {api_key}",
            "Content-Type":  "application/json",
        }

    def generate(self, template: str, rows: int, format: str = "csv") -> bytes:
        r = requests.post(self.BASE, headers=self.headers,
                         json={"template": template, "rows": rows, "format": format})
        r.raise_for_status()
        return r.content

# Usage:
ds = DataSynth("ds_live_YOUR_KEY")
data = ds.generate("ecommerce_customer_pl", rows=5000)
open("data.csv", "wb").write(data)

JavaScript SDK (minimal)

Copyclass DataSynth {
  constructor(apiKey) { this.apiKey = apiKey; }

  async generate(template, rows, format = 'csv') {
    const res = await fetch('https://datasynth.pl/api/generate', {
      method:  'POST',
      headers: {
        'Authorization': `Bearer ${this.apiKey}`,
        'Content-Type':  'application/json',
      },
      body: JSON.stringify({ template, rows, format }),
    });
    if (!res.ok) throw new Error(`API error ${res.status}`);
    return res.blob();
  }
}

// Usage (Node.js / browser):
const ds = new DataSynth('ds_live_YOUR_KEY');
const blob = await ds.generate('hr_employee_de', 2000, 'json');
// browser: create download link from blob
// node:    Buffer.from(await blob.arrayBuffer())

cURL Examples

Generate 10 000 German HR records as JSON

Copycurl -X POST https://datasynth.pl/api/generate \
  -H "Authorization: Bearer ds_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"template":"hr_mitarbeiter_de","rows":10000,"format":"json"}' \
  -o mitarbeiter.json

Check available templates (GET)

Copycurl https://datasynth.pl/api/generate \
  -H "Authorization: Bearer ds_live_YOUR_KEY"