Quick Start

Start the Service

The API runs as a local server. The easiest way to start it is to double-click the SPACE GASS API shortcut under the SPACE GASS Windows application folder.

Alternatively, open a terminal and run:

Code
"C:\Program Files\SPACE GASS 14.5\SpaceGassApi.exe"

By default the service starts on http://localhost:34560. To use a different port, pass the --port flag:

Code
"C:\Program Files\SPACE GASS 14.5\SpaceGassApi.exe" --port=5025

Leave the terminal or shortcut window open — the service runs until you close it.

Explore the API

Once the service is running, open your browser and navigate to:

Code
http://localhost:34560/swagger

The interactive Swagger UI lets you browse every endpoint, see request and response schemas, and make live API calls directly from your browser — no SDK or code required. This is the quickest way to get familiar with the API.

When you are ready to integrate the API into your own code, continue with the steps below.

Create a Project Folder and Install the SDK

The API includes generated SDK clients for C# and Python. These handle serialisation and give you typed methods for every endpoint. If you prefer raw HTTP, you can skip this step and use the curl tab in every snippet below.

Create the Client

The SDK provides a CreateClient() factory that configures everything for you — it connects to the local API with no additional setup required. See Authentication for details on custom URLs and future API key support.

Open a Sample Project

Job.OpenSample loads one of the built-in SPACE GASS samples as a new unsaved job — perfect for getting going without your own .sg file. List available samples with GET /file/samples (or browse them in Swagger); here we'll open Portal Frame.SG, which ships with every install.

When you have your own file, use Job.Open with FilePath instead. See File Handling for the full set of open/save/close patterns.

Get All Nodes

Close the Project