Objects
Error
Standard error response. detail is a string, an object with code (for example choose_org, org_suspended, invitation codes) or a list of validation errors (422). error is a structured description: a code from the error catalog, an English message, structured details and the request ID.
Fields
Error message, an object with a code, or a list of validation errors.
errorErrorInfo
Used by
- GET
/v1/healthGet service status and version - GET
/v1/usersList users of the organization - POST
/v1/usersCreate a user - PATCH
/v1/users/{user_id}Update a user - GET
/v1/api-keysList API keys of the organization - POST
/v1/api-keysCreate an API key - DELETE
/v1/api-keys/{key_id}Revoke an API key - PATCH
/v1/api-keys/{key_id}Update an API key - POST
/v1/api-keys/{key_id}/rollRoll an API key - POST
/v1/api-keys/{key_id}/revoke-previousRevoke the previous value of an API key - GET
/v1/auditList audit log entries - GET
/v1/audit/actionsList audit log actions with counts - GET
/v1/audit/export.csvExport the audit log as CSV - GET
/v1/orgGet the organization - GET
/v1/categoriesList document categories - POST
/v1/categoriesCreate a category - DELETE
/v1/categories/{key}Delete a custom category - PATCH
/v1/categories/{key}Update a category - GET
/v1/collectionsList collections available to the user - POST
/v1/collectionsCreate a collection - DELETE
/v1/collections/{name}Delete a collection - PATCH
/v1/collections/{name}Update a collection - POST
/v1/collections/{name}/reindexReindex a collection - GET
/v1/collections/{name}/statsGet the collection overview: stats, categories, recent cards, permissions - GET
/v1/cardsList cards - POST
/v1/cardsUpload a file as a card - GET
/v1/jobsList indexing jobs - GET
/v1/jobs/summaryGet the queue summary - GET
/v1/jobs/streamStream job changes (SSE) - GET
/v1/jobs/{job_id}Get a job - DELETE
/v1/jobs/{job_id}Cancel a queued job - GET
/v1/cards/countCount cards - GET
/v1/cards/export.xlsxExport the card list to XLSX - POST
/v1/cards/bulkRun a bulk action on cards - GET
/v1/cards/{card_id}Get a card with its versions, comments, tables and events - DELETE
/v1/cards/{card_id}Delete a card - PATCH
/v1/cards/{card_id}Update a card - GET
/v1/cards-by-external-id/{external_id}Get a card by external ID - PUT
/v1/cards-by-external-id/{external_id}Create or replace a card by external ID - GET
/v1/cards/{card_id}/contentGet the card text by section - PUT
/v1/cards/{card_id}/contentReplace the content of a card - GET
/v1/cards/{card_id}/tables/{table_id}/rowsList rows of a fact table - GET
/v1/cards/{card_id}/versions/{a}/diff/{b}Compare two versions of a card - GET
/v1/cards/{card_id}/usageList questions whose answers used the card - POST
/v1/cards/{card_id}/usageRecord a card usage event - POST
/v1/cards/{card_id}/reindexReindex a card - DELETE
/v1/cards/{card_id}/comments/{comment_id}Delete a comment - GET
/v1/cards/{card_id}/fileDownload the original file of a card - GET
/v1/cards/{card_id}/exportExport a card to a document - POST
/v1/cards/{card_id}/verifyConfirm that a card is up to date - POST
/v1/cards/{card_id}/commentsAdd a comment - GET
/v1/conversationsList conversations - GET
/v1/conversations/{conv_id}Get a conversation with its turns - POST
/v1/searchSearch collections - POST
/v1/askGet an assistant answer without streaming - POST
/v1/chatStream an assistant answer (SSE) - POST
/v1/questions/{question_id}/feedbackRate an answer - GET
/v1/questions/export.csvExport the question log to CSV - GET
/v1/questions/{question_id}Get a saved question with its answer - GET
/v1/questions/{question_id}/followupsGet suggested follow-up questions - GET
/v1/questionsList the question log - GET
/v1/questions/{question_id}/exportExport an answer to a document - GET
/v1/questions/{question_id}/datasets/{dataset_id}/exportExport a dataset of an answer - GET
/v1/questions/{question_id}/answer-tables/{index}/exportExport a table from the answer text - POST
/v1/questions/{question_id}/refreshRefresh the datasets of an answer (live answer) - POST
/v1/questions/{question_id}/save-cardSave an answer as a card - POST
/v1/cards/textCreate a text card (Markdown) - GET
/v1/filesList export files - GET
/v1/files/authorsList file authors (for the admin filter) - GET
/v1/files/{file_id}Get file details - DELETE
/v1/files/{file_id}Delete a file - GET
/v1/files/{file_id}/downloadDownload a file - GET
/v1/files/{file_id}/previewPreview a file - POST
/v1/files/{file_id}/extendExtend the retention period of a file - POST
/v1/files/{file_id}/regenerateRegenerate a file from its saved parameters - GET
/v1/tasksList the tasks of a user or a team - POST
/v1/sourcesCreate a source - GET
/v1/sources/{source_id}Get a source - DELETE
/v1/sources/{source_id}Delete a source - PATCH
/v1/sources/{source_id}Update a source - PATCH
/v1/sources/{source_id}/settingsUpdate source settings - GET
/v1/cards/{card_id}/similarList similar cards - GET
/v1/insights/gapsList knowledge gaps (clusters of unanswered questions) - GET
/v1/permissionsList the permission registry - POST
/v1/uploadsStart a multipart upload - GET
/v1/uploads/{upload_id}Get an upload - DELETE
/v1/uploads/{upload_id}Cancel an upload - PUT
/v1/uploads/{upload_id}/parts/{n}Send an upload part - POST
/v1/uploads/{upload_id}/completeComplete an upload - GET
/v1/meGet the caller of the API - GET
/v1/me/permissionsGet the current user's permissions on the organization - GET
/v1/rolesList roles (built-in and custom) - POST
/v1/rolesCreate a custom role - DELETE
/v1/roles/{role_id}Delete a custom role - PATCH
/v1/roles/{role_id}Update a custom role - GET
/v1/groupsList groups of the organization - POST
/v1/groupsCreate a group - GET
/v1/groups/{group_id}Get a group with its members - DELETE
/v1/groups/{group_id}Delete a group - PATCH
/v1/groups/{group_id}Rename a group - PUT
/v1/groups/{group_id}/members/{user_id}Add a member to a group - DELETE
/v1/groups/{group_id}/members/{user_id}Remove a member from a group - GET
/v1/org/permissionsGet permissions on the organization (who is an admin) - PUT
/v1/org/permissionsGrant roles on the organization - DELETE
/v1/org/permissionsRevoke roles on the organization - GET
/v1/collections/{name}/permissionsGet permissions on a collection (direct and inherited) - PUT
/v1/collections/{name}/permissionsGrant roles on a collection - DELETE
/v1/collections/{name}/permissionsRevoke roles on a collection - GET
/v1/cards/{card_id}/permissionsGet permissions on a card (direct and inherited) - PUT
/v1/cards/{card_id}/permissionsGrant roles on a card - DELETE
/v1/cards/{card_id}/permissionsRevoke roles on a card - GET
/v1/sources/{source_id}/permissionsGet permissions on a source (direct and inherited) - PUT
/v1/sources/{source_id}/permissionsGrant roles on a source - DELETE
/v1/sources/{source_id}/permissionsRevoke roles on a source - POST
/v1/users/{user_id}/offboardOffboard a user - GET
/v1/collections/{name}/foldersGet the folder tree of a collection - POST
/v1/collections/{name}/foldersCreate a folder - GET
/v1/foldersGet the folder trees of all collections - GET
/v1/folders/{folder_id}Get a folder - DELETE
/v1/folders/{folder_id}Delete a folder and promote its content - PATCH
/v1/folders/{folder_id}Rename, move or reorder a folder - GET
/v1/folders/{folder_id}/cardsList the cards of a folder - GET
/v1/folders/{folder_id}/permissionsGet permissions on a folder (direct and inherited) - PUT
/v1/folders/{folder_id}/permissionsGrant roles on a folder - DELETE
/v1/folders/{folder_id}/permissionsRevoke roles on a folder - GET
/v1/catalog/servicesList services in the catalog - GET
/v1/catalog/services/{service_id}Get a catalog service - GET
/v1/catalog/services/{service_id}/iconGet the icon of a service - GET
/v1/catalog/categoriesList catalog categories - GET
/v1/catalog/spend-taxonomyGet the spend and revenue taxonomy - POST
/v1/catalog/resolveMatch names to catalog services - GET
/v1/draftsList drafts - POST
/v1/draftsCreate a draft - GET
/v1/drafts/{draft_id}Get a draft - PATCH
/v1/drafts/{draft_id}Update a draft - POST
/v1/drafts/{draft_id}/request-publishRequest publication - POST
/v1/drafts/{draft_id}/approveApprove publication - GET
/v1/tagsList card tags of the organization - POST
/v1/cards/archiveUpload an archive of documents - GET
/v1/archives/{job_id}Get an archive extraction job - GET
/v1/cards/{card_id}/verificationGet the verification block of a card - POST
/v1/cards/{card_id}/verification/verifyVerify a card - POST
/v1/cards/{card_id}/verification/unverifyRemove trust or remind the verifier - PUT
/v1/cards/{card_id}/verification/verifiersSet the verifiers of a card - PUT
/v1/cards/{card_id}/verification/intervalChange the verification type and due date - GET
/v1/verification/queueGet the verification queue - GET
/v1/collections/{name}/trustGet the Trust Score of a collection - GET
/v1/org/trustGet the Trust Score of the organization - GET
/v1/announcementsList announcements - POST
/v1/announcementsSend a must-read announcement - GET
/v1/announcements/{announcement_id}Get an announcement - GET
/v1/announcements/{announcement_id}/statsGet the announcement report - POST
/v1/announcements/{announcement_id}/remindRemind those who have not read - GET
/v1/cards/{card_id}/threadsList comment threads of a card - POST
/v1/cards/{card_id}/threadsAdd a comment or a reply in a thread - DELETE
/v1/cards/{card_id}/threads/{comment_id}Delete a comment with its replies - PATCH
/v1/cards/{card_id}/threads/{comment_id}Edit the text, resolve or reopen a thread - GET
/v1/openapi-public.jsonGet the public OpenAPI specification - GET
/v1/webhooksList webhooks of the organization - POST
/v1/webhooksCreate a webhook - GET
/v1/webhooks/catalogList event types - GET
/v1/webhooks/{webhook_id}Get a webhook - DELETE
/v1/webhooks/{webhook_id}Delete a webhook - PATCH
/v1/webhooks/{webhook_id}Update a webhook - POST
/v1/webhooks/{webhook_id}/testSend a test event - POST
/v1/webhooks/{webhook_id}/rotate-secretRotate the signing secret - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretRevoke the previous secret - POST
/v1/webhooks/{webhook_id}/resumeResume a webhook - POST
/v1/webhooks/{webhook_id}/redeliverRedeliver deliveries for a period - GET
/v1/webhooks/{webhook_id}/attemptsList delivery attempts - GET
/v1/webhooks/{webhook_id}/deliveriesList webhook deliveries - GET
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}Get a delivery with bodies and attempts - POST
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliverRedeliver an event - GET
/v1/webhook-eventsList events - GET
/v1/webhook-events/{event_id}Get an event - GET
/v1/api-usageGet API usage - GET
/v1/api-logsList API requests - GET
/v1/api-logs/{request_id}Get an API request - GET
/v1/appsList OAuth apps - POST
/v1/appsCreate an OAuth app - GET
/v1/apps/{app_id}Get an OAuth app - DELETE
/v1/apps/{app_id}Delete an OAuth app - PATCH
/v1/apps/{app_id}Update an OAuth app - POST
/v1/apps/{app_id}/rotate-secretRotate the client secret - GET
/v1/app-authorizationsList app authorizations - DELETE
/v1/app-authorizations/{authorization_id}Revoke an employee authorization - GET
/v1/analytics/healthGet the knowledge health dashboard - GET
/v1/analytics/usageGet the usage dashboard - GET
/v1/analytics/contributionGet the contribution dashboard - GET
/v1/analytics/cards/{card_id}Get card metrics - GET
/v1/audit/verifyVerify the integrity of the organization's audit log - POST
/v1/users/importImport users from CSV - GET
/v1/quality/gaps/followupsList knowledge gaps in progress - POST
/v1/quality/gaps/followupsTake a knowledge gap into work - PATCH
/v1/quality/gaps/followups/{followup_id}Update a knowledge gap in progress - GET
/v1/access-requestsList own or incoming access requests - GET
/v1/access-requests/{request_id}Get an access request for a decider - POST
/v1/access-requests/{request_id}/grantGrant access on a request - POST
/v1/access-requests/{request_id}/denyDeny access - POST
/v1/finance/reportGet a financial summary report - POST
/v1/finance/report/exportExport the financial summary report - POST
/v1/finance/invoicesList invoices - POST
/v1/finance/invoices/exportExport the invoice list - POST
/v1/finance/paymentsList payments - POST
/v1/finance/payments/exportExport the payment list - GET
/v1/sources/{source_id}/push-keysList API keys of a custom source - POST
/v1/sources/{source_id}/push-keysCreate an API key for a custom source - DELETE
/v1/sources/{source_id}/push-keys/{key_id}Revoke an API key of a custom source - GET
/v1/sources/{source_id}/push-syncsList syncs of a custom source - GET
/v1/push/sources/{source_id}Check the key and get the state of a custom source - POST
/v1/push/sources/{source_id}/syncsOpen a sync - GET
/v1/push/sources/{source_id}/syncs/{sync_number}Get a sync - GET
/v1/push/sources/{source_id}/syncs/{sync_number}/documentsList document results of a sync - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/closeClose a sync - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/touchConfirm documents without sending them again - POST
/v1/push/sources/{source_id}/documentsSend a document (create or replace) - POST
/v1/push/sources/{source_id}/documents/batchSend a batch of documents - GET
/v1/push/sources/{source_id}/documents/{external_id}Get the result of a document - DELETE
/v1/push/sources/{source_id}/documents/{external_id}Delete a document