gaud-e-sdk

v1.0.0

Published

a month ago

GAUD-E Developer SDK for BIM generation via GAUD-E Platform API. Integrate AI-powered architectural and building information modeling into your applications.

0High
0Medium
0Low

rickygaude-rgb

gaud-e bim architecture 3d-modeling building-information-modeling ai-generation three.js ifc revit archicad parametric-design

GAUD-E Developer SDK

GAUD-E SDK is an open-source, production-ready developer toolkit for integrating AI-powered BIM (Building Information Modeling) generation into your React applications. Generate complex architectural designs and building models from natural language prompts, visualize them in 3D, and export to industry-standard formats.

GAUD-E Platform API
├── 4-Agent Pipeline
│   ├── ✨ Enhancer (prompt optimization)
│   ├── 🏗️  Architect (design generation)
│   ├── 💻 Programmer (BIM geometry)
│   └── ✓  Reviewer (validation)
└── JSON BIM Output
    ├── Structural elements
    ├── Architectural features
    ├── MEP systems
    └── Landscape/site

All processing happens on GAUD-E's secure cloud platform. The SDK is a lightweight wrapper that routes requests through api.gaude.ai. No proprietary generation code is exposed—developers get a clean, secure API.

Features

🎯 Natural Language BIM Generation - Describe buildings in plain English
🎨 Multiple Design Styles - Minimalist, Bioclimatic, Parametric, Neoclassic, Industrial, and more
🌍 Terrain Selection - Draw polygons on Google Maps to set your project location
📊 Real-time Progress - Monitor 4-agent pipeline: Enhancer → Architect → Programmer → Reviewer
🔴 3D Visualization - Interactive Three.js viewer with multiple render modes (realistic, wireframe, xray)
📤 Multi-format Export - IFC (Revit/ArchiCAD compatible), glTF/GLB, and more
🔗 Software Integration - Connect to Revit, ArchiCAD, Rhino, SketchUp via MCP
⚡ React Hooks - useGaude, useBIMViewer for seamless state management
🛡️ Secure by Design - API keys never exposed in client code, rate limiting, error handling
📦 TypeScript Ready - Full type definitions included

Quick Start

1. Install

npm install gaud-e-sdk
# or
yarn add gaud-e-sdk

2. Get Your API Key

Visit https://platform.gaude.ai
Sign up and create an API key
Add to .env:

VITE_GAUD_E_API_KEY=gde_your_api_key_here
VITE_GAUD_E_API_URL=https://api.gaude.ai/v1
VITE_GOOGLE_MAPS_KEY=your_google_maps_key_here

3. Generate Your First BIM Model

import React, { useState } from 'react';
import { useGaude, GaudePromptInput, GaudeBIMViewer } from 'gaud-e-sdk';

function App() {
  const [model, setModel] = useState(null);
  const { generateBIM, getModel, generating } = useGaude(
    process.env.VITE_GAUD_E_API_KEY
  );

  const handleGenerate = async (promptData) => {
    const jobId = await generateBIM({
      prompt: promptData.prompt,
      conceptStyle: promptData.conceptStyle,
    });

    // Poll status and get model...
    const generatedModel = await getModel(modelId);
    setModel(generatedModel);
  };

  return (
    <div className="flex gap-6">
      <GaudePromptInput onSubmit={handleGenerate} loading={generating} />
      {model && <GaudeBIMViewer model={model} />}
    </div>
  );
}

export default App;

Architecture

┌─────────────────────────────────────┐
│      Your React Application         │
├─────────────────────────────────────┤
│  GAUD-E SDK (NPM Package)           │
│  ├─ GaudeClient (API wrapper)       │
│  ├─ React Hooks (useGaude, etc.)    │
│  ├─ Components (Viewer, Prompt)     │
│  └─ Utilities (Schema, Materials)   │
├─────────────────────────────────────┤
│  GAUD-E Platform API                │
│  ├─ Enhancer Agent                  │
│  ├─ Architect Agent                 │
│  ├─ Programmer Agent                │
│  ├─ Reviewer Agent                  │
│  └─ BIM Database                    │
└─────────────────────────────────────┘
    All calls to: api.gaude.ai/v1

API Usage Examples

Generate BIM Model

import { GaudeClient } from 'gaud-e-sdk';

const client = new GaudeClient(process.env.VITE_GAUD_E_API_KEY);

// Start generation
const job = await client.generateBIM(
  'Modern office building with 15 floors and glass facade',
  {
    conceptStyle: 'Minimalist',
    negativePrompt: 'avoid brutalism',
    polygon: [[40.7128, -74.0060], ...], // Terrain bounds
  }
);

console.log(job.jobId); // Track progress

Monitor Progress

// Check status periodically
const status = await client.getGenerationStatus(jobId);
console.log(status.progress); // 0-100
console.log(status.agentProgress); // { enhancer, architect, programmer, reviewer }

if (status.status === 'completed') {
  const model = await client.getModel(status.modelId);
}

Export Models

// Export to IFC (Revit compatible)
const ifcBlob = await client.exportIFC(modelId);
const url = URL.createObjectURL(ifcBlob);
// Download...

// Export to glTF (Web viewing)
const gltfBlob = await client.exportGLTF(modelId, { format: 'glb' });

Check Credits

const credits = await client.getCredits();
console.log(`Credits remaining: ${credits.creditsRemaining}`);
console.log(`Tier: ${credits.tier}`); // free, pro, enterprise

React Components

GaudeBIMViewer

Interactive 3D model viewer with render modes and layer controls.

<GaudeBIMViewer
  model={bimModel}
  renderMode="realistic" // realistic | wireframe | xray
  apiKey={apiKey}
  visibleLayers={{ structure: true, mep: false }}
/>

GaudeMapSelector

Draw terrain polygon on Google Maps.

<GaudeMapSelector
  onPolygonComplete={(coordinates) => console.log(coordinates)}
  apiKey={googleMapsKey}
  center={{ lat: 40.7128, lng: -74.0060 }}
/>

GaudePromptInput

Natural language prompt entry with style selector.

<GaudePromptInput
  onSubmit={(prompt) => generateBIM(prompt)}
  loading={isGenerating}
  showNegativePrompt={true}
/>

GaudeGenerationStatus

Real-time pipeline progress visualization.

<GaudeGenerationStatus
  jobId={jobId}
  apiKey={apiKey}
  onComplete={(status) => setModel(status.modelId)}
/>

React Hooks

useGaude

const {
  generateBIM,      // (prompt, options) => jobId
  getModel,         // (modelId) => model
  exportModel,      // (modelId, format) => blob
  generating,       // boolean
  progress,         // 0-100
  error,            // string | null
  jobId,            // current job ID
  getCredits,       // () => credits info
  ready             // client initialized
} = useGaude(apiKey);

useBIMViewer

const {
  elements,              // all BIM elements
  renderMode,            // current render mode
  visibleLayers,         // layer visibility map
  selectedElement,       // currently selected element
  toggleLayer,           // (layerName) => void
  setRenderMode,         // (mode) => void
  selectElement,         // (element) => void
  getElementsByType,     // (type) => elements[]
  getStats,              // () => stats
  getBoundingBox,        // () => bbox
  RENDER_MODES,          // { REALISTIC, WIREFRAME, XRAY }
  LAYER_CATEGORIES       // { STRUCTURE, ARCHITECTURE, MEP, LANDSCAPE }
} = useBIMViewer(bimModel);

Documentation

Quick Start Guide - Get started in 5 minutes
API Reference - Complete API documentation
BIM JSON Schema - Model structure specification
Examples - Complete working examples
- basic-usage.jsx - Full workflow demo
- nextjs-integration.jsx - Next.js integration with server-side API key

Concept Styles

Choose from multiple architectural design styles:

Minimalist - Clean, simple forms with minimal ornamentation
Bioclimatic - Climate-responsive design with natural ventilation
Industrial - Raw, functional aesthetics with exposed structure
Parametric - Rule-based algorithmic geometry
Neoclassic - Classical proportions and symmetry
Sustainable - Eco-friendly materials and features
Futuristic - Cutting-edge contemporary design
Vernacular - Local architectural traditions

Security

✓ API keys never exposed to client - Use environment variables ✓ Rate limiting - 100 requests/minute per key ✓ Secure webhooks - Optional real-time job notifications ✓ No generation code exposed - All processing server-side ✓ Request signing - Bearer token authentication ✓ Audit logs - Track all API activity

For production:

Store API keys in backend environment variables
Use next.js or similar to proxy API calls through your server
Implement user authentication and rate limiting at your layer

See examples/nextjs-integration.jsx for secure backend pattern.

Supported Export Formats

| Format | Use Case | Software | |--------|----------|----------| | IFC | Industry standard BIM exchange | Revit, ArchiCAD, BIMx | | glTF/GLB | Web 3D visualization | Three.js, Babylon.js, Cesium | | JSON | Programmatic access | Custom tools, analysis |

Software Integration

Connect to professional CAD/BIM software:

// Connect to Revit
await client.connectSoftware('revit', 9090);

// Supported: revit, archicad, rhino, sketchup, autocad, vectorworks

Real-time bidirectional sync via MCP (Model Connection Protocol).

Contributing

Contributions welcome! See CONTRIBUTING.md for guidelines.

# Development setup
git clone https://github.com/rickygaude-rgb/gaud-e-sdk.git
cd gaud-e-sdk
npm install
npm run dev

# Run tests
npm test

# Build
npm run build

Performance

Typical generation time: 1-2 minutes
Streaming status updates: Every 2-5 seconds
3D viewer: 60 FPS on modern hardware
Export: 30s-2 min depending on model complexity

Limitations

Maximum 100 storeys per model
Maximum 100,000 elements per model
Maximum 100MB per export file
Rate limit: 100 requests/minute

Troubleshooting

Q: API Key validation fails A: Ensure key starts with gde_ and is from https://platform.gaude.ai/api-keys

Q: Generation timeout A: Check client.getJobLogs(jobId) for details. Typical time is 1-2 minutes.

Q: Map not loading A: Verify Google Maps API key is correct and Maps API is enabled.

Q: Out of credits A: Check usage at https://platform.gaude.ai/account/usage

Developer

Ricardo Riffo Q. Arquitecto Urbanista | Magíster en Inteligencia Artificial | Experto en Evaluaciones Energéticas y Medioambiente

Desarrollador de productos de IA para Ingeniería, Arquitectura y Salud.

🏛️ Especialidades: Diseño Arquitectónico Paramétrico, BIM, Urbanismo, Smart Cities
🤖 IA Aplicada: Modelos multiagente, generación 3D desde lenguaje natural, Computer Vision
🌱 Sustentabilidad: Certificaciones LEED, Passivhaus, evaluación de impacto ambiental
🏥 Salud: Soluciones de IA para infraestructura hospitalaria y bienestar

License

See LICENSE file for details.

Support

📧 Email: [email protected]
💬 Discord: https://discord.gg/gaude
📖 Docs: https://docs.gaude.ai
🐛 Issues: https://github.com/rickygaude-rgb/gaud-e-sdk/issues
📊 Status: https://status.gaude.ai

Related Resources

Developed by Ricardo Riffo Q. — Arquitecto Urbanista, Magíster en IA

Made with ❤️ by GAUD-E Architect AI

API Routes All Generation Through: https://api.gaude.ai/v1