Objetos
Error
Resposta de erro padrão. detail é uma string, um objeto com code (por exemplo choose_org, org_suspended, códigos de convite) ou uma lista de erros de validação (422). error é uma descrição estruturada: um código do catálogo de erros, uma mensagem em inglês, detalhes estruturados e o ID da requisição.
Campos
Mensagem de erro, um objeto com um código ou uma lista de erros de validação.
errorErrorInfo
Usado em
- GET
/v1/healthObter o status e a versão do serviço - GET
/v1/usersListar os usuários da organização - POST
/v1/usersCriar um usuário - PATCH
/v1/users/{user_id}Atualizar um usuário - GET
/v1/api-keysListar as chaves de API da organização - POST
/v1/api-keysCriar uma chave de API - DELETE
/v1/api-keys/{key_id}Revogar uma chave de API - PATCH
/v1/api-keys/{key_id}Atualizar uma chave de API - POST
/v1/api-keys/{key_id}/rollRotacionar uma chave de API - POST
/v1/api-keys/{key_id}/revoke-previousRevogar o valor anterior de uma chave de API - GET
/v1/auditListar as entradas do registro de auditoria - GET
/v1/audit/actionsListar as ações do registro de auditoria com contagens - GET
/v1/audit/export.csvExportar o registro de auditoria como CSV - GET
/v1/orgObter a organização - GET
/v1/categoriesListar as categorias de documentos - POST
/v1/categoriesCriar uma categoria - DELETE
/v1/categories/{key}Excluir uma categoria personalizada - PATCH
/v1/categories/{key}Atualizar uma categoria - GET
/v1/collectionsListar as coleções disponíveis para o usuário - POST
/v1/collectionsCriar uma coleção - DELETE
/v1/collections/{name}Excluir uma coleção - PATCH
/v1/collections/{name}Atualizar uma coleção - POST
/v1/collections/{name}/reindexReindexar uma coleção - GET
/v1/collections/{name}/statsObter a visão geral da coleção: estatísticas, categorias, cartões recentes, permissões - GET
/v1/cardsListar cartões - POST
/v1/cardsEnviar um arquivo como cartão - GET
/v1/jobsListar os jobs de indexação - GET
/v1/jobs/summaryObter o resumo da fila - GET
/v1/jobs/streamTransmitir as alterações dos jobs (SSE) - GET
/v1/jobs/{job_id}Obter um job - DELETE
/v1/jobs/{job_id}Cancelar um job na fila - GET
/v1/cards/countContar cartões - GET
/v1/cards/export.xlsxExportar a lista de cartões para XLSX - POST
/v1/cards/bulkExecutar uma ação em massa nos cartões - GET
/v1/cards/{card_id}Obter um cartão com as versões, os comentários, as tabelas e os eventos dele - DELETE
/v1/cards/{card_id}Excluir um cartão - PATCH
/v1/cards/{card_id}Atualizar um cartão - GET
/v1/cards-by-external-id/{external_id}Obter um cartão pelo ID externo - PUT
/v1/cards-by-external-id/{external_id}Criar ou substituir um cartão pelo ID externo - GET
/v1/cards/{card_id}/contentObter o texto do cartão por seção - PUT
/v1/cards/{card_id}/contentSubstituir o conteúdo de um cartão - GET
/v1/cards/{card_id}/tables/{table_id}/rowsListar as linhas de uma tabela de fatos - GET
/v1/cards/{card_id}/versions/{a}/diff/{b}Comparar duas versões de um cartão - GET
/v1/cards/{card_id}/usageListar as perguntas cujas respostas usaram o cartão - POST
/v1/cards/{card_id}/usageRegistrar um evento de uso do cartão - POST
/v1/cards/{card_id}/reindexReindexar um cartão - DELETE
/v1/cards/{card_id}/comments/{comment_id}Excluir um comentário - GET
/v1/cards/{card_id}/fileBaixar o arquivo original de um cartão - GET
/v1/cards/{card_id}/exportExportar um cartão para um documento - POST
/v1/cards/{card_id}/verifyConfirmar que um cartão está atualizado - POST
/v1/cards/{card_id}/commentsAdicionar um comentário - GET
/v1/conversationsListar conversas - GET
/v1/conversations/{conv_id}Obter uma conversa com os turnos dela - POST
/v1/searchBuscar nas coleções - POST
/v1/askObter uma resposta do assistente sem stream - POST
/v1/chatTransmitir uma resposta do assistente (SSE) - POST
/v1/questions/{question_id}/feedbackAvaliar uma resposta - GET
/v1/questions/export.csvExportar o registro de perguntas para CSV - GET
/v1/questions/{question_id}Obter uma pergunta salva com a resposta - GET
/v1/questions/{question_id}/followupsObter as perguntas de acompanhamento sugeridas - GET
/v1/questionsListar o registro de perguntas - GET
/v1/questions/{question_id}/exportExportar uma resposta para um documento - GET
/v1/questions/{question_id}/datasets/{dataset_id}/exportExportar um conjunto de dados de uma resposta - GET
/v1/questions/{question_id}/answer-tables/{index}/exportExportar uma tabela do texto da resposta - POST
/v1/questions/{question_id}/refreshAtualizar os conjuntos de dados de uma resposta (resposta dinâmica) - POST
/v1/questions/{question_id}/save-cardSalvar uma resposta como cartão - POST
/v1/cards/textCriar um cartão de texto (Markdown) - GET
/v1/filesListar os arquivos de exportação - GET
/v1/files/authorsListar os autores dos arquivos (para o filtro do administrador) - GET
/v1/files/{file_id}Obter os detalhes de um arquivo - DELETE
/v1/files/{file_id}Excluir um arquivo - GET
/v1/files/{file_id}/downloadBaixar um arquivo - GET
/v1/files/{file_id}/previewPré-visualizar um arquivo - POST
/v1/files/{file_id}/extendProrrogar o período de retenção de um arquivo - POST
/v1/files/{file_id}/regenerateGerar um arquivo de novo a partir dos parâmetros salvos - GET
/v1/tasksListar as tarefas de um usuário ou de uma equipe - POST
/v1/sourcesCriar uma fonte - GET
/v1/sources/{source_id}Obter uma fonte - DELETE
/v1/sources/{source_id}Excluir uma fonte - PATCH
/v1/sources/{source_id}Atualizar uma fonte - PATCH
/v1/sources/{source_id}/settingsAtualizar as configurações de uma fonte - GET
/v1/cards/{card_id}/similarListar cartões semelhantes - GET
/v1/insights/gapsListar as lacunas de conhecimento (grupos de perguntas sem resposta) - GET
/v1/permissionsListar o registro de permissões - POST
/v1/uploadsIniciar um upload em partes - GET
/v1/uploads/{upload_id}Obter um upload - DELETE
/v1/uploads/{upload_id}Cancelar um upload - PUT
/v1/uploads/{upload_id}/parts/{n}Enviar uma parte do upload - POST
/v1/uploads/{upload_id}/completeConcluir um upload - GET
/v1/meObter quem faz a chamada à API - GET
/v1/me/permissionsObter as permissões do usuário atual sobre a organização - GET
/v1/rolesListar as funções (internas e personalizadas) - POST
/v1/rolesCriar uma função personalizada - DELETE
/v1/roles/{role_id}Excluir uma função personalizada - PATCH
/v1/roles/{role_id}Atualizar uma função personalizada - GET
/v1/groupsListar os grupos da organização - POST
/v1/groupsCriar um grupo - GET
/v1/groups/{group_id}Obter um grupo com os membros dele - DELETE
/v1/groups/{group_id}Excluir um grupo - PATCH
/v1/groups/{group_id}Renomear um grupo - PUT
/v1/groups/{group_id}/members/{user_id}Adicionar um membro a um grupo - DELETE
/v1/groups/{group_id}/members/{user_id}Remover um membro de um grupo - GET
/v1/org/permissionsObter as permissões sobre a organização (quem é administrador) - PUT
/v1/org/permissionsConceder funções sobre a organização - DELETE
/v1/org/permissionsRevogar funções sobre a organização - GET
/v1/collections/{name}/permissionsObter as permissões sobre uma coleção (diretas e herdadas) - PUT
/v1/collections/{name}/permissionsConceder funções sobre uma coleção - DELETE
/v1/collections/{name}/permissionsRevogar funções sobre uma coleção - GET
/v1/cards/{card_id}/permissionsObter as permissões sobre um cartão (diretas e herdadas) - PUT
/v1/cards/{card_id}/permissionsConceder funções sobre um cartão - DELETE
/v1/cards/{card_id}/permissionsRevogar funções sobre um cartão - GET
/v1/sources/{source_id}/permissionsObter as permissões sobre uma fonte (diretas e herdadas) - PUT
/v1/sources/{source_id}/permissionsConceder funções sobre uma fonte - DELETE
/v1/sources/{source_id}/permissionsRevogar funções sobre uma fonte - POST
/v1/users/{user_id}/offboardDesligar um usuário - GET
/v1/collections/{name}/foldersObter a árvore de pastas de uma coleção - POST
/v1/collections/{name}/foldersCriar uma pasta - GET
/v1/foldersObter as árvores de pastas de todas as coleções - GET
/v1/folders/{folder_id}Obter uma pasta - DELETE
/v1/folders/{folder_id}Excluir uma pasta e subir o conteúdo dela - PATCH
/v1/folders/{folder_id}Renomear, mover ou reordenar uma pasta - GET
/v1/folders/{folder_id}/cardsListar os cartões de uma pasta - GET
/v1/folders/{folder_id}/permissionsObter as permissões sobre uma pasta (diretas e herdadas) - PUT
/v1/folders/{folder_id}/permissionsConceder funções sobre uma pasta - DELETE
/v1/folders/{folder_id}/permissionsRevogar funções sobre uma pasta - GET
/v1/catalog/servicesListar os serviços do catálogo - GET
/v1/catalog/services/{service_id}Obter um serviço do catálogo - GET
/v1/catalog/services/{service_id}/iconObter o ícone de um serviço - GET
/v1/catalog/categoriesListar as categorias do catálogo - GET
/v1/catalog/spend-taxonomyObter a taxonomia de despesas e receitas - POST
/v1/catalog/resolveAssociar nomes a serviços do catálogo - GET
/v1/draftsListar rascunhos - POST
/v1/draftsCriar um rascunho - GET
/v1/drafts/{draft_id}Obter um rascunho - PATCH
/v1/drafts/{draft_id}Atualizar um rascunho - POST
/v1/drafts/{draft_id}/request-publishSolicitar a publicação - POST
/v1/drafts/{draft_id}/approveAprovar a publicação - GET
/v1/tagsListar as etiquetas de cartões da organização - POST
/v1/cards/archiveEnviar um arquivo compactado de documentos - GET
/v1/archives/{job_id}Obter um job de extração de arquivo compactado - GET
/v1/cards/{card_id}/verificationObter o bloco de verificação de um cartão - POST
/v1/cards/{card_id}/verification/verifyVerificar um cartão - POST
/v1/cards/{card_id}/verification/unverifyRemover a confiança ou lembrar o verificador - PUT
/v1/cards/{card_id}/verification/verifiersDefinir os verificadores de um cartão - PUT
/v1/cards/{card_id}/verification/intervalAlterar o tipo de verificação e a data de vencimento - GET
/v1/verification/queueObter a fila de verificação - GET
/v1/collections/{name}/trustObter o índice de confiança (“Trust Score”) de uma coleção - GET
/v1/org/trustObter o índice de confiança (“Trust Score”) da organização - GET
/v1/announcementsListar comunicados - POST
/v1/announcementsEnviar um comunicado de leitura obrigatória - GET
/v1/announcements/{announcement_id}Obter um comunicado - GET
/v1/announcements/{announcement_id}/statsObter o relatório do comunicado - POST
/v1/announcements/{announcement_id}/remindLembrar quem não leu - GET
/v1/cards/{card_id}/threadsListar as threads de comentários de um cartão - POST
/v1/cards/{card_id}/threadsAdicionar um comentário ou uma resposta em uma thread - DELETE
/v1/cards/{card_id}/threads/{comment_id}Excluir um comentário com as respostas dele - PATCH
/v1/cards/{card_id}/threads/{comment_id}Editar o texto, resolver ou reabrir uma thread - GET
/v1/openapi-public.jsonObter a especificação OpenAPI pública - GET
/v1/webhooksListar os webhooks da organização - POST
/v1/webhooksCriar um webhook - GET
/v1/webhooks/catalogListar os tipos de evento - GET
/v1/webhooks/{webhook_id}Obter um webhook - DELETE
/v1/webhooks/{webhook_id}Excluir um webhook - PATCH
/v1/webhooks/{webhook_id}Atualizar um webhook - POST
/v1/webhooks/{webhook_id}/testEnviar um evento de teste - POST
/v1/webhooks/{webhook_id}/rotate-secretRotacionar o segredo de assinatura - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretRevogar o segredo anterior - POST
/v1/webhooks/{webhook_id}/resumeRetomar um webhook - POST
/v1/webhooks/{webhook_id}/redeliverReenviar as entregas de um período - GET
/v1/webhooks/{webhook_id}/attemptsListar as tentativas de entrega - GET
/v1/webhooks/{webhook_id}/deliveriesListar as entregas de webhooks - GET
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}Obter uma entrega com os corpos e as tentativas - POST
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/redeliverReenviar um evento - GET
/v1/webhook-eventsListar eventos - GET
/v1/webhook-events/{event_id}Obter um evento - GET
/v1/api-usageObter o uso da API - GET
/v1/api-logsListar as requisições da API - GET
/v1/api-logs/{request_id}Obter uma requisição da API - GET
/v1/appsListar os apps OAuth - POST
/v1/appsCriar um app OAuth - GET
/v1/apps/{app_id}Obter um app OAuth - DELETE
/v1/apps/{app_id}Excluir um app OAuth - PATCH
/v1/apps/{app_id}Atualizar um app OAuth - POST
/v1/apps/{app_id}/rotate-secretRotacionar o segredo do cliente - GET
/v1/app-authorizationsListar as autorizações de apps - DELETE
/v1/app-authorizations/{authorization_id}Revogar a autorização de um colaborador - GET
/v1/analytics/healthObter o painel de saúde do conhecimento - GET
/v1/analytics/usageObter o painel de uso - GET
/v1/analytics/contributionObter o painel de contribuição - GET
/v1/analytics/cards/{card_id}Obter as métricas de um cartão - GET
/v1/audit/verifyConferir a integridade do registro de auditoria da organização - POST
/v1/users/importImportar usuários de um CSV - GET
/v1/quality/gaps/followupsListar as lacunas de conhecimento em andamento - POST
/v1/quality/gaps/followupsColocar uma lacuna de conhecimento em andamento - PATCH
/v1/quality/gaps/followups/{followup_id}Atualizar uma lacuna de conhecimento em andamento - GET
/v1/access-requestsListar as solicitações de acesso próprias ou recebidas - GET
/v1/access-requests/{request_id}Obter uma solicitação de acesso para quem decide - POST
/v1/access-requests/{request_id}/grantConceder acesso em uma solicitação - POST
/v1/access-requests/{request_id}/denyNegar o acesso - POST
/v1/finance/reportObter um relatório financeiro resumido - POST
/v1/finance/report/exportExportar o relatório financeiro resumido - POST
/v1/finance/invoicesListar faturas - POST
/v1/finance/invoices/exportExportar a lista de faturas - POST
/v1/finance/paymentsListar pagamentos - POST
/v1/finance/payments/exportExportar a lista de pagamentos - GET
/v1/sources/{source_id}/push-keysListar as chaves de API de uma fonte personalizada - POST
/v1/sources/{source_id}/push-keysCriar uma chave de API para uma fonte personalizada - DELETE
/v1/sources/{source_id}/push-keys/{key_id}Revogar uma chave de API de uma fonte personalizada - GET
/v1/sources/{source_id}/push-syncsListar as sincronizações de uma fonte personalizada - GET
/v1/push/sources/{source_id}Conferir a chave e obter o estado de uma fonte personalizada - POST
/v1/push/sources/{source_id}/syncsAbrir uma sincronização - GET
/v1/push/sources/{source_id}/syncs/{sync_number}Obter uma sincronização - GET
/v1/push/sources/{source_id}/syncs/{sync_number}/documentsListar os resultados dos documentos de uma sincronização - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/closeFechar uma sincronização - POST
/v1/push/sources/{source_id}/syncs/{sync_number}/touchConfirmar documentos sem enviá-los de novo - POST
/v1/push/sources/{source_id}/documentsEnviar um documento (criar ou substituir) - POST
/v1/push/sources/{source_id}/documents/batchEnviar um lote de documentos - GET
/v1/push/sources/{source_id}/documents/{external_id}Obter o resultado de um documento - DELETE
/v1/push/sources/{source_id}/documents/{external_id}Excluir um documento