POST /api/v1/runs/{run_guid}/cancel

Статус: GA Доступ: по токену контракт API: 0.3.0 · capability 2026-09-03.1 Открыть как Markdown Открыть в Claude Открыть в ChatGPT

Cancel Run

Cancel a run. A queued run is cancelled immediately; a run that is already executing is marked cancelled but finishes its current execution (mid-flight interruption is not implemented). Idempotent: a terminal run answers 409.

Авторизация: нужен Authorization: Bearer <token>

Запрос

curl -sS -X POST "https://entherium.duckdns.org:8443/api/v1/runs/<run_guid>/cancel" \
  -H "Authorization: Bearer <token>"

Ответ `200`

{
  "createtime": "2026-09-03T02:14:04Z",
  "current_step": "make_article_structure",
  "entity_guid": 31567,
  "entity_name": "generated_articles",
  "guid": 1842,
  "metrics": {
    "llm_calls": 11
  },
  "mode": "live",
  "pipeline_id": "generate",
  "started_at": "2026-09-03T02:14:05Z",
  "started_by": "agent@entherium.dev",
  "status": "running",
  "steps_done": 7,
  "steps_total": 18,
  "trigger": "api",
  "updatetime": "2026-09-03T02:19:40Z"
}

Возвращает

PipelineRunRead — Successful Response

Поле	Тип	Описание
`createtime`	`string`
`current_step`	`string \| null` (opt.)
`entity_guid`	`integer`
`entity_name`	`string`
`error`	`string \| null` (opt.)
`error_step`	`string \| null` (opt.)
`finished_at`	`string \| null` (opt.)
`guid`	`integer`
`metrics`	`object` (opt.)
`mode`	`string`
`pipeline_id`	`string`
`started_at`	`string \| null` (opt.)
`started_by`	`string \| null` (opt.)
`status`	`string`
`steps_done`	`integer`
`steps_total`	`integer`
`trigger`	`string`
`updatetime`	`string`

Параметры

Параметр	Где	Обязателен	Тип	По умолчанию	Ограничения	Описание
`run_guid`	path	да	`integer`	—	—
`Idempotency-Key`	header	нет	`string`	—	uuid	Optional.

Ошибки

Код	Смысл	Тело
`401`	Missing or invalid authentication credentials	`ErrorResponse`
`409`	The run is already terminal	`ErrorResponse`
`422`	Validation Error	`HTTPValidationError`

Тело любой ошибки — {detail, code?, request_id, doc_url}: request_id — что цитировать, doc_url ведёт в Справочник ошибок.