Объекты
Error
Стандартный ответ с ошибкой. detail — строка, объект с code (например, choose_org, org_suspended, коды приглашений) или список ошибок проверки (422). error — структурированное описание: код из каталога ошибок, сообщение на английском, структурированные подробности и ID запроса.
Поля
Сообщение об ошибке, объект с кодом или список ошибок проверки.
errorErrorInfo
Используется в
- GET
/v1/healthПолучить статус сервиса и версию - GET
/v1/usersПолучить список пользователей организации - POST
/v1/usersСоздать пользователя - PATCH
/v1/users/{user_id}Изменить пользователя - GET
/v1/api-keysПолучить список ключей API организации - POST
/v1/api-keysСоздать ключ API - DELETE
/v1/api-keys/{key_id}Отозвать ключ API - PATCH
/v1/api-keys/{key_id}Изменить ключ API - POST
/v1/api-keys/{key_id}/rollПеревыпустить ключ API - POST
/v1/api-keys/{key_id}/revoke-previousОтозвать прежнее значение ключа API - GET
/v1/auditПолучить записи журнала аудита - GET
/v1/audit/actionsПолучить действия журнала аудита с количеством - GET
/v1/audit/export.csvВыгрузить журнал аудита в CSV - GET
/v1/orgПолучить организацию - GET
/v1/categoriesПолучить список категорий документов - POST
/v1/categoriesСоздать категорию - DELETE
/v1/categories/{key}Удалить собственную категорию - PATCH
/v1/categories/{key}Изменить категорию - GET
/v1/collectionsПолучить список коллекций, доступных пользователю - POST
/v1/collectionsСоздать коллекцию - DELETE
/v1/collections/{name}Удалить коллекцию - PATCH
/v1/collections/{name}Изменить коллекцию - POST
/v1/collections/{name}/reindexПереиндексировать коллекцию - GET
/v1/collections/{name}/statsПолучить обзор коллекции: статистика, категории, недавние карточки, права - GET
/v1/cardsПолучить список карточек - POST
/v1/cardsЗагрузить файл как карточку - GET
/v1/jobsПолучить список заданий индексации - GET
/v1/jobs/summaryПолучить сводку очереди - GET
/v1/jobs/streamПолучать изменения заданий потоком (SSE) - GET
/v1/jobs/{job_id}Получить задание - DELETE
/v1/jobs/{job_id}Отменить задание в очереди - GET
/v1/cards/countПосчитать карточки - GET
/v1/cards/export.xlsxВыгрузить список карточек в XLSX - POST
/v1/cards/bulkВыполнить массовое действие над карточками - GET
/v1/cards/{card_id}Получить карточку с версиями, комментариями, таблицами и событиями - DELETE
/v1/cards/{card_id}Удалить карточку - PATCH
/v1/cards/{card_id}Изменить карточку - GET
/v1/cards-by-external-id/{external_id}Получить карточку по внешнему ID - PUT
/v1/cards-by-external-id/{external_id}Создать или заменить карточку по внешнему ID - GET
/v1/cards/{card_id}/contentПолучить текст карточки по разделам - PUT
/v1/cards/{card_id}/contentЗаменить содержимое карточки - GET
/v1/cards/{card_id}/tables/{table_id}/rowsПолучить строки таблицы фактов - GET
/v1/cards/{card_id}/versions/{a}/diff/{b}Сравнить две версии карточки - GET
/v1/cards/{card_id}/usageПолучить вопросы, в ответах на которые использовалась карточка - POST
/v1/cards/{card_id}/usageЗаписать событие использования карточки - POST
/v1/cards/{card_id}/reindexПереиндексировать карточку - DELETE
/v1/cards/{card_id}/comments/{comment_id}Удалить комментарий - GET
/v1/cards/{card_id}/fileСкачать оригинальный файл карточки - GET
/v1/cards/{card_id}/exportЭкспортировать карточку в документ - POST
/v1/cards/{card_id}/verifyПодтвердить актуальность карточки - POST
/v1/cards/{card_id}/commentsДобавить комментарий - GET
/v1/conversationsПолучить список бесед - GET
/v1/conversations/{conv_id}Получить беседу с её репликами - POST
/v1/searchИскать по коллекциям - POST
/v1/askПолучить ответ ассистента без потоковой передачи - POST
/v1/chatПолучать ответ ассистента потоком (SSE) - POST
/v1/questions/{question_id}/feedbackОценить ответ - GET
/v1/questions/export.csvВыгрузить журнал вопросов в CSV - GET
/v1/questions/{question_id}Получить сохранённый вопрос с ответом - GET
/v1/questions/{question_id}/followupsПолучить подсказки следующих вопросов - GET
/v1/questionsПолучить журнал вопросов - GET
/v1/questions/{question_id}/exportЭкспортировать ответ в документ - GET
/v1/questions/{question_id}/datasets/{dataset_id}/exportВыгрузить набор данных ответа - GET
/v1/questions/{question_id}/answer-tables/{index}/exportВыгрузить таблицу из текста ответа - POST
/v1/questions/{question_id}/refreshОбновить наборы данных ответа (живой ответ) - POST
/v1/questions/{question_id}/save-cardСохранить ответ как карточку - POST
/v1/cards/textСоздать текстовую карточку (Markdown) - GET
/v1/filesПолучить список файлов экспорта - GET
/v1/files/authorsПолучить авторов файлов (для фильтра администратора) - GET
/v1/files/{file_id}Получить сведения о файле - DELETE
/v1/files/{file_id}Удалить файл - GET
/v1/files/{file_id}/downloadСкачать файл - GET
/v1/files/{file_id}/previewПросмотреть файл - POST
/v1/files/{file_id}/extendПродлить срок хранения файла - POST
/v1/files/{file_id}/regenerateПересоздать файл по сохранённым параметрам - GET
/v1/tasksПолучить задачи пользователя или команды - POST
/v1/sourcesСоздать источник - GET
/v1/sources/{source_id}Получить источник - DELETE
/v1/sources/{source_id}Удалить источник - PATCH
/v1/sources/{source_id}Изменить источник - PATCH
/v1/sources/{source_id}/settingsИзменить настройки источника - GET
/v1/cards/{card_id}/similarПолучить похожие карточки - GET
/v1/insights/gapsПолучить пробелы в знаниях (группы вопросов без ответа) - GET
/v1/permissionsПолучить реестр прав - POST
/v1/uploadsНачать загрузку по частям - GET
/v1/uploads/{upload_id}Получить загрузку - DELETE
/v1/uploads/{upload_id}Отменить загрузку - PUT
/v1/uploads/{upload_id}/parts/{n}Отправить часть загрузки - POST
/v1/uploads/{upload_id}/completeЗавершить загрузку - GET
/v1/meПолучить сведения о вызывающем API - GET
/v1/me/permissionsПолучить права текущего пользователя на организацию - GET
/v1/rolesПолучить список ролей (встроенных и собственных) - POST
/v1/rolesСоздать собственную роль - DELETE
/v1/roles/{role_id}Удалить собственную роль - PATCH
/v1/roles/{role_id}Изменить собственную роль - GET
/v1/groupsПолучить список групп организации - POST
/v1/groupsСоздать группу - GET
/v1/groups/{group_id}Получить группу с участниками - DELETE
/v1/groups/{group_id}Удалить группу - PATCH
/v1/groups/{group_id}Переименовать группу - PUT
/v1/groups/{group_id}/members/{user_id}Добавить участника в группу - DELETE
/v1/groups/{group_id}/members/{user_id}Удалить участника из группы - GET
/v1/org/permissionsПолучить права на организацию (кто администратор) - PUT
/v1/org/permissionsНазначить роли на организацию - DELETE
/v1/org/permissionsСнять роли на организацию - GET
/v1/collections/{name}/permissionsПолучить права на коллекцию (прямые и унаследованные) - PUT
/v1/collections/{name}/permissionsНазначить роли на коллекцию - DELETE
/v1/collections/{name}/permissionsСнять роли на коллекцию - GET
/v1/cards/{card_id}/permissionsПолучить права на карточку (прямые и унаследованные) - PUT
/v1/cards/{card_id}/permissionsНазначить роли на карточку - DELETE
/v1/cards/{card_id}/permissionsСнять роли на карточку - GET
/v1/sources/{source_id}/permissionsПолучить права на источник (прямые и унаследованные) - PUT
/v1/sources/{source_id}/permissionsНазначить роли на источник - DELETE
/v1/sources/{source_id}/permissionsСнять роли на источник - POST
/v1/users/{user_id}/offboardУволить пользователя - GET
/v1/collections/{name}/foldersПолучить дерево папок коллекции - POST
/v1/collections/{name}/foldersСоздать папку - GET
/v1/foldersПолучить деревья папок всех коллекций - GET
/v1/folders/{folder_id}Получить папку - DELETE
/v1/folders/{folder_id}Удалить папку и поднять её содержимое - PATCH
/v1/folders/{folder_id}Переименовать, переместить или переупорядочить папку - GET
/v1/folders/{folder_id}/cardsПолучить карточки папки - GET
/v1/folders/{folder_id}/permissionsПолучить права на папку (прямые и унаследованные) - PUT
/v1/folders/{folder_id}/permissionsНазначить роли на папку - DELETE
/v1/folders/{folder_id}/permissionsСнять роли на папку - GET
/v1/catalog/servicesПолучить список сервисов каталога - GET
/v1/catalog/services/{service_id}Получить сервис каталога - GET
/v1/catalog/services/{service_id}/iconПолучить значок сервиса - GET
/v1/catalog/categoriesПолучить список категорий каталога - GET
/v1/catalog/spend-taxonomyПолучить классификацию расходов и доходов - POST
/v1/catalog/resolveСопоставить названия с сервисами каталога - GET
/v1/draftsПолучить список черновиков - POST
/v1/draftsСоздать черновик - GET
/v1/drafts/{draft_id}Получить черновик - PATCH
/v1/drafts/{draft_id}Изменить черновик - POST
/v1/drafts/{draft_id}/request-publishЗапросить публикацию - POST
/v1/drafts/{draft_id}/approveОдобрить публикацию - GET
/v1/tagsПолучить список тегов карточек организации - POST
/v1/cards/archiveЗагрузить архив документов - GET
/v1/archives/{job_id}Получить задание распаковки архива - GET
/v1/cards/{card_id}/verificationПолучить блок верификации карточки - POST
/v1/cards/{card_id}/verification/verifyПодтвердить карточку - POST
/v1/cards/{card_id}/verification/unverifyСнять доверие или напомнить верификатору - PUT
/v1/cards/{card_id}/verification/verifiersНазначить верификаторов карточки - PUT
/v1/cards/{card_id}/verification/intervalИзменить тип и срок верификации - GET
/v1/verification/queueПолучить очередь верификации - GET
/v1/collections/{name}/trustПолучить Trust Score коллекции - GET
/v1/org/trustПолучить Trust Score организации - GET
/v1/announcementsПолучить список объявлений - POST
/v1/announcementsОтправить объявление «Обязательно к прочтению» - GET
/v1/announcements/{announcement_id}Получить объявление - GET
/v1/announcements/{announcement_id}/statsПолучить отчёт по объявлению - POST
/v1/announcements/{announcement_id}/remindНапомнить тем, кто не прочитал - GET
/v1/cards/{card_id}/threadsПолучить ветки комментариев карточки - POST
/v1/cards/{card_id}/threadsДобавить комментарий или ответ в ветке - DELETE
/v1/cards/{card_id}/threads/{comment_id}Удалить комментарий с ответами - PATCH
/v1/cards/{card_id}/threads/{comment_id}Изменить текст, закрыть или снова открыть ветку - GET
/v1/openapi-public.jsonПолучить публичную спецификацию OpenAPI - GET
/v1/webhooksПолучить список вебхуков организации - POST
/v1/webhooksСоздать вебхук - GET
/v1/webhooks/catalogПолучить список типов событий - GET
/v1/webhooks/{webhook_id}Получить вебхук - DELETE
/v1/webhooks/{webhook_id}Удалить вебхук - PATCH
/v1/webhooks/{webhook_id}Изменить вебхук - POST
/v1/webhooks/{webhook_id}/testОтправить проверочное событие - POST
/v1/webhooks/{webhook_id}/rotate-secretСменить секрет подписи - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretОтозвать прежний секрет - POST
/v1/webhooks/{webhook_id}/resumeВозобновить вебхук - POST
/v1/webhooks/{webhook_id}/redeliverПовторно доставить события за период - GET
/v1/webhooks/{webhook_id}/attemptsПолучить попытки доставки - GET
/v1/webhooks/{webhook_id}/deliveriesПолучить доставки вебхука - GET
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}Получить доставку с телами и попытками - POST
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliverПовторно доставить событие - GET
/v1/webhook-eventsПолучить список событий - GET
/v1/webhook-events/{event_id}Получить событие - GET
/v1/api-usageПолучить использование API - GET
/v1/api-logsПолучить список запросов к API - GET
/v1/api-logs/{request_id}Получить запрос к API - GET
/v1/appsПолучить список OAuth-приложений - POST
/v1/appsСоздать OAuth-приложение - GET
/v1/apps/{app_id}Получить OAuth-приложение - DELETE
/v1/apps/{app_id}Удалить OAuth-приложение - PATCH
/v1/apps/{app_id}Изменить OAuth-приложение - POST
/v1/apps/{app_id}/rotate-secretСменить секрет клиента - GET
/v1/app-authorizationsПолучить авторизации приложений - DELETE
/v1/app-authorizations/{authorization_id}Отозвать авторизацию сотрудника - GET
/v1/analytics/healthПолучить дашборд здоровья знаний - GET
/v1/analytics/usageПолучить дашборд использования - GET
/v1/analytics/contributionПолучить дашборд вклада - GET
/v1/analytics/cards/{card_id}Получить метрики карточки - GET
/v1/audit/verifyПроверить целостность журнала аудита организации - POST
/v1/users/importИмпортировать пользователей из CSV - GET
/v1/quality/gaps/followupsПолучить пробелы в знаниях, взятые в работу - POST
/v1/quality/gaps/followupsВзять пробел в знаниях в работу - PATCH
/v1/quality/gaps/followups/{followup_id}Изменить пробел в знаниях, взятый в работу - GET
/v1/access-requestsПолучить свои или входящие запросы доступа - GET
/v1/access-requests/{request_id}Получить запрос доступа для принимающего решение - POST
/v1/access-requests/{request_id}/grantОткрыть доступ по запросу - POST
/v1/access-requests/{request_id}/denyОтказать в доступе - POST
/v1/finance/reportПолучить сводный финансовый отчёт - POST
/v1/finance/report/exportВыгрузить сводный финансовый отчёт - POST
/v1/finance/invoicesПолучить список счетов - POST
/v1/finance/invoices/exportВыгрузить список счетов - POST
/v1/finance/paymentsПолучить список платежей - POST
/v1/finance/payments/exportВыгрузить список платежей - GET
/v1/sources/{source_id}/push-keysПолучить список ключей API своего источника - POST
/v1/sources/{source_id}/push-keysСоздать ключ API для своего источника - DELETE
/v1/sources/{source_id}/push-keys/{key_id}Отозвать ключ API своего источника - GET
/v1/sources/{source_id}/push-syncsПолучить синхронизации своего источника - GET
/v1/push/sources/{source_id}Проверить ключ и получить состояние своего источника - POST
/v1/push/sources/{source_id}/syncsОткрыть синхронизацию - GET
/v1/push/sources/{source_id}/syncs/{sync_number}Получить синхронизацию - GET
/v1/push/sources/{source_id}/syncs/{sync_number}/documentsПолучить результаты документов синхронизации - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/closeЗакрыть синхронизацию - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/touchПодтвердить документы без повторной отправки - POST
/v1/push/sources/{source_id}/documentsОтправить документ (создать или заменить) - POST
/v1/push/sources/{source_id}/documents/batchОтправить пакет документов - GET
/v1/push/sources/{source_id}/documents/{external_id}Получить результат документа - DELETE
/v1/push/sources/{source_id}/documents/{external_id}Удалить документ