Eriksson Beam API Documentation

Welcome to the official Eriksson Beam API documentation. The API allows you to programmatically interact with Eriksson Beam, enabling automation, batch processing, and integration with your own applications.

Section Description
Getting Started Installation, setup, and your first connection
API Reference Architecture, connection methods, and data operations
Guides Best practices, error handling, and common tasks
Troubleshooting Connection issues, data problems, and FAQ

5-Minute Quick Start

using ErikssonBeam.API.BeamClient;
using ErikssonBeam.API.BeamDesigner;

// Launch Eriksson Beam with a project file
var args = new ErikssonBeamLauncherArgs
{
    LicenseKey = Environment.GetEnvironmentVariable("ERIKSSON_LICENSE_KEY"),
    ExecutablePath = @"C:\Program Files\Eriksson Software\Eriksson Beam\ErikssonBeam.exe",
    FilesToOpen = new[] { @"C:\Projects\MyBeam.ebf" },
    CloseErikssonBeamOnClientDisconnect = true
};

using (var launcher = await ErikssonBeamLauncher.LaunchErikssonBeam(args))
{
    // Pull current design data
    var design = await launcher.Client.PullBeamDesignerAsync();

    // Modify values
    design.DesignCriteria.ProjectInformation.DesignerName = "Jane Doe";

    // Push changes back
    await launcher.Client.PushBeamDesignerAsync("", design);
}

What You Can Do

  • Pull Data - Retrieve all input data from beam projects
  • Push Data - Update input fields programmatically
  • File Operations - Create, open, and save project files
  • Batch Processing - Process multiple projects in sequence

Supported Data

Category Examples
Concrete Extents T-Beam, I-Beam, Rectangular, Hollow Core, and more
Design Criteria Project info, materials, load combinations, settings
Structural Model Loading, bearing, dapped ends, shoring
Reinforcement Prestress strands, rebar, transverse, welded wire

Need Help?