API v1Снять проверку с очереди

Снять проверку с очереди

Обновлено 8 октября 2026

POST/runs/{run_id}/cancel

Отменяет проверку своей организации, пока она в очереди. Возвращает обновлённое состояние. Списанная проверка возвращается на счёт. После начала обработки или завершения отмена недоступна.

Передайте ключ организации в заголовке Authorization: Bearer <ключ>.

Пример запроса

Используйте NK_BASE и NK_KEY из быстрого старта. Переменные в пути, например RUN_ID, замените значениями из ваших ответов API.

POST /runs/{run_id}/cancel

curl --fail-with-body -X POST "$NK_BASE/runs/$RUN_ID/cancel" \
  -H "Authorization: Bearer $NK_KEY"

Параметры

Параметр	Где / тип	Обязательный	Описание
`run_id`	Путь строка	Да	Идентификатор из ответа POST /runs.

Ответы и ошибки

`200`

Обновлённое состояние проверки

application/json

Поля ответа

run_idстрока · обязательное

Идентификатор проверки. Сохраните его после загрузки.

statusстрока · обязательное

queued — в очереди. running — обработка или публикация. done — результат готов. failed — проверка не завершилась. Значения: "queued", "running", "done", "failed".

filenameстрока · необязательное

Название комплекта или имя файла.

stageстрока · необязательное

Код этапа. Набор кодов может пополняться.

stage_textстрока · необязательное

Название этапа для человека.

findingsцелое число / null · необязательное

Число замечаний. До публикации равно null.

documentsмассив: объект · обязательное

Документы комплекта.

Вложенные поля

Массив элементов:

indexцелое число · обязательное: Номер документа в составе комплекта, начиная с 1.
nameстрока · обязательное: Имя документа.
kindстрока / null · необязательное: Код раздела. null означает, что раздел не определён.
kind_chosenда / нет · необязательное: Раздел принят из поля kinds.
kind_guessстрока / null · необязательное: Результат распознавания, если доступен.
pagesцелое число / null · необязательное: Число страниц после подготовки.
convertedда / нет · необязательное: Документ преобразован в PDF.
page_fromцелое число / null · необязательное: Первая сквозная страница документа.
page_toцелое число / null · необязательное: Последняя сквозная страница документа.

objectобъект · необязательное

Вложенные поля

addressстрока / null · необязательное: Адрес объекта, если установлен.
worksстрока / null · необязательное: Наименование работ, если установлено.

user_requestстрока · необязательное

Сохранённое задание клиента. До 8000 символов.

bundleобъект / null · необязательное

Вложенные поля

bundle_idстрока · необязательное: Именованный комплект/проект.
revision_idстрока · необязательное: Версия состава файлов.
labelстрока · необязательное: Название комплекта.

null

volume_unitsцелое число · обязательное

Учтённый объём: 0, 1 или 2. Сверяйте с условиями подключения.

refundedда / нет · обязательное

Был ли возврат проверки на счёт.

errorстрока / null · необязательное

Причина ошибки при status равном failed.

created_atстрока · необязательное

Время приёма.

finished_atстрока / null · необязательное

Время завершения.

available_atстрока / null · необязательное

Время доступности, если определено.

reused_from_run_idстрока / null · необязательное

Источник повторно использованного результата, если есть.

progressобъект / null · необязательное

Вложенные поля

percentцелое число / null · необязательное: Промежуточная оценка готовности. Завершение определяет status.
pages_totalцелое число / null · необязательное: Всего страниц после подготовки.
pages_doneцелое число · необязательное: Число подготовленных страниц.
elapsed_sцелое число · необязательное: Прошло секунд с приёма.
eta_sцелое число / null · необязательное: Оценка оставшегося времени в секундах. null означает, что оценки нет.
eta_high_sцелое число / null · необязательное: Верхняя оценка времени, если доступна.
eta_kindстрока / null · необязательное: Вид оценки времени, если доступен.

null

`401`

Ключ не передан, неверен или отозван.

application/json

Поля ответа

detailобъект / массив: объект / строка · обязательное

Обычно объект с error. При ошибке проверки параметров возможен список нарушений.

Вложенные поля

errorстрока · обязательное: Машинный код ошибки. Используйте его в обработчике.
messageстрока · необязательное: Пояснение для человека. Текст может меняться.
fileстрока · необязательное: Проблемный файл, если ошибка относится к нему.

Массив элементов:

locмассив: строка / целое число · необязательное: Путь до неверного поля.
msgстрока · необязательное: Причина нарушения.
typeстрока · необязательное: Код нарушения.
inputобъект · необязательное: Переданное значение.

Текст ошибки, если сервер не вернул объект.

`403`

Доступ закрыт или действие не разрешено.

application/json

Поля ответа

detailобъект / массив: объект / строка · обязательное

Обычно объект с error. При ошибке проверки параметров возможен список нарушений.

Вложенные поля

errorстрока · обязательное: Машинный код ошибки. Используйте его в обработчике.
messageстрока · необязательное: Пояснение для человека. Текст может меняться.
fileстрока · необязательное: Проблемный файл, если ошибка относится к нему.

Массив элементов:

locмассив: строка / целое число · необязательное: Путь до неверного поля.
msgстрока · необязательное: Причина нарушения.
typeстрока · необязательное: Код нарушения.
inputобъект · необязательное: Переданное значение.

Текст ошибки, если сервер не вернул объект.

`404`

Проверка не найдена

application/json

Пример ответа 404

{
  "detail": {
    "error": "not_found"
  }
}

Поля ответа

detailобъект / массив: объект / строка · обязательное

Обычно объект с error. При ошибке проверки параметров возможен список нарушений.

Вложенные поля

errorстрока · обязательное: Машинный код ошибки. Используйте его в обработчике.
messageстрока · необязательное: Пояснение для человека. Текст может меняться.
fileстрока · необязательное: Проблемный файл, если ошибка относится к нему.

Массив элементов:

locмассив: строка / целое число · необязательное: Путь до неверного поля.
msgстрока · необязательное: Причина нарушения.
typeстрока · необязательное: Код нарушения.
inputобъект · необязательное: Переданное значение.

Текст ошибки, если сервер не вернул объект.

`409`

Проверка уже началась или завершилась

application/json

Пример ответа 409

{
  "detail": {
    "error": "review_already_started"
  }
}

Поля ответа

detailобъект / массив: объект / строка · обязательное

Обычно объект с error. При ошибке проверки параметров возможен список нарушений.

Вложенные поля

errorстрока · обязательное: Машинный код ошибки. Используйте его в обработчике.
messageстрока · необязательное: Пояснение для человека. Текст может меняться.
fileстрока · необязательное: Проблемный файл, если ошибка относится к нему.

Массив элементов:

locмассив: строка / целое число · необязательное: Путь до неверного поля.
msgстрока · необязательное: Причина нарушения.
typeстрока · необязательное: Код нарушения.
inputобъект · необязательное: Переданное значение.

Текст ошибки, если сервер не вернул объект.