API Reference

This section provides detailed documentation for all Network Simulation API endpoints.

Endpoints Overview

Tag	Description	Endpoints
Charts	Chart definitions served to the simulation UI (feature-gated: enable_chart_definitions)	1
Components	Component schema discovery	2
Configurations	Workload configuration management	34
Health	Health and monitoring endpoints	2
Models	Model catalog and discovery	3
Simple	Simple collective-operation simulation	3
Simulations	Simulation execution and results	9
Templates	Curated example configurations	4
Topology	Real-time topology validation	1
Tracesets	Trace file management (feature-gated: enable_trace_routes)	7
Workspaces	Workspace management	2

List endpoints return paginated results. Use the limit and next parameters:

# First page
GET /api/v1/workspaces?limit=50

# Next page
GET /api/v1/workspaces?limit=50&next=<cursor>

All errors follow a consistent format:

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message"
  }
}

All endpoints require bearer token authentication:

curl -H "Authorization: Bearer YOUR_TOKEN" ...