Получить лимиты своей организации
/limitsПроверяйте комплект по лимитам своего подключения. oversize_factor=1 запрещает превышение. Размеры указаны в байтах. max_files учитывает документы после распаковки. Число страниц определяется после подготовки документов.
Передайте ключ организации в заголовке Authorization: Bearer <ключ>.
Пример запроса
Используйте NK_BASE и NK_KEY из быстрого старта. Переменные в пути, например RUN_ID, замените значениями из ваших ответов API.
curl --fail-with-body "$NK_BASE/limits" \
-H "Authorization: Bearer $NK_KEY"Ответы и ошибки
200
Успешный ответ.
application/json
Поля ответа
max_filesцелое число · обязательное- Число документов после распаковки архивов. Ноль означает отсутствие этого ограничения в профиле.
max_file_bytesцелое число · обязательное- Размер одного файла в байтах. Ноль означает отсутствие этого ограничения в профиле.
max_total_bytesцелое число · обязательное- Размер комплекта в байтах. Ноль означает отсутствие этого ограничения в профиле.
max_pagesцелое число · обязательное- Число страниц комплекта. Ноль означает отсутствие этого ограничения в профиле.
oversize_factorцелое число · обязательное- 1 запрещает превышение лимита. 2 разрешает двойной объём. Сервер учитывает объём при списании проверок.
401
Ключ не передан, неверен или отозван.
application/json
Поля ответа
detailобъект / массив: объект / строка · обязательное- Обычно объект с error. При ошибке проверки параметров возможен список нарушений.
Вложенные поля
errorстрока · обязательное- Машинный код ошибки. Используйте его в обработчике.
messageстрока · необязательное- Пояснение для человека. Текст может меняться.
fileстрока · необязательное- Проблемный файл, если ошибка относится к нему.
Массив элементов:
locмассив: строка / целое число · необязательное- Путь до неверного поля.
msgстрока · необязательное- Причина нарушения.
typeстрока · необязательное- Код нарушения.
inputобъект · необязательное- Переданное значение.
Текст ошибки, если сервер не вернул объект.
403
Доступ закрыт или действие не разрешено.
application/json
Поля ответа
detailобъект / массив: объект / строка · обязательное- Обычно объект с error. При ошибке проверки параметров возможен список нарушений.
Вложенные поля
errorстрока · обязательное- Машинный код ошибки. Используйте его в обработчике.
messageстрока · необязательное- Пояснение для человека. Текст может меняться.
fileстрока · необязательное- Проблемный файл, если ошибка относится к нему.
Массив элементов:
locмассив: строка / целое число · необязательное- Путь до неверного поля.
msgстрока · необязательное- Причина нарушения.
typeстрока · необязательное- Код нарушения.
inputобъект · необязательное- Переданное значение.
Текст ошибки, если сервер не вернул объект.
Другой ответ
Ошибка входного сервера или сети может иметь текстовое/HTML-тело. Проверяйте HTTP-статус и Content-Type.