🚀 Engineer the Future with the new SPACE GASS API (COMING SOON!)

Getting Started
Examples
Guides
API Reference

Authentication Service Automation File Handling Running Analysis Filtering & Querying Bulk Operations Error Handling API Versioning Licensing

powered by Zudoku

Guides

File Handling

The API provides endpoints for managing SPACE GASS .sg project files — opening, saving, closing, and checking file status before operations.

Opening a File

Checking File Status

Before opening a file, you can check its status to determine if it is locked by another process or has unsaved changes:

Saving

The save endpoint handles both saving to the current path and saving to a new path. Pass a filePath to save as a new file, or omit it to save in place.

Creating a New Job

Creating a New Job From a Template

Upload a .sgbase template file to seed a new job. The template data is loaded but the new job has no file path — use Job.Save with a FilePath (see Saving) to write it to disk.

The body is a multipart/form-data upload. Both SDKs expose this via the Kiota MultipartBody abstraction with one part named template.

Closing

Last modified on May 4, 2026

Service Automation Running Analysis

On this page

Opening a File
Checking File Status
Saving
Creating a New Job
Creating a New Job From a Template
Closing

using SpaceGassApi.Models;

await client.Job.Open.PostAsync(
    new OpenJobRequest
    {
        FilePath = @"C:\Projects\MyStructure.sg"
    });

var status = await client.File.Status.GetAsync(config =>
    config.QueryParameters.FilePath = @"C:\Projects\MyStructure.sg");

// status contains CanOpenSafely, Description, RecommendedAction

// Save to current file
await client.Job.Save.PostAsync(new SaveJobRequest());

// Save to a new file path
await client.Job.Save.PostAsync(
    new SaveJobRequest
    {
        FilePath = @"C:\Projects\MyStructure_Copy.sg"
    });

await client.Job.New.PostAsync();

using Microsoft.Kiota.Abstractions;

var multipart = new MultipartBody { RequestAdapter = client.RequestAdapter };
using var stream = File.OpenRead(@"C:\Templates\my-template.sgbase");
multipart.AddOrReplacePart("template", "application/octet-stream", stream);

await client.Job.NewFromTemplate.PostAsync(multipart);

await client.Job.Close.PostAsync();