Guides

Error Handling

Every error response from the API uses a standard ErrorResponse envelope. All error responses include a JSON body with diagnostic information.

Error Response Format


Code
{
  "title": "Bad Request",
  "status": 400,
  "detail": "Node with Id 1 already exists",
  "errorCode": "DUPLICATE_ENTITY",
  "errors": [
    { "field": "id", "message": "Node with Id 1 already exists", "code": "DUPLICATE_ENTITY" }
  ],
  "source": "Application",
  "timestamp": "2026-05-18T10:30:00+10:00"
}

Field	Type	Description
`title`	`string`	Short human-readable summary
`status`	`int`	HTTP status code
`detail`	`string`	Human-readable explanation specific to this occurrence
`errorCode`	`string`	Machine-readable error code for programmatic handling
`errors`	`ValidationError[]`	One entry per failed validation rule (field, message, code)
`source`	`string`	Where the error originated (e.g. `"Application"`, `"Infrastructure"`)
`timestamp`	`string`	ISO 8601 timestamp when the error occurred
`instance`	`string`	URI reference for the specific occurrence
`extensions`	`object`	Additional context-specific data

HTTP Status Codes

Status	Meaning
`400`	Bad request — validation failure or invalid input
`404`	Not found — resource does not exist
`409`	Conflict — operation conflicts with current state (e.g., file locked)
`500`	Server error — unexpected internal failure

Handling Errors in SDK Clients

The SDK raises a typed ErrorResponse exception that carries the fields from the JSON body — Status, Title, Detail, ErrorCode, Errors, and more. Catch it directly so you can inspect the structured error rather than relying on the generic exception message:

ErrorResponse inherits from Kiota's base ApiException (C#) / APIError (Python), so you can still catch the broader type if you need to handle transport errors (network drops, timeouts) the same way.

Edit this page

Last modified on May 18, 2026

Bulk Operations API Versioning

Error Response Format

Code

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Node with Id 1 already exists",
  "errorCode": "DUPLICATE_ENTITY",
  "errors": [
    { "field": "id", "message": "Node with Id 1 already exists", "code": "DUPLICATE_ENTITY" }
  ],
  "source": "Application",
  "timestamp": "2026-05-18T10:30:00+10:00"
}

Field

Type

Description

title

string

Short human-readable summary

status

int

HTTP status code

detail

string

Human-readable explanation specific to this occurrence

errorCode

string

Machine-readable error code for programmatic handling

errors

ValidationError[]

One entry per failed validation rule (field, message, code)

source

string

Where the error originated (e.g. "Application", "Infrastructure")

timestamp

string

ISO 8601 timestamp when the error occurred

instance

string

URI reference for the specific occurrence

extensions

object

Additional context-specific data

Status

Meaning

400

Bad request — validation failure or invalid input

404

Not found — resource does not exist

409

Conflict — operation conflicts with current state (e.g., file locked)

500

Server error — unexpected internal failure

Handling Errors in SDK Clients

using SpaceGassApi.Models;

try
{
    var node = await client.Job.Structure.Nodes[999].GetAsync();
}
catch (ErrorResponse err) when (err.Status == 404)
{
    Console.WriteLine($"Node not found: {err.Detail}");
}
catch (ErrorResponse err)
{
    Console.WriteLine($"API error {err.Status} ({err.Title}): {err.Detail}");
    if (err.ErrorCode != null)
        Console.WriteLine($"  Code: {err.ErrorCode}");
    foreach (var ve in err.Errors ?? [])
        Console.WriteLine($"  [{ve.Field}] {ve.Message}");
}

Edit this page

Last modified on May 18, 2026