Skip to content

API Reference

REST API Reference

LotusGen provides a REST API for managing project schemas, running dry runs, and triggering asynchronous dataset generation.

Endpoints

Health Check

  • GET /api/health
  • Returns the health status of the API server and SQLite database connection.

Project Management

  • GET /api/projects
    • List all configured generation projects.
  • POST /api/projects
    • Create a new project schema.
  • GET /api/projects/{id}
    • Retrieve full project details, table schemas, and dependency graph.
  • POST /api/projects/{id}/tables
    • Add or update a table definition within a project.

Generation & Jobs

  • POST /api/tables/{id}/dry-run
    • Generate a lightweight sample preview (e.g., 10–50 rows) for live validation in the UI without writing to disk.
  • POST /api/tables/{id}/generate
    • Queue an asynchronous generation job for the specified table and row count.
  • GET /api/jobs/{id}
    • Inspect generation job progress, execution time, throughput (rows/sec), and file size.
  • GET /api/jobs/{id}/download
    • Download the completed CSV or Parquet artifact file.