ออบเจ็กต์
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}ลบเอกสาร