---
title: "Start a Run"
method: POST
path: "/runs/{runId}/start"
tags: ["Run"]
---

# Start a Run

`POST /runs/{runId}/start`

## Request

- Base URL: `https://api.server.test/v1`
- URL: `https://api.server.test/v1/runs/{runId}/start`
- Auth: none declared
- TypeScript: <https://skmtc.dev/natlabrockies/apis/alfalfa-boptest-unified-virtual-building-control-api-abuvbca/docs/runs/:runId/start/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `runId` string, required

## Request body

- object
  - `startDatetime` string, date-time, required: Start Time
  - `endDatetime` string, date-time, required: End Time
  - `timescale` number: Time multiplier determining simulation speed
  - `externalClock` boolean: When true the Run will only advance when triggered via the API
  - `realtime` boolean: Simulate the model in realtime

## Response `204`

The run was started

---

[API](https://skmtc.dev/natlabrockies/apis/alfalfa-boptest-unified-virtual-building-control-api-abuvbca.md) - [All operations](https://skmtc.dev/natlabrockies/apis/alfalfa-boptest-unified-virtual-building-control-api-abuvbca/llms.txt) - [OpenAPI document](https://skmtc.dev/natlabrockies/apis/alfalfa-boptest-unified-virtual-building-control-api-abuvbca/revisions/82daf0dd2712?raw)