API Reference

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

Endpoints Overview

Tag	Description	Endpoints
Billing	Billing balance, costs, items, events, and rates (feature-gated: enable_billing_endpoints)	7
Charts	Chart definitions served to the simulation UI	1
Components	Component schema discovery	2
Configurations	Workload configuration management	34
Health	Health and monitoring endpoints	2
Libraries	Content-addressed trace libraries (feature-gated: enable_trace_routes)	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)	9
Workspaces	Workspace management	6

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" ...