OCR

Upload de PDF para OCR

Disponível somente em ambiente de produção.

Este endpoint realiza o upload de arquivos PDF para o processo de OCR (Reconhecimento Óptico de Caracteres), utilizado na automação do inbound de NFS-e e documentos de consumo (utilities).

Utilizando um conteúdo misto de tecnologias — desde Machine Learning a IA Generativa — este recurso é capaz de interpretar o conteúdo do PDF recebido, classificar e, estruturar:

  • Para documentos do tipo NFS-e, em um XML padronizado no layout ABRASF;
  • Para outros tipos de documentos, em um JSON unificado, no padrão Qive.

Requisitos:

  • Header obrigatório: X-Use-ApiGateway: always
  • O corpo da requisição deve conter:
    • 'file': conteúdo do PDF codificado em base64
    • 'filename': nome do arquivo (string)

Se o upload for bem-sucedido, a resposta incluirá o status da solicitação e um 'message_id', que poderá ser utilizado para consultar o andamento ou resultado do processamento através do endpoint /v1/ocr/status.

Para habilitar o acesso a este recurso, entre em contato com o gerente da sua conta ou com o time de atendimento da Qive.

post/v1/ocr/upload

Request

  • Base URL: https://api.arquivei.com.br
  • URL: https://api.arquivei.com.br/v1/ocr/upload
  • Auth: none declared. Required headers: X-API-ID, X-API-KEY, X-Use-ApiGateway

Headers

X-API-IDstring required

API ID usado para autenticação.

X-API-KEYstring required

API KEY usado para autenticação.

X-Use-ApiGatewaystring required

Este header indica que a request será roteada pelo API Gateway da Qive e o valor deve ser passado como always.

Request body

metaobject

meta is the metadata sent in key and value format

filestring required

file is the content of the file in base64

filenamestring required

filename is the name of the file to be sent

Example request

{
  "meta": {
    "chave": "valor"
  },
  "file": "arquivo.pdf",
  "filename": "base64 string"
}

Response

Successful upload

Changes

No recorded changes to this operation across all 1 revision of this API.