Buscar um documento

Após enviar um documento, você pode consultar o status e o resultado do processamento através desta rota. É necessário informar o id (UUID) do documento, retornado no momento do upload.

Endpoint

GET URL Ambiente/documents/[id]

Headers

Identificador	Valor	Obrigatório
Accept	application/json	Recomendado
IDEXA-API-KEY	sua_api_key	Sim

---

Exemplos de Requisição

cURL

curl -X GET "URL_BASE/documents/{id}" \
-H "IDEXA-API-KEY: sua_api_key" \
-H "Content-Type: application/json"

JavaScript

const myHeaders = new Headers();

myHeaders.append("IDEXA-API-KEY", "sua_api_key");
myHeaders.append("Content-Type", "application/json");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow",
};

fetch("URL_BASE/documents/{id}", requestOptions)
  .then((response) => response.json())
  .then((result) => console.log(result))
  .catch((error) => console.log("error", error));

Python

import requests

url = "URL_BASE/documents/{id}"

headers = {
  'IDEXA-API-KEY': 'sua_api_key',
  'Content-Type': 'application/json'
}

response = requests.request(
  "GET",
  url,
  headers=headers
)

print(response.json())

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "URL_BASE/documents/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "IDEXA-API-KEY: sua_api_key"
  ],
]);

$response = curl_exec($curl);

curl_close($curl);

echo $response;

---

Respostas

200 OK Sucesso

Um HTTP 200 é retornado quando o ID informado é válido. Fique atento ao campo status no retorno JSON:

• 0 (RECEIVED): Recebido, aguardando processamento.
• 3 (IN PROGRESS): Sendo processado neste momento.
• 1 (FINISHED): Processamento concluído com sucesso. O objeto data estará preenchido.
• 2 (ERROR): Ocorreu um erro interno ao tentar ler o documento.

{
  "id": "bc1bc4ea-8964-4bb7-97cc-2d77d39908d8",
  "data": { /* Dados extraídos pela IA */ },
  "status": 1,
  "statusDesc": "FINISHED"
}

---

4xx Falha na requisição

Status	Motivo
400 Bad Request	O ID informado na URL não está no formato UUID válido.
401 Unauthorized	Chave de API inválida ou não informada no Header.
404 Not Found	External ID duplicado

---

500 Falha na requisição

Status	Motivo
500 Internal Server Error	Ocorreu um erro interno ao processar a requisição.

---

400 (ID Inválido)

{
  "message": "The provided 'id' is not a valid UUID. Please check the format and try again."
}

401 (Autenticação)

{
  "message": "Token signature failure"
}

404 (Não encontrado)

{
  "message": "Document not found"
}

500 (Erro Interno)

{
  "message": "An internal server error occurred. Please try again later."
}