Arquivos enviados a um conhecimento são processados em segundo plano e viram registros.
Excluir arquivo
Exclui o arquivo e todos os registros gerados a partir dele.
path Parameters
fileidstring · requiredID do arquivo.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Arquivo e registros excluídos.
messagestring · required
Baixar arquivo do conhecimento
Baixa o arquivo original enviado ao conhecimento.
path Parameters
fileidstring · requiredID do arquivo.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Conteúdo do arquivo, com o Content-Type original.
Listar arquivos
Lista os arquivos enviados ao conhecimento e o andamento do processamento de cada um.
status | Significado |
|---|---|
uploading | Recebendo o arquivo |
processing | Extraindo o conteúdo e gerando registros |
done | Concluído |
attention | Concluído com ressalvas: parte dos registros ficou sem indexação |
failed | Falhou; o motivo vem em error_cause quando o arquivo pode ser reprocessado |
path Parameters
conhecimentoidstring · requiredID do conhecimento.
query Parameters
limitinteger · min: 0Itens por página. Sem
limit, vêm todos.cursorstringValor de
cursorrecebido na página anterior. Omita na primeira requisição.currentPageinteger · min: 1Valor de
currentPagerecebido na página anterior. Envie junto comcursor; a resposta devolve o número seguinte.totalinteger · min: 0Valor de
totalrecebido na primeira página. Reenvie junto comcursorpara a resposta continuar informando o total.totalPagesinteger · min: 0Valor de
totalPagesrecebido na primeira página. Reenvie junto comcursor.namestringFiltra pelo nome do arquivo (sem paginação).
dateInitstring · dateData inicial do período (
YYYY-MM-DD, horário de Brasília), pela data de criação.dateEndstring · dateData final do período (
YYYY-MM-DD, horário de Brasília). O dia informado entra inteiro.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Lista de arquivos.
totalinteger | nulltotalPagesinteger | nullcurrentPageinteger | nullcursorstring | nullCursor da próxima página;
nullquando não há mais.filesobject[]
Adicionar arquivo ao conhecimento
Envia um arquivo ao conhecimento. O conteúdo é extraído e transformado em registros em segundo plano: o 201 confirma só o recebimento. Acompanhe o processamento pelo status em [Listar arquivos]. O limite padrão é de 20 MB por arquivo.
path Parameters
conhecimentoidstring · requiredID do conhecimento.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
filestring · binary · requiredArquivo (documento).
namestringNome exibido na plataforma (opcional). Padrão: o nome original do arquivo.
descriptionstringDescrição do arquivo (opcional).
Responses
Arquivo recebido; o processamento segue em segundo plano.
messagestring · required