Objekty
Error
Standardní chybová odpověď. detail je řetězec, objekt s code (například choose_org, org_suspended, kódy pozvánek), nebo seznam chyb validace (422). error je strukturovaný popis: kód z katalogu chyb, anglická zpráva, strukturované podrobnosti a ID požadavku.
Pole
Chybová zpráva, objekt s kódem, nebo seznam chyb validace.
errorErrorInfo
Používá
- GET
/v1/healthZískat stav a verzi služby - GET
/v1/usersVypsat uživatele organizace - POST
/v1/usersVytvořit uživatele - PATCH
/v1/users/{user_id}Aktualizovat uživatele - GET
/v1/api-keysVypsat klíče API organizace - POST
/v1/api-keysVytvořit klíč API - DELETE
/v1/api-keys/{key_id}Odvolat klíč API - PATCH
/v1/api-keys/{key_id}Aktualizovat klíč API - POST
/v1/api-keys/{key_id}/rollObměnit klíč API - POST
/v1/api-keys/{key_id}/revoke-previousOdvolat předchozí hodnotu klíče API - GET
/v1/auditVypsat záznamy auditního protokolu - GET
/v1/audit/actionsVypsat akce auditního protokolu s počty - GET
/v1/audit/export.csvExportovat auditní protokol jako CSV - GET
/v1/orgZískat organizaci - GET
/v1/categoriesVypsat kategorie dokumentů - POST
/v1/categoriesVytvořit kategorii - DELETE
/v1/categories/{key}Smazat vlastní kategorii - PATCH
/v1/categories/{key}Aktualizovat kategorii - GET
/v1/collectionsVypsat kolekce dostupné uživateli - POST
/v1/collectionsVytvořit kolekci - DELETE
/v1/collections/{name}Smazat kolekci - PATCH
/v1/collections/{name}Aktualizovat kolekci - POST
/v1/collections/{name}/reindexZnovu indexovat kolekci - GET
/v1/collections/{name}/statsZískat přehled kolekce: statistiky, kategorie, nedávné karty, oprávnění - GET
/v1/cardsVypsat karty - POST
/v1/cardsNahrát soubor jako kartu - GET
/v1/jobsVypsat úlohy indexování - GET
/v1/jobs/summaryZískat souhrn fronty - GET
/v1/jobs/streamStreamovat změny úloh (SSE) - GET
/v1/jobs/{job_id}Získat úlohu - DELETE
/v1/jobs/{job_id}Zrušit úlohu ve frontě - GET
/v1/cards/countSpočítat karty - GET
/v1/cards/export.xlsxExportovat seznam karet do XLSX - POST
/v1/cards/bulkProvést hromadnou akci s kartami - GET
/v1/cards/{card_id}Získat kartu s verzemi, komentáři, tabulkami a událostmi - DELETE
/v1/cards/{card_id}Smazat kartu - PATCH
/v1/cards/{card_id}Aktualizovat kartu - GET
/v1/cards-by-external-id/{external_id}Získat kartu podle externího identifikátoru - PUT
/v1/cards-by-external-id/{external_id}Vytvořit nebo nahradit kartu podle externího identifikátoru - GET
/v1/cards/{card_id}/contentZískat text karty po oddílech - PUT
/v1/cards/{card_id}/contentNahradit obsah karty - GET
/v1/cards/{card_id}/tables/{table_id}/rowsVypsat řádky tabulky faktů - GET
/v1/cards/{card_id}/versions/{a}/diff/{b}Porovnat dvě verze karty - GET
/v1/cards/{card_id}/usageVypsat otázky, v jejichž odpovědích byla karta použita - POST
/v1/cards/{card_id}/usageZaznamenat událost použití karty - POST
/v1/cards/{card_id}/reindexZnovu indexovat kartu - DELETE
/v1/cards/{card_id}/comments/{comment_id}Smazat komentář - GET
/v1/cards/{card_id}/fileStáhnout původní soubor karty - GET
/v1/cards/{card_id}/exportExportovat kartu do dokumentu - POST
/v1/cards/{card_id}/verifyPotvrdit, že je karta aktuální - POST
/v1/cards/{card_id}/commentsPřidat komentář - GET
/v1/conversationsVypsat konverzace - GET
/v1/conversations/{conv_id}Získat konverzaci s jejími koly - POST
/v1/searchVyhledávat v kolekcích - POST
/v1/askZískat odpověď asistenta bez streamování - POST
/v1/chatStreamovat odpověď asistenta (SSE) - POST
/v1/questions/{question_id}/feedbackOhodnotit odpověď - GET
/v1/questions/export.csvExportovat protokol otázek do CSV - GET
/v1/questions/{question_id}Získat uloženou otázku s odpovědí - GET
/v1/questions/{question_id}/followupsZískat navrhované navazující otázky - GET
/v1/questionsVypsat protokol otázek - GET
/v1/questions/{question_id}/exportExportovat odpověď do dokumentu - GET
/v1/questions/{question_id}/datasets/{dataset_id}/exportExportovat datovou sadu odpovědi - GET
/v1/questions/{question_id}/answer-tables/{index}/exportExportovat tabulku z textu odpovědi - POST
/v1/questions/{question_id}/refreshObnovit datové sady odpovědi (živá odpověď) - POST
/v1/questions/{question_id}/save-cardUložit odpověď jako kartu - POST
/v1/cards/textVytvořit textovou kartu (Markdown) - GET
/v1/filesVypsat soubory exportu - GET
/v1/files/authorsVypsat autory souborů (pro filtr administrátora) - GET
/v1/files/{file_id}Získat podrobnosti souboru - DELETE
/v1/files/{file_id}Smazat soubor - GET
/v1/files/{file_id}/downloadStáhnout soubor - GET
/v1/files/{file_id}/previewZobrazit náhled souboru - POST
/v1/files/{file_id}/extendProdloužit dobu uchovávání souboru - POST
/v1/files/{file_id}/regenerateZnovu vygenerovat soubor z uložených parametrů - GET
/v1/tasksVypsat úkoly uživatele nebo týmu - POST
/v1/sourcesVytvořit zdroj - GET
/v1/sources/{source_id}Získat zdroj - DELETE
/v1/sources/{source_id}Smazat zdroj - PATCH
/v1/sources/{source_id}Aktualizovat zdroj - PATCH
/v1/sources/{source_id}/settingsAktualizovat nastavení zdroje - GET
/v1/cards/{card_id}/similarVypsat podobné karty - GET
/v1/insights/gapsVypsat mezery ve znalostech (shluky otázek bez odpovědi) - GET
/v1/permissionsVypsat registr oprávnění - POST
/v1/uploadsZahájit vícedílné nahrávání - GET
/v1/uploads/{upload_id}Získat nahrávání - DELETE
/v1/uploads/{upload_id}Zrušit nahrávání - PUT
/v1/uploads/{upload_id}/parts/{n}Odeslat část nahrávání - POST
/v1/uploads/{upload_id}/completeDokončit nahrávání - GET
/v1/meZískat volajícího API - GET
/v1/me/permissionsZískat oprávnění aktuálního uživatele k organizaci - GET
/v1/rolesVypsat role (vestavěné i vlastní) - POST
/v1/rolesVytvořit vlastní roli - DELETE
/v1/roles/{role_id}Smazat vlastní roli - PATCH
/v1/roles/{role_id}Aktualizovat vlastní roli - GET
/v1/groupsVypsat skupiny organizace - POST
/v1/groupsVytvořit skupinu - GET
/v1/groups/{group_id}Získat skupinu s jejími členy - DELETE
/v1/groups/{group_id}Smazat skupinu - PATCH
/v1/groups/{group_id}Přejmenovat skupinu - PUT
/v1/groups/{group_id}/members/{user_id}Přidat člena do skupiny - DELETE
/v1/groups/{group_id}/members/{user_id}Odebrat člena ze skupiny - GET
/v1/org/permissionsZískat oprávnění k organizaci (kdo je administrátor) - PUT
/v1/org/permissionsPřiřadit role k organizaci - DELETE
/v1/org/permissionsOdebrat role k organizaci - GET
/v1/collections/{name}/permissionsZískat oprávnění ke kolekci (přímá i zděděná) - PUT
/v1/collections/{name}/permissionsPřiřadit role ke kolekci - DELETE
/v1/collections/{name}/permissionsOdebrat role ke kolekci - GET
/v1/cards/{card_id}/permissionsZískat oprávnění ke kartě (přímá i zděděná) - PUT
/v1/cards/{card_id}/permissionsPřiřadit role ke kartě - DELETE
/v1/cards/{card_id}/permissionsOdebrat role ke kartě - GET
/v1/sources/{source_id}/permissionsZískat oprávnění ke zdroji (přímá i zděděná) - PUT
/v1/sources/{source_id}/permissionsPřiřadit role ke zdroji - DELETE
/v1/sources/{source_id}/permissionsOdebrat role ke zdroji - POST
/v1/users/{user_id}/offboardProvést offboarding uživatele - GET
/v1/collections/{name}/foldersZískat strom složek kolekce - POST
/v1/collections/{name}/foldersVytvořit složku - GET
/v1/foldersZískat stromy složek všech kolekcí - GET
/v1/folders/{folder_id}Získat složku - DELETE
/v1/folders/{folder_id}Smazat složku a přesunout její obsah o úroveň výš - PATCH
/v1/folders/{folder_id}Přejmenovat, přesunout nebo změnit pořadí složky - GET
/v1/folders/{folder_id}/cardsVypsat karty složky - GET
/v1/folders/{folder_id}/permissionsZískat oprávnění ke složce (přímá i zděděná) - PUT
/v1/folders/{folder_id}/permissionsPřiřadit role ke složce - DELETE
/v1/folders/{folder_id}/permissionsOdebrat role ke složce - GET
/v1/catalog/servicesVypsat služby v katalogu - GET
/v1/catalog/services/{service_id}Získat službu z katalogu - GET
/v1/catalog/services/{service_id}/iconZískat ikonu služby - GET
/v1/catalog/categoriesVypsat kategorie katalogu - GET
/v1/catalog/spend-taxonomyZískat klasifikaci výdajů a příjmů - POST
/v1/catalog/resolvePřiřadit názvy ke službám katalogu - GET
/v1/draftsVypsat koncepty - POST
/v1/draftsVytvořit koncept - GET
/v1/drafts/{draft_id}Získat koncept - PATCH
/v1/drafts/{draft_id}Aktualizovat koncept - POST
/v1/drafts/{draft_id}/request-publishPožádat o publikaci - POST
/v1/drafts/{draft_id}/approveSchválit publikaci - GET
/v1/tagsVypsat štítky karet organizace - POST
/v1/cards/archiveNahrát archiv dokumentů - GET
/v1/archives/{job_id}Získat úlohu rozbalení archivu - GET
/v1/cards/{card_id}/verificationZískat blok ověření karty - POST
/v1/cards/{card_id}/verification/verifyOvěřit kartu - POST
/v1/cards/{card_id}/verification/unverifyOdebrat důvěru nebo připomenout ověřovateli - PUT
/v1/cards/{card_id}/verification/verifiersNastavit ověřovatele karty - PUT
/v1/cards/{card_id}/verification/intervalZměnit typ ověření a termín - GET
/v1/verification/queueZískat frontu ověření - GET
/v1/collections/{name}/trustZískat Trust Score kolekce - GET
/v1/org/trustZískat Trust Score organizace - GET
/v1/announcementsVypsat oznámení - POST
/v1/announcementsOdeslat oznámení povinné ke čtení - GET
/v1/announcements/{announcement_id}Získat oznámení - GET
/v1/announcements/{announcement_id}/statsZískat report oznámení - POST
/v1/announcements/{announcement_id}/remindPřipomenout těm, kdo nečetli - GET
/v1/cards/{card_id}/threadsVypsat vlákna komentářů karty - POST
/v1/cards/{card_id}/threadsPřidat komentář nebo odpověď ve vlákně - DELETE
/v1/cards/{card_id}/threads/{comment_id}Smazat komentář s odpověďmi - PATCH
/v1/cards/{card_id}/threads/{comment_id}Upravit text, vyřešit nebo znovu otevřít vlákno - GET
/v1/openapi-public.jsonZískat veřejnou specifikaci OpenAPI - GET
/v1/webhooksVypsat webhooky organizace - POST
/v1/webhooksVytvořit webhook - GET
/v1/webhooks/catalogVypsat typy událostí - GET
/v1/webhooks/{webhook_id}Získat webhook - DELETE
/v1/webhooks/{webhook_id}Smazat webhook - PATCH
/v1/webhooks/{webhook_id}Aktualizovat webhook - POST
/v1/webhooks/{webhook_id}/testOdeslat testovací událost - POST
/v1/webhooks/{webhook_id}/rotate-secretObměnit tajný klíč podpisu - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretOdvolat předchozí tajný klíč - POST
/v1/webhooks/{webhook_id}/resumeObnovit webhook - POST
/v1/webhooks/{webhook_id}/redeliverOpakovaně doručit doručení za období - GET
/v1/webhooks/{webhook_id}/attemptsVypsat pokusy o doručení - GET
/v1/webhooks/{webhook_id}/deliveriesVypsat doručení webhooku - GET
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}Získat doručení s těly a pokusy - POST
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliverOpakovaně doručit událost - GET
/v1/webhook-eventsVypsat události - GET
/v1/webhook-events/{event_id}Získat událost - GET
/v1/api-usageZískat využití API - GET
/v1/api-logsVypsat požadavky API - GET
/v1/api-logs/{request_id}Získat požadavek API - GET
/v1/appsVypsat aplikace OAuth - POST
/v1/appsVytvořit aplikaci OAuth - GET
/v1/apps/{app_id}Získat aplikaci OAuth - DELETE
/v1/apps/{app_id}Smazat aplikaci OAuth - PATCH
/v1/apps/{app_id}Aktualizovat aplikaci OAuth - POST
/v1/apps/{app_id}/rotate-secretObměnit tajný klíč klienta - GET
/v1/app-authorizationsVypsat autorizace aplikací - DELETE
/v1/app-authorizations/{authorization_id}Odvolat autorizaci zaměstnance - GET
/v1/analytics/healthZískat přehled zdraví znalostí - GET
/v1/analytics/usageZískat přehled využití - GET
/v1/analytics/contributionZískat přehled příspěvků - GET
/v1/analytics/cards/{card_id}Získat metriky karty - GET
/v1/audit/verifyOvěřit integritu auditního protokolu organizace - POST
/v1/users/importImportovat uživatele z CSV - GET
/v1/quality/gaps/followupsVypsat mezery ve znalostech převzaté k řešení - POST
/v1/quality/gaps/followupsPřevzít mezeru ve znalostech k řešení - PATCH
/v1/quality/gaps/followups/{followup_id}Aktualizovat mezeru ve znalostech převzatou k řešení - GET
/v1/access-requestsVypsat vlastní nebo příchozí žádosti o přístup - GET
/v1/access-requests/{request_id}Získat žádost o přístup pro rozhodující osobu - POST
/v1/access-requests/{request_id}/grantUdělit přístup na základě žádosti - POST
/v1/access-requests/{request_id}/denyZamítnout přístup - POST
/v1/finance/reportZískat souhrnný finanční report - POST
/v1/finance/report/exportExportovat souhrnný finanční report - POST
/v1/finance/invoicesVypsat faktury - POST
/v1/finance/invoices/exportExportovat seznam faktur - POST
/v1/finance/paymentsVypsat platby - POST
/v1/finance/payments/exportExportovat seznam plateb - GET
/v1/sources/{source_id}/push-keysVypsat klíče API vlastního zdroje - POST
/v1/sources/{source_id}/push-keysVytvořit klíč API pro vlastní zdroj - DELETE
/v1/sources/{source_id}/push-keys/{key_id}Odvolat klíč API vlastního zdroje - GET
/v1/sources/{source_id}/push-syncsVypsat synchronizace vlastního zdroje - GET
/v1/push/sources/{source_id}Ověřit klíč a získat stav vlastního zdroje - POST
/v1/push/sources/{source_id}/syncsOtevřít synchronizaci - GET
/v1/push/sources/{source_id}/syncs/{sync_number}Získat synchronizaci - GET
/v1/push/sources/{source_id}/syncs/{sync_number}/documentsVypsat výsledky dokumentů synchronizace - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/closeUzavřít synchronizaci - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/touchPotvrdit dokumenty bez opětovného odeslání - POST
/v1/push/sources/{source_id}/documentsOdeslat dokument (vytvořit nebo nahradit) - POST
/v1/push/sources/{source_id}/documents/batchOdeslat dávku dokumentů - GET
/v1/push/sources/{source_id}/documents/{external_id}Získat výsledek dokumentu - DELETE
/v1/push/sources/{source_id}/documents/{external_id}Smazat dokument