Об’єкти
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}Отримати картку за зовнішнім ідентифікатором - PUT
/v1/cards-by-external-id/{external_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}Видалити документ