---
title: "Start a workflow run"
method: POST
path: "/api/v1/project-rooms/{id}/runs"
tags: ["Projects"]
---

# Start a workflow run

`POST /api/v1/project-rooms/{id}/runs`

## Request

- Base URL: `https://askthegrid.com`
- URL: `https://askthegrid.com/api/v1/project-rooms/{id}/runs`
- Auth: HTTP bearer

Runs on the server as the caller, whether or not anyone watches; poll the run for its state.

## Path parameters

- `id` string, required

## Request body

- object
  - `workflow` string, required
  - `note` string
  - `skip` string[]

## Response `200`

Success

- object
  - `run` object, required
    - `id` string, required
    - `slug` string, required
    - `title` string, required
    - `note` string
    - `startedAt` string, required
    - `state` 'running' | 'filed' | 'stopped' | 'not-finished', required
    - `stages` object, required
      - `done` integer, required
      - `total` integer, required
    - `stoppedBecause` string
    - `outputs` string[], required
    - `findings` string[], required
    - `jobId` string

## Other responses

- `400`: The request did not match the contract.
- `401`: Missing or invalid credentials.
- `429`: Rate limit exceeded. Wait `Retry-After` seconds; `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset` report the budget. Signed-in sessions and API keys have larger budgets than anonymous callers.

---

[API](https://skmtc.dev/askthegrid/apis/ask-the-grid-api.md) · [All operations](https://skmtc.dev/askthegrid/apis/ask-the-grid-api/llms.txt) · [OpenAPI document](https://skmtc.dev/askthegrid/apis/ask-the-grid-api/revisions/9cd80115e395?raw)