Đối tượng
Error
Phản hồi lỗi tiêu chuẩn. detail là một chuỗi, một đối tượng có code (ví dụ choose_org, org_suspended, các mã lời mời) hoặc một danh sách lỗi dữ liệu không hợp lệ (422). error là mô tả có cấu trúc: mã từ danh sách mã lỗi, thông báo bằng tiếng Anh, chi tiết có cấu trúc và ID yêu cầu.
Trường
Thông báo lỗi, một đối tượng có mã, hoặc một danh sách lỗi dữ liệu không hợp lệ.
errorErrorInfo
Được dùng trong
- GET
/v1/healthLấy trạng thái và phiên bản dịch vụ - GET
/v1/usersLiệt kê người dùng của tổ chức - POST
/v1/usersTạo người dùng - PATCH
/v1/users/{user_id}Cập nhật người dùng - GET
/v1/api-keysLiệt kê khóa API của tổ chức - POST
/v1/api-keysTạo khóa API - DELETE
/v1/api-keys/{key_id}Thu hồi khóa API - PATCH
/v1/api-keys/{key_id}Cập nhật khóa API - POST
/v1/api-keys/{key_id}/rollCấp lại khóa API - POST
/v1/api-keys/{key_id}/revoke-previousThu hồi giá trị trước của khóa API - GET
/v1/auditLiệt kê các mục của nhật ký kiểm toán - GET
/v1/audit/actionsLiệt kê các hành động trong nhật ký kiểm toán kèm số lượng - GET
/v1/audit/export.csvXuất nhật ký kiểm toán dưới dạng CSV - GET
/v1/orgLấy thông tin tổ chức - GET
/v1/categoriesLiệt kê danh mục tài liệu - POST
/v1/categoriesTạo danh mục - DELETE
/v1/categories/{key}Xóa danh mục tùy chỉnh - PATCH
/v1/categories/{key}Cập nhật danh mục - GET
/v1/collectionsLiệt kê các bộ sưu tập mà người dùng có quyền truy cập - POST
/v1/collectionsTạo bộ sưu tập - DELETE
/v1/collections/{name}Xóa bộ sưu tập - PATCH
/v1/collections/{name}Cập nhật bộ sưu tập - POST
/v1/collections/{name}/reindexLập chỉ mục lại bộ sưu tập - GET
/v1/collections/{name}/statsLấy tổng quan bộ sưu tập: thống kê, danh mục, thẻ gần đây, quyền - GET
/v1/cardsLiệt kê thẻ - POST
/v1/cardsTải tệp lên thành thẻ - GET
/v1/jobsLiệt kê tác vụ lập chỉ mục - GET
/v1/jobs/summaryLấy tổng quan hàng đợi - GET
/v1/jobs/streamTheo dõi luồng thay đổi của tác vụ (SSE) - GET
/v1/jobs/{job_id}Lấy tác vụ - DELETE
/v1/jobs/{job_id}Hủy tác vụ đang chờ trong hàng đợi - GET
/v1/cards/countĐếm thẻ - GET
/v1/cards/export.xlsxXuất danh sách thẻ ra XLSX - POST
/v1/cards/bulkThực hiện hành động hàng loạt trên thẻ - GET
/v1/cards/{card_id}Lấy thẻ kèm phiên bản, bình luận, bảng và sự kiện - DELETE
/v1/cards/{card_id}Xóa thẻ - PATCH
/v1/cards/{card_id}Cập nhật thẻ - GET
/v1/cards-by-external-id/{external_id}Lấy thẻ theo ID bên ngoài - PUT
/v1/cards-by-external-id/{external_id}Tạo hoặc thay thế thẻ theo ID bên ngoài - GET
/v1/cards/{card_id}/contentLấy văn bản của thẻ theo từng phần - PUT
/v1/cards/{card_id}/contentThay thế nội dung của thẻ - GET
/v1/cards/{card_id}/tables/{table_id}/rowsLiệt kê các dòng của bảng dữ kiện - GET
/v1/cards/{card_id}/versions/{a}/diff/{b}So sánh hai phiên bản của thẻ - GET
/v1/cards/{card_id}/usageLiệt kê các câu hỏi có câu trả lời đã dùng thẻ - POST
/v1/cards/{card_id}/usageGhi nhận sự kiện sử dụng thẻ - POST
/v1/cards/{card_id}/reindexLập chỉ mục lại thẻ - DELETE
/v1/cards/{card_id}/comments/{comment_id}Xóa bình luận - GET
/v1/cards/{card_id}/fileTải xuống tệp gốc của thẻ - GET
/v1/cards/{card_id}/exportXuất thẻ ra tài liệu - POST
/v1/cards/{card_id}/verifyXác nhận thông tin của thẻ vẫn còn cập nhật - POST
/v1/cards/{card_id}/commentsThêm bình luận - GET
/v1/conversationsLiệt kê cuộc trò chuyện - GET
/v1/conversations/{conv_id}Lấy cuộc trò chuyện kèm các lượt - POST
/v1/searchTìm kiếm trong bộ sưu tập - POST
/v1/askLấy câu trả lời của trợ lý không qua luồng - POST
/v1/chatNhận câu trả lời của trợ lý qua luồng (SSE) - POST
/v1/questions/{question_id}/feedbackĐánh giá câu trả lời - GET
/v1/questions/export.csvXuất nhật ký câu hỏi ra CSV - GET
/v1/questions/{question_id}Lấy câu hỏi đã lưu kèm câu trả lời - GET
/v1/questions/{question_id}/followupsLấy các câu hỏi tiếp theo được gợi ý - GET
/v1/questionsLiệt kê nhật ký câu hỏi - GET
/v1/questions/{question_id}/exportXuất câu trả lời ra tài liệu - GET
/v1/questions/{question_id}/datasets/{dataset_id}/exportXuất một tập dữ liệu của câu trả lời - GET
/v1/questions/{question_id}/answer-tables/{index}/exportXuất một bảng từ nội dung câu trả lời - POST
/v1/questions/{question_id}/refreshLàm mới các tập dữ liệu của câu trả lời (câu trả lời động) - POST
/v1/questions/{question_id}/save-cardLưu câu trả lời thành thẻ - POST
/v1/cards/textTạo thẻ văn bản (Markdown) - GET
/v1/filesLiệt kê tệp xuất - GET
/v1/files/authorsLiệt kê tác giả của tệp (cho bộ lọc của quản trị viên) - GET
/v1/files/{file_id}Lấy thông tin tệp - DELETE
/v1/files/{file_id}Xóa tệp - GET
/v1/files/{file_id}/downloadTải xuống tệp - GET
/v1/files/{file_id}/previewXem trước tệp - POST
/v1/files/{file_id}/extendGia hạn thời hạn lưu giữ của tệp - POST
/v1/files/{file_id}/regenerateTạo lại tệp từ các tham số đã lưu - GET
/v1/tasksLiệt kê công việc của người dùng hoặc của đội - POST
/v1/sourcesTạo nguồn - GET
/v1/sources/{source_id}Lấy nguồn - DELETE
/v1/sources/{source_id}Xóa nguồn - PATCH
/v1/sources/{source_id}Cập nhật nguồn - PATCH
/v1/sources/{source_id}/settingsCập nhật cài đặt của nguồn - GET
/v1/cards/{card_id}/similarLiệt kê thẻ tương tự - GET
/v1/insights/gapsLiệt kê lỗ hổng tri thức (các cụm câu hỏi chưa có câu trả lời) - GET
/v1/permissionsLiệt kê danh sách quyền - POST
/v1/uploadsBắt đầu tải lên nhiều phần - GET
/v1/uploads/{upload_id}Lấy lượt tải lên - DELETE
/v1/uploads/{upload_id}Hủy lượt tải lên - PUT
/v1/uploads/{upload_id}/parts/{n}Gửi một phần của lượt tải lên - POST
/v1/uploads/{upload_id}/completeHoàn tất lượt tải lên - GET
/v1/meLấy thông tin bên gọi API - GET
/v1/me/permissionsLấy quyền của người dùng hiện tại trên tổ chức - GET
/v1/rolesLiệt kê vai trò (có sẵn và tùy chỉnh) - POST
/v1/rolesTạo vai trò tùy chỉnh - DELETE
/v1/roles/{role_id}Xóa vai trò tùy chỉnh - PATCH
/v1/roles/{role_id}Cập nhật vai trò tùy chỉnh - GET
/v1/groupsLiệt kê nhóm của tổ chức - POST
/v1/groupsTạo nhóm - GET
/v1/groups/{group_id}Lấy nhóm kèm các thành viên - DELETE
/v1/groups/{group_id}Xóa nhóm - PATCH
/v1/groups/{group_id}Đổi tên nhóm - PUT
/v1/groups/{group_id}/members/{user_id}Thêm thành viên vào nhóm - DELETE
/v1/groups/{group_id}/members/{user_id}Gỡ thành viên khỏi nhóm - GET
/v1/org/permissionsLấy quyền trên tổ chức (ai là quản trị viên) - PUT
/v1/org/permissionsGán vai trò trên tổ chức - DELETE
/v1/org/permissionsThu hồi vai trò trên tổ chức - GET
/v1/collections/{name}/permissionsLấy quyền trên bộ sưu tập (trực tiếp và kế thừa) - PUT
/v1/collections/{name}/permissionsGán vai trò trên bộ sưu tập - DELETE
/v1/collections/{name}/permissionsThu hồi vai trò trên bộ sưu tập - GET
/v1/cards/{card_id}/permissionsLấy quyền trên thẻ (trực tiếp và kế thừa) - PUT
/v1/cards/{card_id}/permissionsGán vai trò trên thẻ - DELETE
/v1/cards/{card_id}/permissionsThu hồi vai trò trên thẻ - GET
/v1/sources/{source_id}/permissionsLấy quyền trên nguồn (trực tiếp và kế thừa) - PUT
/v1/sources/{source_id}/permissionsGán vai trò trên nguồn - DELETE
/v1/sources/{source_id}/permissionsThu hồi vai trò trên nguồn - POST
/v1/users/{user_id}/offboardCho người dùng rời tổ chức - GET
/v1/collections/{name}/foldersLấy cây thư mục của bộ sưu tập - POST
/v1/collections/{name}/foldersTạo thư mục - GET
/v1/foldersLấy cây thư mục của mọi bộ sưu tập - GET
/v1/folders/{folder_id}Lấy thư mục - DELETE
/v1/folders/{folder_id}Xóa thư mục và đưa nội dung lên cấp trên - PATCH
/v1/folders/{folder_id}Đổi tên, di chuyển hoặc sắp xếp lại thư mục - GET
/v1/folders/{folder_id}/cardsLiệt kê thẻ của thư mục - GET
/v1/folders/{folder_id}/permissionsLấy quyền trên thư mục (trực tiếp và kế thừa) - PUT
/v1/folders/{folder_id}/permissionsGán vai trò trên thư mục - DELETE
/v1/folders/{folder_id}/permissionsThu hồi vai trò trên thư mục - GET
/v1/catalog/servicesLiệt kê dịch vụ trong catalog - GET
/v1/catalog/services/{service_id}Lấy một dịch vụ trong catalog - GET
/v1/catalog/services/{service_id}/iconLấy biểu tượng của dịch vụ - GET
/v1/catalog/categoriesLiệt kê danh mục của catalog - GET
/v1/catalog/spend-taxonomyLấy phân loại chi tiêu và doanh thu - POST
/v1/catalog/resolveĐối chiếu tên với dịch vụ trong catalog - GET
/v1/draftsLiệt kê bản nháp - POST
/v1/draftsTạo bản nháp - GET
/v1/drafts/{draft_id}Lấy bản nháp - PATCH
/v1/drafts/{draft_id}Cập nhật bản nháp - POST
/v1/drafts/{draft_id}/request-publishYêu cầu xuất bản - POST
/v1/drafts/{draft_id}/approvePhê duyệt xuất bản - GET
/v1/tagsLiệt kê nhãn thẻ của tổ chức - POST
/v1/cards/archiveTải lên tệp lưu trữ nén chứa tài liệu - GET
/v1/archives/{job_id}Lấy tác vụ giải nén tệp lưu trữ nén - GET
/v1/cards/{card_id}/verificationLấy khối kiểm chứng của thẻ - POST
/v1/cards/{card_id}/verification/verifyKiểm chứng thẻ - POST
/v1/cards/{card_id}/verification/unverifyGỡ độ tin cậy hoặc nhắc người kiểm chứng - PUT
/v1/cards/{card_id}/verification/verifiersĐặt người kiểm chứng của thẻ - PUT
/v1/cards/{card_id}/verification/intervalThay đổi loại và hạn kiểm chứng - GET
/v1/verification/queueLấy hàng đợi kiểm chứng - GET
/v1/collections/{name}/trustLấy điểm tin cậy (Trust Score) của bộ sưu tập - GET
/v1/org/trustLấy điểm tin cậy (Trust Score) của tổ chức - GET
/v1/announcementsLiệt kê thông báo - POST
/v1/announcementsGửi thông báo bắt buộc đọc - GET
/v1/announcements/{announcement_id}Lấy thông báo - GET
/v1/announcements/{announcement_id}/statsLấy báo cáo của thông báo - POST
/v1/announcements/{announcement_id}/remindNhắc những người chưa đọc - GET
/v1/cards/{card_id}/threadsLiệt kê các chuỗi bình luận của thẻ - POST
/v1/cards/{card_id}/threadsThêm bình luận hoặc trả lời trong chuỗi - DELETE
/v1/cards/{card_id}/threads/{comment_id}Xóa bình luận cùng các trả lời - PATCH
/v1/cards/{card_id}/threads/{comment_id}Sửa văn bản, đánh dấu đã xử lý hoặc mở lại chuỗi bình luận - GET
/v1/openapi-public.jsonLấy đặc tả OpenAPI công khai - GET
/v1/webhooksLiệt kê webhook của tổ chức - POST
/v1/webhooksTạo webhook - GET
/v1/webhooks/catalogLiệt kê loại sự kiện - GET
/v1/webhooks/{webhook_id}Lấy webhook - DELETE
/v1/webhooks/{webhook_id}Xóa webhook - PATCH
/v1/webhooks/{webhook_id}Cập nhật webhook - POST
/v1/webhooks/{webhook_id}/testGửi sự kiện thử - POST
/v1/webhooks/{webhook_id}/rotate-secretXoay vòng khóa bí mật để ký - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretThu hồi khóa bí mật trước - POST
/v1/webhooks/{webhook_id}/resumeTiếp tục webhook - POST
/v1/webhooks/{webhook_id}/redeliverGửi lại các lần gửi trong một khoảng thời gian - GET
/v1/webhooks/{webhook_id}/attemptsLiệt kê các lần thử gửi - GET
/v1/webhooks/{webhook_id}/deliveriesLiệt kê các lần gửi của webhook - GET
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}Lấy lần gửi kèm phần thân và các lần thử - POST
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliverGửi lại sự kiện - GET
/v1/webhook-eventsLiệt kê sự kiện - GET
/v1/webhook-events/{event_id}Lấy sự kiện - GET
/v1/api-usageLấy mức sử dụng API - GET
/v1/api-logsLiệt kê các yêu cầu API - GET
/v1/api-logs/{request_id}Lấy một yêu cầu API - GET
/v1/appsLiệt kê ứng dụng OAuth - POST
/v1/appsTạo ứng dụng OAuth - GET
/v1/apps/{app_id}Lấy ứng dụng OAuth - DELETE
/v1/apps/{app_id}Xóa ứng dụng OAuth - PATCH
/v1/apps/{app_id}Cập nhật ứng dụng OAuth - POST
/v1/apps/{app_id}/rotate-secretXoay vòng khóa bí mật của client - GET
/v1/app-authorizationsLiệt kê ủy quyền của ứng dụng - DELETE
/v1/app-authorizations/{authorization_id}Thu hồi ủy quyền của nhân viên - GET
/v1/analytics/healthLấy bảng điều khiển sức khỏe tri thức - GET
/v1/analytics/usageLấy bảng điều khiển mức sử dụng - GET
/v1/analytics/contributionLấy bảng đóng góp - GET
/v1/analytics/cards/{card_id}Lấy chỉ số của thẻ - GET
/v1/audit/verifyXác minh tính toàn vẹn của nhật ký kiểm toán của tổ chức - POST
/v1/users/importNhập người dùng từ CSV - GET
/v1/quality/gaps/followupsLiệt kê các lỗ hổng tri thức đang được xử lý - POST
/v1/quality/gaps/followupsĐưa một lỗ hổng tri thức vào xử lý - PATCH
/v1/quality/gaps/followups/{followup_id}Cập nhật lỗ hổng tri thức đang được xử lý - GET
/v1/access-requestsLiệt kê yêu cầu truy cập của chính bạn hoặc yêu cầu gửi đến - GET
/v1/access-requests/{request_id}Lấy yêu cầu truy cập cho người quyết định - POST
/v1/access-requests/{request_id}/grantCấp quyền truy cập theo yêu cầu - POST
/v1/access-requests/{request_id}/denyTừ chối quyền truy cập - POST
/v1/finance/reportLấy báo cáo tổng hợp tài chính - POST
/v1/finance/report/exportXuất báo cáo tổng hợp tài chính - POST
/v1/finance/invoicesLiệt kê hóa đơn - POST
/v1/finance/invoices/exportXuất danh sách hóa đơn - POST
/v1/finance/paymentsLiệt kê khoản thanh toán - POST
/v1/finance/payments/exportXuất danh sách khoản thanh toán - GET
/v1/sources/{source_id}/push-keysLiệt kê khóa API của nguồn tùy chỉnh - POST
/v1/sources/{source_id}/push-keysTạo khóa API cho nguồn tùy chỉnh - DELETE
/v1/sources/{source_id}/push-keys/{key_id}Thu hồi khóa API của nguồn tùy chỉnh - GET
/v1/sources/{source_id}/push-syncsLiệt kê các lần đồng bộ của nguồn tùy chỉnh - GET
/v1/push/sources/{source_id}Kiểm tra khóa và lấy trạng thái của nguồn tùy chỉnh - POST
/v1/push/sources/{source_id}/syncsMở phiên đồng bộ - GET
/v1/push/sources/{source_id}/syncs/{sync_number}Lấy phiên đồng bộ - GET
/v1/push/sources/{source_id}/syncs/{sync_number}/documentsLiệt kê kết quả theo tài liệu của phiên đồng bộ - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/closeĐóng phiên đồng bộ - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/touchXác nhận tài liệu mà không gửi lại - POST
/v1/push/sources/{source_id}/documentsGửi tài liệu (tạo hoặc thay thế) - POST
/v1/push/sources/{source_id}/documents/batchGửi một lô tài liệu - GET
/v1/push/sources/{source_id}/documents/{external_id}Lấy kết quả của tài liệu - DELETE
/v1/push/sources/{source_id}/documents/{external_id}Xóa tài liệu