Skip to Content
DocsAPI Reference

API Synthesis Reference

The BurstDB Synthesis API is a high-performance orchestration layer that manages the distributed generation lifecycle. It provides endpoints for blueprint parsing, job telemetry, and artifact acquisition.

🏗️ Blueprint Orchestration

SQL Data Reconstruction

POST /parse
Content-Type: multipart/form-data

Parses architectural SQL dumps into internal Synthesis Blueprints.

ParameterTypeRequired
file.sql BlobYes
save_to_diskbooleanYes

Distributed Connectors

Standardized endpoints for remote infrastructure synthesis:

  • POST /parse/supabase — PostgreSQL bridge.
  • POST /parse/mongodb — Document store bridge.
  • POST /parse/neo4j — Graph entity bridge.

⚡ Synthesis Pipeline

Orchestrate the ML generation queue via the following protocols:

MethodProtocolOperation
POST/synthetic/generateDispatch blueprint to worker cluster.
GET/synthetic/jobsRetrieve global telemetry.
GET/synthetic/jobs/{id}/statusSub-second status polling.
GET/synthetic/download/{id}Acquire high-fidelity ZIP artifact.

Dispatch Payload Example

{
  "schema_id": "blueprint_identifier",
  "scale_factor": 2.0,
  "synthesizer_type": "HMA",
  "output_format": "csv"
}

📊 System Telemetry

Monitor the health and footprint of the synthesis cluster:

  • GET /dashboard/overview — Aggregated cluster analytics.
  • GET /dashboard/activity — Real-time operational audit.
  • GET /health — Synthesis Gateway status.

🛡️ Operational Safeguards

The API Gateway implements strictly enforced operational limits via SlowAPI to ensure architectural stability:

  • Blueprint Parsing: 10 requests / min
  • Synthesis Dispatch: 5 requests / min
  • Telemetry Polling: 100 requests / min
Last updated on
Dashboard