REST API
Comprehensive reference for the NOS REST API endpoints.
The NOS REST API provides programmatic access to all platform features. All endpoints are served under the /api base path and return JSON responses.
Base URL
All API requests should be made to:
https://your-nos-instance.com/api
Available Resources
The API is organized around the following resources:
- Projects -- Create, read, update, and delete projects.
- Datasets -- Upload and manage datasets within projects.
- Pipelines -- Define, submit, and monitor pipeline workflows.
- Simulations -- Configure, run, and inspect simulation workloads.
- Users -- Manage user profiles and account settings.
OpenAPI Specification
The full API specification is available as an OpenAPI 3.1.1 document at the /api/openapi.json endpoint. You can use this specification with tools like Swagger UI or Postman to explore and test the API interactively.