DEVELOPER & WORKSHOP INTEGRATION

Developer API Reference

Programmatically trigger parametric solid CAD compilation, fetch multi-stock cut-lists, and stream workshop production payloads into your internal ERP or shop-floor scheduling systems.

1. Authentication & API Keys

All API requests must include an enterprise API key in the Authorization header as a Bearer token:

Authorization: Bearer gbx_live_sec_994a8e2b71d440f1

Generate and manage API keys inside your GearBox Studio Account Settings under Developer Integrations.

POST/api/ai/cad

Synthesizes natural language prompts or base parameters into a validated, deterministic Split-Box AST assembly tree.

Example cURL Request:

curl -X POST https://gearboxcad.com/api/ai/cad \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "4-bay fitted wardrobe 3600x2700x600mm with walnut doors and 18mm birch carcass",
    "mode": "cabinet",
    "units": "mm"
  }'

Response JSON Schema (200 OK):

{
  "success": true,
  "program": {
    "dimensionsMm": [3600, 2700, 600],
    "envelopeTolerance": "±0.1mm",
    "runs": [
      {
        "id": "run-01",
        "title": "4-Bay Fitted Wardrobe",
        "sizeMm": [3600, 2700, 600],
        "partsCount": 58,
        "cutList": [
          {
            "id": "P-01",
            "name": "Gable Left Carcass",
            "dimensions": [18, 2700, 580],
            "material": "Baltic Birch 18mm",
            "edgeBanding": "1.0mm Impact ABS"
          }
        ]
      }
    ]
  }
}

GET/api/projects/:id/bom

Fetches the complete multi-material Bill of Materials (BOM), sheet-stock yield analysis, and individual component dimensions formatted for CNC beam saws or ERP inventory.

Query Parameters:

• format: json (default) | csv

• sheetStock: 2440x1220 | 3050x1525

3. Vault Webhook Subscriptions

Configure real-time webhooks to trigger downstream fabrication actions whenever a client reviews or approves a 3D design:

// Event: project.client_sign_off

{ "event": "project.approved", "projectId": "proj_994a", "clientFeedback": "Approved for CNC" }

Ready for Enterprise API Access?

Contact our engineering team to request dedicated API throughput, custom webhook endpoints, and ERP synchronization.

Contact API Engineering Desk