Перейти к содержимому

Статус задачи

Базовый URL https://api.accessful.de/api/v1/upload-service. Каждому запросу нужен заголовок X-API-Key — см. Аутентификация.

GET /job-status/{caseId}

200 OK — завершённый кейс:

{ "jobStatus": "completed", "stage": "finished", "score": 87 }

score — это качество доступности результата, 0–100 (имеет смысл после completed). 404 возвращается для неизвестного caseId.

jobStatus Значение
queued Ожидает в очереди.
running Обрабатывается в данный момент.
completed Готово — результат готов к скачиванию. конечный
failed Обработка не удалась. конечный
analyzer_failed Шаг анализа доступности не удался. конечный
canceled Задача была отменена. конечный
quota_pending Ожидает асинхронной проверки квоты.
quota_exceeded Отклонено — договорная квота исчерпана. конечный

При опросе останавливайтесь, как только увидите конечное состояние.

Наряду с jobStatus каждый ответ содержит поле stage — детализированную фазу конвейера, ортогональную грубому статусу. Используйте его, чтобы показывать прогресс сверх простого «выполняется»: длительную фазу ИИ-исправления можно отличить от анализа.

stage Значение
queued Принято, ожидает старта первого анализа.
analyzing Выполняется первичный анализ загруженного файла.
resolving Выполняется ИИ-исправление файла.
revalidating Выполняется повторный анализ исправленного файла.
finished Обработка завершена; score отражает итоговый файл.
failed Обработка остановлена из-за неустранимой ошибки.

Пока кейс находится в состоянии queued, ответ также сообщает, на каком месте в очереди анализа он стоит — ту же текущую «позицию ожидания», что показывает веб-интерфейс, — чтобы вы могли показать осмысленное «7 из 23, ~5 мин» вместо статичного «queued».

200 OK — кейс, который ещё ожидает:

{
"jobStatus": "queued",
"stage": "queued",
"score": 0,
"queuePosition": 7,
"queueTotal": 23,
"estimatedWaitSeconds": 300
}
Поле Тип Примечания
queuePosition integer Ранг в очереди, начиная с 1 (1 = обрабатывается следующим).
queueTotal integer Общее число кейсов, ожидающих в данный момент (длина очереди).
estimatedWaitSeconds integer Приблизительная оценка ожидания в секундах, выведенная из глубины очереди и пропускной способности анализатора. Может отсутствовать, если оценка недоступна.

Позиция — это приблизительный текущий снимок, пересчитываемый при каждом запросе: она только уменьшается по мере обработки стоящих впереди кейсов, и одно снятие с очереди сдвигает всех, кто позади. В качестве push-альтернативы зарегистрируйте вебхук case.queued, чтобы получать стартовую позицию в момент приёма кейса.