Pular para o conteúdo principal

Quickstart da API

Use a API da Cogneris quando outro sistema precisa enviar documentos e consumir resultados estruturados.

Deixe o seu assistente de IA fazer isso

Conecte o seu editor ao servidor MCP da Cogneris e peça a integração — o assistente lê o contrato desta API, cria a chave e escreve o código. Veja o livro de prompts.

APIs da Cogneris #3: Classificar documentos e extrair dados pela API do Vision Assistir no YouTube

Antes de começar​

  • Confirme que o acesso à API está habilitado para o seu tenant.
  • Gere uma chave de API e guarde-a numa variável de ambiente como COGNERIS_API_KEY — nunca no controle de versão.
  • Use o host da API da região do seu tenant: https://api-eu.cogneris.ai (Europa, onde os tenants novos são criados) ou https://api-us.cogneris.ai (Estados Unidos). Uma chave só funciona na sua própria região.

Passo a passo​

  1. Envie o documento como multipart/form-data, com a chave no cabeçalho Authorization: Bearer.
  2. Interprete o corpo da resposta como JSON.
  3. Verifique hasErrors e o status HTTP, e leia o resultado em data.
  4. Registre os identificadores da requisição ou os detalhes de suporte quando uma chamada falhar.
cuidado

Algumas respostas dos serviços da Cogneris chegam com Content-Type: text/plain embora o corpo seja JSON. Os clientes da API devem interpretar o corpo como JSON mesmo quando o tipo de conteúdo não for application/json.

Use uma chave de produção

Os endpoints síncronos /Document/*, incluindo o exemplo abaixo, aceitam apenas uma chave de produção (xtkt_live_). Uma chave sandbox (xtkt_test_) — a que um assistente de IA cria, a menos que você peça produção — é recusada com 403 e o código environment.sandbox_route_unavailable. Chaves sandbox cobrem só o fluxo assíncrono de jobs; veja Exemplos da API.

Exemplo​

Extraia os campos de uma nota fiscal:

curl -X POST "https://api-eu.cogneris.ai/Document/extraction" \
  -H "Authorization: Bearer $COGNERIS_API_KEY" \
  -F "file=@./nota.pdf"

A resposta traz os campos extraídos direto em data.metadata, uma chave por campo do template. Cada campo é um objeto com o value, a confidence (0–100) e, quando o valor foi localizado na página, page, bbox e bbox_confidence. Um campo de lista é um array de linhas cujas células têm o mesmo formato:

{
  "data": {
    "id": "9d8a7c6e-1b2f-4a3d-9e8f-7c6d5b4a3210",
    "metadata": {
      "numeroNota": { "value": "NF-2026-00123", "confidence": 98, "page": 1, "bbox": [0.62, 0.11, 0.83, 0.14], "bbox_confidence": 92 },
      "valorTotal": { "value": "1542.30", "confidence": 95 },
      "itens": [
        {
          "descricao": { "value": "Widget A", "confidence": 97, "page": 1, "bbox": [0.08, 0.41, 0.35, 0.44], "bbox_confidence": 90 },
          "valor": { "value": "1000.00", "confidence": 96, "page": 1, "bbox": [0.78, 0.41, 0.91, 0.44], "bbox_confidence": 89 }
        }
      ]
    }
  },
  "meta": { "httpStatusCode": 200, "messages": [] },
  "hasErrors": false
}

Leia um valor com data.metadata.numeroNota.value. Arquivos aceitos: .pdf, .png, .jpg, .jpeg, .tiff, .tif, .bmp, .doc, .docx, até 10 MB. O limite é de 50 requisições por minuto por chave.

Documentos relacionados​