---
title: "Cancel a workflow and its running jobs"
method: POST
path: "/assistant/workflows/{workflowId}/cancel"
tags: ["Assistant"]
---

# Cancel a workflow and its running jobs

`POST /assistant/workflows/{workflowId}/cancel`

## Path parameters

- `workflowId` string, required

## Response `200`

The workflow after the cancel

- AssistantWorkflowResponse
  - `data` AssistantWorkflowSummary, required
    - `id` string, required
    - `kind` string, required — document_emissions, bom_footprint or supplier_research
    - `status` string, required — active, waiting_job, waiting_user, completed, failed or cancelled
    - `step` string, required — document_emissions: UPLOADED, EXTRACTING, ROWS_READY, NEEDS_REVIEW, SUBMITTED, EXTRACTION_FAILED, CANCELLED. bom_footprint: SCANNED, IMPORTING, LINES_READY, FOOTPRINT_READY, NEEDS_REVIEW, SAVED, IMPORT_FAILED, CANCELLED. supplier_research: RESEARCHING, RESEARCHED, RESEARCH_FAILED. EXTRACTING and IMPORTING also cover a re-run started on the review page (waitingFor ui_action); CANCELLED is a record deleted on its page.
    - `stepCount` integer, required
    - `stepIndex` integer, required
    - `stepLabel` string, required
    - `title` string, required
    - `updatedAt` string, date-time, required
    - `waitingFor` object, nullable
      - `kind` string — job, user_confirm or ui_action
      - `ref` string

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

## Changes

- **2026-10-01** `b4751fd15397` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/greentally/apis/esgai-api/changes/assistant/workflows/:workflowId/cancel/post.md)

---

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