API v1Посмотреть документы в архиве

Посмотреть документы в архиве

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

POST/imports/preview

Возвращает список документов архива для выбора разделов. Не запускает проверку и не списывает проверки. После выбора разделов отправьте исходный архив через POST /runs.

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

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

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

POST /imports/preview

curl --fail-with-body -X POST "$NK_BASE/imports/preview" \
  -H "Authorization: Bearer $NK_KEY" \
  -F "file=@project.zip"

Тело запроса

multipart/form-data

fileстрока · обязательное: Архив или документ для предварительного просмотра.

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

`200`

Документы и пропущенные файлы

application/json

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

{
  "documents": [
    {
      "name": "АР/AR.pdf",
      "size": 123456,
      "kind_guess": "АР"
    }
  ],
  "skipped": []
}

Поля ответа

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

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

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

nameстрока · обязательное
sizeцелое число · обязательное
kind_guessстрока / null · обязательное

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

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

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

строка

`400`

Неподдерживаемый или повреждённый файл

application/json

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

{
  "detail": {
    "error": "bad_format"
  }
}

Поля ответа

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

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

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

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

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

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

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

`401`

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

application/json

Поля ответа

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

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

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

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

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

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

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

`403`

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

application/json

Поля ответа

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

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

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

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

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

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

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

`413`

Размер превышает лимит подключения

application/json

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

{
  "detail": {
    "error": "too_big"
  }
}

Поля ответа

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

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

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

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

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

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

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

`422`

Не передано multipart-поле file

`507`

Недостаточно временного места. повторите позже

application/json

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

{
  "detail": {
    "error": "storage_full_retry"
  }
}

Поля ответа

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

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

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

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

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

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

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