Documentation

Build with StructGen

Everything you need to integrate StructGen into your data pipelines.

Getting Started

Welcome to StructGen

StructGen is the AI-powered transformation layer for modern data stacks. Use StructGen to ingest files, normalize schemas, and deliver clean, validated Excel outputs ready for import into your systems.

App Console

structgen.tech

API Base URL

api.structgen.tech

Getting Started

Quick Start

Provision an API key, upload a file, and get a normalized output in minutes.

  1. 1Sign in to the StructGen console and create a new workspace.
  2. 2Generate an API key under Settings → API Keys.
  3. 3Upload a sample file to inspect detected columns and types.
Getting Started

First Transform

Transform your first file using cURL:

curl -X POST https://api.structgen.tech/v1/transform \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@data.xlsx" \
  -F "target_schema=customer_v1"

The response includes a job_id and a download_url. Poll the status endpoint or register a webhook to receive completion events automatically.

Getting Started

API Keys

API keys are workspace-scoped and support role-based permissions. Rotate keys quarterly and restrict them to the minimum scopes needed for each integration.

  • Production keys are labeled and require 2FA to create.
  • Use environment variables to inject keys into CI/CD pipelines.
  • Keys can be revoked instantly without downtime for existing jobs.
Core Concepts

Schemas & Mapping

Define a target schema to normalize fields across source systems. StructGen learns from examples and suggests mappings that you can approve or override.

  • Schema definitions support nested objects, arrays, and custom enum types.
  • Map multiple input columns into a single output field with templates.
  • Store mapping profiles per integration to reuse across datasets.
Core Concepts

Validation Rules

Validation rules ensure output quality. Define required fields, data type constraints, and cross-field dependencies before export.

  • Flag invalid records with structured error reasons.
  • Apply normalization rules like phone or address formatting.
  • Route invalid rows to a quarantine dataset for review.
Core Concepts

Transform Plans

Transform plans bundle schemas, mappings, and validation into reusable workflows. Plans can be scheduled or triggered via API.

  • Create versioned plans to support schema migrations.
  • Attach enrichment steps like geocoding or deduplication.
  • Enable incremental processing for large uploads.
Core Concepts

Output & Integration

Transformed data is exported as clean Excel files. Download directly from the dashboard or retrieve via API for integration with your downstream systems.

  • Download transformed Excel files per session.
  • AI-normalized phone numbers in 10-digit format.
  • Multi-sheet preservation from source files.
API Reference

Authentication

All API requests use X-API-Key header authentication.

X-API-Key: YOUR_API_KEY
API Reference

Endpoints

Core endpoints for the 6-phase transformation pipeline.

EndpointMethodDescription
/api/v1/session/createPOSTCreate a new transformation session.
/api/v1/phase1/upload-filesPOSTUpload source data files (Excel, CSV).
/api/v1/phase2/analyzePOSTAI-powered schema detection and context analysis.
/api/v1/phase6/transformPOSTExecute the full transformation pipeline.
/api/v1/uploadZipPOSTUpload ZIP archive for bulk ingestion.
/api/v1/upload/:id/statusGETCheck ZIP upload processing status.
API Reference

Errors

Errors use standard HTTP codes with structured JSON payloads. Capture the request_id for support.

{ "error": { "code": "invalid_schema", "message": "Target schema missing required field email", "request_id": "req_9fd2f" } }
API Reference

Email Notifications

StructGen sends email notifications when transformations complete. Provide a user email when creating a session to receive automatic updates.

  • Notification on transformation completion with row counts and file details.
  • Direct link to download results from the dashboard.
  • Non-blocking — failures are logged, never interrupt processing.
Guides & Integration

API Integration

Integrate with StructGen using the REST API. All endpoints accept JSON and return structured responses.

  • Use cURL, Python requests, or any HTTP client.
  • ZIP file uploads via multipart form data.
  • Session-based workflow: create session → upload → analyze → transform → download.
Guides & Integration

Migration

Migrating from legacy ETL? Start by documenting your current schema, then map fields to StructGen targets and validate outputs in a staging workspace.

  • Export mapping templates from the StructGen console.
  • Run side-by-side comparisons on historical data.
  • Promote the plan to production once validation is clean.
Guides & Integration

Release Notes

Track new features, deprecations, and API changes in the release feed inside the StructGen console. Subscribe to updates for weekly summary emails.

Guides & Integration

Support

Need help? Reach our support team via the in-app messenger or email

Enterprise SLA

Enterprise SLA: 24/5 coverage with a 1-hour response time.

Community

Community: Join the public roadmap and feature requests.

Status

Monitor live incidents at status.structgen.app

Direct Support

Get in touch with an engineer within 60 minutes.

Email Support