Документы
Документы базы знаний: список, добавление файла, статус обработки, переименование, включение и выключение, удаление.
Объект Document
Поле | Тип | Описание |
| string | Идентификатор документа |
| string | Название, от 1 до 255 символов |
| string | Источник: |
| string | Статус — см. ниже |
| object | При |
| object | При |
| integer | Число фрагментов; |
| integer | Число символов; |
| string | Время добавления |
| string | Время последнего изменения |
Статусы документа
Статус | Что значит |
| Документ добавлен и ждёт обработки |
| Документ обрабатывается — ход обработки в поле |
| Документ обработан и включён: агент использует его в ответах |
| Документ выключен: агент его не использует |
| Обработать документ не удалось |
| Документ базы знаний с поиском архивирован в интерфейсе; изменить его через API нельзя. Архивные файлы файловой базы знаний в API не видны |
Список документов
GET /v1/knowledge-bases/{knowledge_base_id}/documents
Документы базы знаний с поиском идут от новых к старым, файловой базы знаний — в том же порядке, что в интерфейсе.
Параметры запроса
Параметр | Тип | Обязательный | Описание |
| integer | нет | Номер страницы, по умолчанию 1 |
| integer | нет | Размер страницы: от 1 до 100, по умолчанию 20 |
| string | нет | Поиск по названию |
| string | нет | Фильтр по статусу: |
Ответ
200 — постраничный список {items, total, has_more} объектов Document.
Добавление документа
POST /v1/knowledge-bases/{knowledge_base_id}/documents
Content-Type: multipart/form-data
Поля формы
Поле | Тип | Обязательное | Описание |
| file | да | Файл документа. Один файл на запрос: несколько файлов — |
Форматы и размер файла зависят от типа базы знаний: у базы знаний с поиском — CSV, DOC, DOCX, HTM, HTML, MARKDOWN, MD, MDX, PDF, PPT, PPTX, PROPERTIES, TXT, VTT, XLS, XLSX до 50 МБ, у файловой — CSV, XLS, XLSX до 100 МБ.
Ответ
201 — объект Document.
База знаний с поиском. Документ приходит со статусом
queuedи обрабатывается с теми же параметрами, что документ, добавленный в интерфейсе. Чтобы узнать, когда он готов, запрашивайте документ: статус сменится наprocessing, затем наenabledилиerror.Файловая база знаний. Документ сразу приходит со статусом
enabledи доступен агенту без ожидания.
curl https://api.evo-ai.ru/v1/knowledge-bases/3a9d5e27-8c14-4b6f-a0e2-7d1c9b5f3e82/documents \ -H "Authorization: Bearer evo_kb_..." \ -F "file=@price-list.xlsx"
{ "id": "b61f0d3c-4e92-47a8-9c5d-1a7e3f8b2d09", "name": "price-list.xlsx", "source": "file", "status": "queued", "error": null, "progress": null, "chunk_count": 0, "word_count": null, "created_at": "2026-09-24T10:25:00Z", "updated_at": "2026-09-24T10:25:00Z" }
Замена данных в файловой базе знаний
Отдельного метода замены файла нет. Чтобы обновить данные, удалите документ и добавьте новый файл. Замена всегда выполняется в два запроса, поэтому есть окно, когда агент видит не то состояние базы, которое ожидается:
«удалить → добавить» — какое-то время база без этих данных;
«добавить → удалить» — какое-то время в базе оба набора данных.
Выбирайте порядок исходя из того, что менее критично для вашего сценария. Сохраняйте id документа из ответа — он нужен, чтобы потом удалить документ.
Документ
GET /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}
200 — объект Document.
Изменение документа
PATCH /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}
Меняются только переданные поля.
Тело запроса
Поле | Тип | Описание |
| string | Новое название, от 1 до 255 символов |
| boolean |
|
Выключить документ, который ещё не обработан, нельзя. Включать и выключать документ нельзя и пока он переиндексируется после прошлого включения или выключения. В обоих случаях —
400с кодомdocument_processing, и документ не меняется.Архивный документ базы знаний с поиском изменить нельзя:
400с кодомdocument_archived.
Ответ
200 — объект Document.
curl -X PATCH https://api.evo-ai.ru/v1/knowledge-bases/3a9d5e27-8c14-4b6f-a0e2-7d1c9b5f3e82/documents/b61f0d3c-4e92-47a8-9c5d-1a7e3f8b2d09 \ -H "Authorization: Bearer evo_kb_..." \ -H "Content-Type: application/json" \ -d '{"enabled": false}'
Удаление документа
DELETE /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}
204 — без тела. Документ, который ещё обрабатывается, тоже удаляется, а его обработка отменяется. Если документа нет, ответ тоже 204.
Ошибки
HTTP | Код | Когда |
|
| При добавлении не передано поле |
|
| При добавлении в поле |
|
| Файл больше допустимого размера |
|
| Формат не подходит для этого типа базы знаний |
|
| В файловой базе знаний уже столько файлов, сколько она вмещает; текст ошибки называет предел |
|
| Файл не помещается в объём файловой базы знаний; текст ошибки называет предел в МБ |
|
| База знаний с поиском: исчерпан лимит документов тарифа |
|
| База знаний с поиском: исчерпан объём тарифа — при добавлении, включении или выключении документа |
|
| Документ ещё обрабатывается или переиндексируется |
|
| Изменение архивного документа |
|
| Модель эмбеддингов базы знаний недоступна — включить, выключить или удалить документ нельзя, пока модель не восстановлена |
|
| Базы нет или она недоступна ключу |
|
| Документа нет в этой базе знаний |
|
| Превышен лимит запросов тарифа — добавление, изменение и удаление учитываются в нём |