Objekty
Error
Štandardná chybová odpoveď. detail je reťazec, objekt s code (napríklad choose_org, org_suspended, kódy pozvánok) alebo zoznam chýb validácie (422). error je štruktúrovaný opis: kód z katalógu chýb, anglická správa, štruktúrované podrobnosti a ID požiadavky.
Polia
Chybová správa, objekt s kódom alebo zoznam chýb validácie.
errorErrorInfo
Používa
- GET
/v1/healthZískať stav a verziu služby - GET
/v1/usersZobraziť zoznam používateľov organizácie - POST
/v1/usersVytvoriť používateľa - PATCH
/v1/users/{user_id}Upraviť používateľa - GET
/v1/api-keysZobraziť zoznam kľúčov API organizácie - POST
/v1/api-keysVytvoriť kľúč API - DELETE
/v1/api-keys/{key_id}Odvolať kľúč API - PATCH
/v1/api-keys/{key_id}Upraviť kľúč API - POST
/v1/api-keys/{key_id}/rollVymeniť kľúč API - POST
/v1/api-keys/{key_id}/revoke-previousOdvolať predchádzajúcu hodnotu kľúča API - GET
/v1/auditZobraziť záznamy auditného logu - GET
/v1/audit/actionsZobraziť akcie auditného logu s počtami - GET
/v1/audit/export.csvExportovať auditný log do CSV - GET
/v1/orgZískať organizáciu - GET
/v1/categoriesZobraziť zoznam kategórií dokumentov - POST
/v1/categoriesVytvoriť kategóriu - DELETE
/v1/categories/{key}Odstrániť vlastnú kategóriu - PATCH
/v1/categories/{key}Upraviť kategóriu - GET
/v1/collectionsZobraziť zoznam kolekcií dostupných používateľovi - POST
/v1/collectionsVytvoriť kolekciu - DELETE
/v1/collections/{name}Odstrániť kolekciu - PATCH
/v1/collections/{name}Upraviť kolekciu - POST
/v1/collections/{name}/reindexZnova indexovať kolekciu - GET
/v1/collections/{name}/statsZískať prehľad kolekcie: štatistiky, kategórie, nedávne karty, oprávnenia - GET
/v1/cardsZobraziť zoznam kariet - POST
/v1/cardsNahrať súbor ako kartu - GET
/v1/jobsZobraziť zoznam úloh indexovania - GET
/v1/jobs/summaryZískať súhrn frontu - GET
/v1/jobs/streamStreamovať zmeny úloh (SSE) - GET
/v1/jobs/{job_id}Získať úlohu - DELETE
/v1/jobs/{job_id}Zrušiť úlohu vo fronte - GET
/v1/cards/countSpočítať karty - GET
/v1/cards/export.xlsxExportovať zoznam kariet do XLSX - POST
/v1/cards/bulkVykonať hromadnú akciu s kartami - GET
/v1/cards/{card_id}Získať kartu s verziami, komentármi, tabuľkami a udalosťami - DELETE
/v1/cards/{card_id}Odstrániť kartu - PATCH
/v1/cards/{card_id}Upraviť kartu - GET
/v1/cards-by-external-id/{external_id}Získať kartu podľa externého identifikátora - PUT
/v1/cards-by-external-id/{external_id}Vytvoriť alebo nahradiť kartu podľa externého identifikátora - GET
/v1/cards/{card_id}/contentZískať text karty po sekciách - PUT
/v1/cards/{card_id}/contentNahradiť obsah karty - GET
/v1/cards/{card_id}/tables/{table_id}/rowsZobraziť riadky tabuľky faktov - GET
/v1/cards/{card_id}/versions/{a}/diff/{b}Porovnať dve verzie karty - GET
/v1/cards/{card_id}/usageZobraziť otázky, ktorých odpovede použili kartu - POST
/v1/cards/{card_id}/usageZaznamenať udalosť použitia karty - POST
/v1/cards/{card_id}/reindexZnova indexovať kartu - DELETE
/v1/cards/{card_id}/comments/{comment_id}Odstrániť komentár - GET
/v1/cards/{card_id}/fileStiahnuť pôvodný súbor karty - GET
/v1/cards/{card_id}/exportExportovať kartu do dokumentu - POST
/v1/cards/{card_id}/verifyPotvrdiť, že karta je aktuálna - POST
/v1/cards/{card_id}/commentsPridať komentár - GET
/v1/conversationsZobraziť zoznam konverzácií - GET
/v1/conversations/{conv_id}Získať konverzáciu s jej kolami - POST
/v1/searchVyhľadávať v kolekciách - POST
/v1/askZískať odpoveď asistenta bez streamovania - POST
/v1/chatStreamovať odpoveď asistenta (SSE) - POST
/v1/questions/{question_id}/feedbackOhodnotiť odpoveď - GET
/v1/questions/export.csvExportovať log otázok do CSV - GET
/v1/questions/{question_id}Získať uloženú otázku s odpoveďou - GET
/v1/questions/{question_id}/followupsZískať odporúčané ďalšie otázky - GET
/v1/questionsZobraziť log otázok - GET
/v1/questions/{question_id}/exportExportovať odpoveď do dokumentu - GET
/v1/questions/{question_id}/datasets/{dataset_id}/exportExportovať dátovú sadu odpovede - GET
/v1/questions/{question_id}/answer-tables/{index}/exportExportovať tabuľku z textu odpovede - POST
/v1/questions/{question_id}/refreshObnoviť dátové sady odpovede (živá odpoveď) - POST
/v1/questions/{question_id}/save-cardUložiť odpoveď ako kartu - POST
/v1/cards/textVytvoriť textovú kartu (Markdown) - GET
/v1/filesZobraziť zoznam súborov exportu - GET
/v1/files/authorsZobraziť autorov súborov (pre filter administrátora) - GET
/v1/files/{file_id}Získať podrobnosti súboru - DELETE
/v1/files/{file_id}Odstrániť súbor - GET
/v1/files/{file_id}/downloadStiahnuť súbor - GET
/v1/files/{file_id}/previewZobraziť náhľad súboru - POST
/v1/files/{file_id}/extendPredĺžiť dobu uchovávania súboru - POST
/v1/files/{file_id}/regenerateZnova vygenerovať súbor z uložených parametrov - GET
/v1/tasksZobraziť pracovné úlohy používateľa alebo tímu - POST
/v1/sourcesVytvoriť zdroj - GET
/v1/sources/{source_id}Získať zdroj - DELETE
/v1/sources/{source_id}Odstrániť zdroj - PATCH
/v1/sources/{source_id}Upraviť zdroj - PATCH
/v1/sources/{source_id}/settingsUpraviť nastavenia zdroja - GET
/v1/cards/{card_id}/similarZobraziť podobné karty - GET
/v1/insights/gapsZobraziť medzery v znalostiach (zhluky otázok bez odpovede) - GET
/v1/permissionsZobraziť register oprávnení - POST
/v1/uploadsZačať viacdielne nahrávanie - GET
/v1/uploads/{upload_id}Získať nahrávanie - DELETE
/v1/uploads/{upload_id}Zrušiť nahrávanie - PUT
/v1/uploads/{upload_id}/parts/{n}Odoslať časť nahrávania - POST
/v1/uploads/{upload_id}/completeDokončiť nahrávanie - GET
/v1/meZískať volajúceho API - GET
/v1/me/permissionsZískať oprávnenia aktuálneho používateľa na organizáciu - GET
/v1/rolesZobraziť roly (vstavané a vlastné) - POST
/v1/rolesVytvoriť vlastnú rolu - DELETE
/v1/roles/{role_id}Odstrániť vlastnú rolu - PATCH
/v1/roles/{role_id}Upraviť vlastnú rolu - GET
/v1/groupsZobraziť skupiny organizácie - POST
/v1/groupsVytvoriť skupinu - GET
/v1/groups/{group_id}Získať skupinu s jej členmi - DELETE
/v1/groups/{group_id}Odstrániť skupinu - PATCH
/v1/groups/{group_id}Premenovať skupinu - PUT
/v1/groups/{group_id}/members/{user_id}Pridať člena do skupiny - DELETE
/v1/groups/{group_id}/members/{user_id}Odobrať člena zo skupiny - GET
/v1/org/permissionsZískať oprávnenia na organizáciu (kto je administrátor) - PUT
/v1/org/permissionsPriradiť roly na organizáciu - DELETE
/v1/org/permissionsOdobrať roly na organizáciu - GET
/v1/collections/{name}/permissionsZískať oprávnenia na kolekciu (priame a zdedené) - PUT
/v1/collections/{name}/permissionsPriradiť roly na kolekciu - DELETE
/v1/collections/{name}/permissionsOdobrať roly na kolekciu - GET
/v1/cards/{card_id}/permissionsZískať oprávnenia na kartu (priame a zdedené) - PUT
/v1/cards/{card_id}/permissionsPriradiť roly na kartu - DELETE
/v1/cards/{card_id}/permissionsOdobrať roly na kartu - GET
/v1/sources/{source_id}/permissionsZískať oprávnenia na zdroj (priame a zdedené) - PUT
/v1/sources/{source_id}/permissionsPriradiť roly na zdroj - DELETE
/v1/sources/{source_id}/permissionsOdobrať roly na zdroj - POST
/v1/users/{user_id}/offboardVykonať offboarding používateľa - GET
/v1/collections/{name}/foldersZískať strom priečinkov kolekcie - POST
/v1/collections/{name}/foldersVytvoriť priečinok - GET
/v1/foldersZískať stromy priečinkov všetkých kolekcií - GET
/v1/folders/{folder_id}Získať priečinok - DELETE
/v1/folders/{folder_id}Odstrániť priečinok a presunúť jeho obsah o úroveň vyššie - PATCH
/v1/folders/{folder_id}Premenovať, presunúť priečinok alebo zmeniť jeho poradie - GET
/v1/folders/{folder_id}/cardsZobraziť karty priečinka - GET
/v1/folders/{folder_id}/permissionsZískať oprávnenia na priečinok (priame a zdedené) - PUT
/v1/folders/{folder_id}/permissionsPriradiť roly na priečinok - DELETE
/v1/folders/{folder_id}/permissionsOdobrať roly na priečinok - GET
/v1/catalog/servicesZobraziť služby v katalógu - GET
/v1/catalog/services/{service_id}Získať službu z katalógu - GET
/v1/catalog/services/{service_id}/iconZískať ikonu služby - GET
/v1/catalog/categoriesZobraziť kategórie katalógu - GET
/v1/catalog/spend-taxonomyZískať klasifikáciu výdavkov a príjmov - POST
/v1/catalog/resolvePriradiť názvy k službám v katalógu - GET
/v1/draftsZobraziť návrhy - POST
/v1/draftsVytvoriť návrh - GET
/v1/drafts/{draft_id}Získať návrh - PATCH
/v1/drafts/{draft_id}Upraviť návrh - POST
/v1/drafts/{draft_id}/request-publishPožiadať o publikovanie - POST
/v1/drafts/{draft_id}/approveSchváliť publikovanie - GET
/v1/tagsZobraziť štítky kariet organizácie - POST
/v1/cards/archiveNahrať archív dokumentov - GET
/v1/archives/{job_id}Získať úlohu rozbalenia archívu - GET
/v1/cards/{card_id}/verificationZískať blok overenia karty - POST
/v1/cards/{card_id}/verification/verifyOveriť kartu - POST
/v1/cards/{card_id}/verification/unverifyOdobrať dôveru alebo pripomenúť overovateľovi - PUT
/v1/cards/{card_id}/verification/verifiersNastaviť overovateľov karty - PUT
/v1/cards/{card_id}/verification/intervalZmeniť typ overenia a termín - GET
/v1/verification/queueZískať front overenia - GET
/v1/collections/{name}/trustZískať Trust Score kolekcie - GET
/v1/org/trustZískať Trust Score organizácie - GET
/v1/announcementsZobraziť oznámenia - POST
/v1/announcementsOdoslať oznámenie s povinným čítaním - GET
/v1/announcements/{announcement_id}Získať oznámenie - GET
/v1/announcements/{announcement_id}/statsZískať report oznámenia - POST
/v1/announcements/{announcement_id}/remindPripomenúť tým, ktorí oznámenie neprečítali - GET
/v1/cards/{card_id}/threadsZobraziť vlákna komentárov karty - POST
/v1/cards/{card_id}/threadsPridať komentár alebo odpoveď vo vlákne - DELETE
/v1/cards/{card_id}/threads/{comment_id}Odstrániť komentár s odpoveďami - PATCH
/v1/cards/{card_id}/threads/{comment_id}Upraviť text, vyriešiť alebo znova otvoriť vlákno - GET
/v1/openapi-public.jsonZískať verejnú špecifikáciu OpenAPI - GET
/v1/webhooksZobraziť webhooky organizácie - POST
/v1/webhooksVytvoriť webhook - GET
/v1/webhooks/catalogZobraziť typy udalostí - GET
/v1/webhooks/{webhook_id}Získať webhook - DELETE
/v1/webhooks/{webhook_id}Odstrániť webhook - PATCH
/v1/webhooks/{webhook_id}Upraviť webhook - POST
/v1/webhooks/{webhook_id}/testOdoslať testovaciu udalosť - POST
/v1/webhooks/{webhook_id}/rotate-secretVymeniť tajný kľúč podpisu - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretOdvolať predchádzajúci tajný kľúč - POST
/v1/webhooks/{webhook_id}/resumeObnoviť webhook - POST
/v1/webhooks/{webhook_id}/redeliverZnova doručiť doručenia za obdobie - GET
/v1/webhooks/{webhook_id}/attemptsZobraziť pokusy o doručenie - GET
/v1/webhooks/{webhook_id}/deliveriesZobraziť doručenia webhooku - GET
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}Získať doručenie s telami a pokusmi - POST
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliverZnova doručiť udalosť - GET
/v1/webhook-eventsZobraziť udalosti - GET
/v1/webhook-events/{event_id}Získať udalosť - GET
/v1/api-usageZískať využitie API - GET
/v1/api-logsZobraziť požiadavky API - GET
/v1/api-logs/{request_id}Získať požiadavku API - GET
/v1/appsZobraziť aplikácie OAuth - POST
/v1/appsVytvoriť aplikáciu OAuth - GET
/v1/apps/{app_id}Získať aplikáciu OAuth - DELETE
/v1/apps/{app_id}Odstrániť aplikáciu OAuth - PATCH
/v1/apps/{app_id}Upraviť aplikáciu OAuth - POST
/v1/apps/{app_id}/rotate-secretVymeniť tajný kľúč klienta - GET
/v1/app-authorizationsZobraziť autorizácie aplikácií - DELETE
/v1/app-authorizations/{authorization_id}Odvolať autorizáciu zamestnanca - GET
/v1/analytics/healthZískať prehľad zdravia znalostí - GET
/v1/analytics/usageZískať prehľad používania - GET
/v1/analytics/contributionZískať prehľad príspevkov - GET
/v1/analytics/cards/{card_id}Získať metriky karty - GET
/v1/audit/verifyOveriť integritu auditného logu organizácie - POST
/v1/users/importImportovať používateľov z CSV - GET
/v1/quality/gaps/followupsZobraziť medzery v znalostiach, na ktorých sa pracuje - POST
/v1/quality/gaps/followupsPrevziať medzeru v znalostiach na riešenie - PATCH
/v1/quality/gaps/followups/{followup_id}Upraviť medzeru v znalostiach, na ktorej sa pracuje - GET
/v1/access-requestsZobraziť vlastné alebo prichádzajúce žiadosti o prístup - GET
/v1/access-requests/{request_id}Získať žiadosť o prístup pre rozhodujúcu osobu - POST
/v1/access-requests/{request_id}/grantUdeliť prístup na základe žiadosti - POST
/v1/access-requests/{request_id}/denyZamietnuť prístup - POST
/v1/finance/reportZískať súhrnný finančný report - POST
/v1/finance/report/exportExportovať súhrnný finančný report - POST
/v1/finance/invoicesZobraziť faktúry - POST
/v1/finance/invoices/exportExportovať zoznam faktúr - POST
/v1/finance/paymentsZobraziť platby - POST
/v1/finance/payments/exportExportovať zoznam platieb - GET
/v1/sources/{source_id}/push-keysZobraziť kľúče API vlastného zdroja - POST
/v1/sources/{source_id}/push-keysVytvoriť kľúč API pre vlastný zdroj - DELETE
/v1/sources/{source_id}/push-keys/{key_id}Odvolať kľúč API vlastného zdroja - GET
/v1/sources/{source_id}/push-syncsZobraziť synchronizácie vlastného zdroja - GET
/v1/push/sources/{source_id}Overiť kľúč a získať stav vlastného zdroja - POST
/v1/push/sources/{source_id}/syncsOtvoriť synchronizáciu - GET
/v1/push/sources/{source_id}/syncs/{sync_number}Získať synchronizáciu - GET
/v1/push/sources/{source_id}/syncs/{sync_number}/documentsZobraziť výsledky dokumentov synchronizácie - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/closeUzavrieť synchronizáciu - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/touchPotvrdiť dokumenty bez opätovného odoslania - POST
/v1/push/sources/{source_id}/documentsOdoslať dokument (vytvoriť alebo nahradiť) - POST
/v1/push/sources/{source_id}/documents/batchOdoslať dávku dokumentov - GET
/v1/push/sources/{source_id}/documents/{external_id}Získať výsledok dokumentu - DELETE
/v1/push/sources/{source_id}/documents/{external_id}Odstrániť dokument