API Reference

Overview of the NOS API and how to integrate with the platform programmatically.

NOS provides a REST API that allows you to interact with the platform programmatically. You can manage projects, datasets, pipelines, and simulations through API calls.

Overview

The API follows RESTful conventions and returns JSON responses. All endpoints are served under the /api base path. The API specification is generated from an OpenAPI 3.1.1 schema.

Getting Started with the API

To begin using the API, you will need to authenticate your requests. See the Authentication guide for details on obtaining and using session credentials.

Available Endpoints

For a comprehensive list of endpoints, request/response schemas, and example payloads, see the REST API reference.