> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scalacomputing.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

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

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

## Endpoints Overview

| Tag | Description | Endpoints |
| - | - | - |
| [Charts](https://docs.scalacomputing.com/v0.1.2544/api-reference/charts.md) | Chart definitions served to the simulation UI (feature-gated: enable\_chart\_definitions) | 1 |
| [Components](https://docs.scalacomputing.com/v0.1.2544/api-reference/components.md) | Component schema discovery | 2 |
| [Configurations](https://docs.scalacomputing.com/v0.1.2544/api-reference/configurations.md) | Workload configuration management | 35 |
| Health | Health and monitoring endpoints | 2 |
| [Mapping-Files](https://docs.scalacomputing.com/v0.1.2544/api-reference/mapping-files.md) | Chakra mapping files. The six mapping-file resource operations are served by the trace-service router behind enable\_trace\_routes; the two configuration attach and detach operations are served by central unconditionally. | 8 |
| [Models](https://docs.scalacomputing.com/v0.1.2544/api-reference/models.md) | Model catalog and discovery | 3 |
| [Simple](https://docs.scalacomputing.com/v0.1.2544/api-reference/simple.md) | Simple collective-operation simulation | 3 |
| [Simulations](https://docs.scalacomputing.com/v0.1.2544/api-reference/simulations.md) | Simulation execution and results | 10 |
| [Templates](https://docs.scalacomputing.com/v0.1.2544/api-reference/templates.md) | Curated example configurations | 4 |
| [Topology](https://docs.scalacomputing.com/v0.1.2544/api-reference/topology.md) | Real-time topology validation | 1 |
| [Tracesets](https://docs.scalacomputing.com/v0.1.2544/api-reference/tracesets.md) | Trace file management (feature-gated: enable\_trace\_routes) | 7 |
| [Workspaces](https://docs.scalacomputing.com/v0.1.2544/api-reference/workspaces.md) | Workspace management | 2 |

## Common Patterns

### Pagination

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

```bash theme={null}
# First page
GET /api/v1/workspaces?limit=50

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

### Error Responses

All errors follow a consistent format:

```json theme={null}
{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message"
  }
}
```

### Authentication

All endpoints require bearer token authentication:

```bash theme={null}
curl -H "Authorization: Bearer YOUR_TOKEN" ...
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.