Skip to main content

Synthetic Data Generator (SDG) API

Pool-based synthetic data generation for development, testing, and demo environments. Supports Kafka, PostgreSQL, Dragonfly, and file destinations.

FieldValue
Port50032
Base Path/api/v1
OpenAPI3.0.1
SpecSynthetic_Data_GEN_API.json

Generator Lifecycle​

Generator CRUD​

MethodPathRequest BodyResponseStatus
GET/api/v1/generators—List<GeneratorResponse>200
POST/api/v1/generatorsCreateGeneratorRequestGeneratorResponse201
GET/api/v1/generators/{id}—GeneratorResponse (+ live metrics if running)200
PUT/api/v1/generators/{id}UpdateGeneratorRequestGeneratorResponse200
DELETE/api/v1/generators/{id}——200
info

Cannot update a generator while it is RUNNING. Delete stops a running generator first.

Generator Lifecycle Control​

MethodPathDescription
POST/api/v1/generators/{id}/startStart generation
POST/api/v1/generators/{id}/pausePause generation
POST/api/v1/generators/{id}/resumeResume paused
POST/api/v1/generators/{id}/stopStop generation
GET/api/v1/generators/{id}/metricsReal-time metrics
POST/api/v1/generators/{id}/profilingProfile generated data

Pool Management​

MethodPathDescription
GET/api/v1/poolsList all data pools with status
GET/api/v1/pools/{poolName}Get pool details
POST/api/v1/pools/{poolName}/refreshRefresh pool data

Universe Management​

Universes coordinate multiple generators to produce related datasets.

MethodPathDescription
GET/api/v1/universesList universes
POST/api/v1/universesCreate universe
GET/api/v1/universes/{id}Get universe details

Validation​

MethodPathDescription
POST/api/v1/generators/validateValidate schema and field mappings

Health​

MethodPathDescription
GET/api/v1/healthService health check

Key Enums​

EnumValues
GeneratorStatusCREATED RUNNING PAUSED COMPLETED STOPPED FAILED
GenerationModeBATCH REALTIME
DestinationTypeKAFKA POSTGRES DRAGONFLY FILE
FieldMappingTypeUUID_GENERATED TIMESTAMP_GENERATED ENUM_RANDOM NUMERIC_RANGE CONSTANT SEQUENCE COMPUTED POOL_REFERENCE POOL_DERIVED COPULA_GENERATED UNIVERSE_KEY_REFERENCE
PoolLoadStrategyFULL SAMPLED INDEXED
EndConditionRECORD_COUNT DURATION MANUAL
OnErrorCONTINUE PAUSE STOP

Frontend Integration​

FilePurpose
services/synthetic-data.service.tsGenerator, pool, universe operations
hooks/useSyntheticData.tsReact Query hooks (generators poll every 5s)
types/synthetic-data.types.tsTypeScript types