---
title: "Start run"
method: POST
path: "/api/v1/runs/start"
tags: ["runs"]
---

# Start run

`POST /api/v1/runs/start`

Start a new run for tracking

## Request body

- StartRunRequest
  - `config` RawPluginConfig
  - `pipeline_name` string, required
  - `source_name` string, required

## Response `200`

OK

- PluginRun
  - `completed_at` string
  - `config` RawPluginConfig
  - `created_by` string
  - `error_message` string
  - `id` string
  - `pipeline_name` string
  - `run_id` string
  - `source_name` string
  - `started_at` string
  - `status` 'running' | 'completed' | 'failed' | 'cancelled'
  - `summary` RunSummary
    - `assets_created` integer
    - `assets_deleted` integer
    - `assets_terms_linked` integer
    - `assets_updated` integer
    - `documentation_added` integer
    - `duration_seconds` integer
    - `errors_count` integer
    - `glossary_terms_created` integer — Glossary counts are absent from runs that predate them, and from sources that curate no business terms.
    - `glossary_terms_updated` integer
    - `lineage_created` integer
    - `lineage_updated` integer
    - `total_entities` integer

---

[API](https://skmtc.dev/marmotdata/apis/marmot-api.md) · [All operations](https://skmtc.dev/marmotdata/apis/marmot-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/marmotdata/marmot-api/revisions/0bd802afff21/schema)