---
title: "Stop the running onboarding run"
method: POST
path: "/api/v1/onboarding/cancel"
tags: ["onboarding"]
---

# Stop the running onboarding run

`POST /api/v1/onboarding/cancel`

## Request

- Base URL: `https://api.cadencz.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.cadencz.com/api/v1/onboarding/cancel`
- Auth: HTTP bearer

Stop setup and hand the workspace back.

Deliberately not a 409 when the run has already finished: the button exists
because a run looked stuck, and telling someone their stop failed because
the thing stopped on its own is a worse answer than the run itself.

## Response `200`

Successful Response

- OnboardingRunRead
  - `id` string, required
  - `source_kind` string
  - `url` string, nullable
  - `company_name` string, nullable
  - `status` string, required
  - `current_step` string, nullable
  - `steps` OnboardingStepRead[]
    - `key` string, required
    - `label` string, required
    - `status` string, required
    - `detail` string
    - `started_at` string, nullable
    - `finished_at` string, nullable
  - `error` string, nullable
  - `brain_id` string, nullable
  - `content_plan_id` string, nullable
  - `created_at` string, date-time, required
  - `finished_at` string, date-time, nullable

## Other responses

- `401`: Missing or invalid Supabase bearer token.
- `404`: The requested resource was not found.

---

[API](https://skmtc.dev/cadencz/apis/cadencz-api.md) · [All operations](https://skmtc.dev/cadencz/apis/cadencz-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cadencz/apis/cadencz-api/revisions/3392fe5e93db?raw)