Pular para o conteúdo principal

Consultar Análise por ID

GET [Url Ambiente]/api/Analise/{id}

Esse endpoint é utilizado para consultar informações detalhadas de uma análise específica pelo seu ID.

IdentificadorValor
Content-typeapplication/json
Acceptapplication/json
AuthorizationBearer [Valor do token retornado na Autenticação]

Parâmetros de URL​

ParâmetroDescriçãoTipoExemplosObrigatório
idIdentificador único da análiseInteger123Sim

Exemplo CURL​

curl -X GET \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6...' \
  'https://evidenciaapi.acertpix.com.br/api/Analise/123'

Status Code 200​

Análise encontrada com sucesso.

ParâmetroDescriçãoTipoExemplos
idIdentificador único da análiseInteger123
chaveChave de identificaçãoString"DOC-2025-001"
documentoCPF ou CNPJString"123.456.789-00"
dataData/hora da análiseString (ISO 8601)"2025-01-20T10:00:00Z"
statusStatus atual da análiseString"Concluida"
tipoAnaliseIdID do tipo de análiseInteger1
tipoAnaliseNome do tipo de análiseString"Análise de Contrato"
empresaNomeNome da empresaString"Empresa XYZ Ltda"
camposExtrasCampos extras personalizados (se informados)Object{"CPF": "12345678910"}
totalArquivosTotal de arquivos anexadosInteger3
arquivosLista de arquivos anexadosArray[Arquivo]-
resultadoResultado da análise (se disponível)Object|null-

Objeto Arquivo​

ParâmetroDescriçãoTipoExemplos
idID do arquivoInteger456
nomeNome do arquivoString"contrato_20250120101000.pdf"
tipoContent-Type do arquivoString"application/pdf"
tamanhoTamanho em bytesInteger2048576
caminhoArquivoURL de acesso ao arquivoString"https://storage.googleapis.com/..."
statusStatus de processamentoString"Processado"
erroMensagemMensagem de erro (se houver falha)String|nullnull
dataData de uploadString (ISO 8601)"2025-01-20T10:10:00Z"
tipoDocumentoTipo do documento (se informado)String|null"Contrato"
descricaoDescrição do documento (se informada)String|null"Contrato de prestação de serviços"

Objeto Resultado​

ParâmetroDescriçãoTipoExemplos
idID do resultadoInteger789
resultadoTexto da análise gerada pelo LLMString"# Análise do Contrato\n\n..."
metadadosInformações de execução (formato JSON string)String"{\"duracao_ms\":15340,...}"
dataCriacaoData de criação do resultadoString (ISO 8601)"2025-01-20T10:25:00Z"

Exemplo​

{
  "id": 123,
  "chave": "DOC-2025-001",
  "documento": "123.456.789-00",
  "data": "2025-01-20T10:00:00Z",
  "status": "Concluida",
  "tipoAnaliseId": 1,
  "tipoAnalise": "Análise de Contrato",
  "empresaNome": "Empresa XYZ Ltda",
  "camposExtras": {
    "CPF": "12345678910",
    "Endereço": "Av. Paulista, 1578"
  },
  "totalArquivos": 2,
  "arquivos": [
    {
      "id": 456,
      "nome": "contrato_20250120101000.pdf",
      "tipo": "application/pdf",
      "tamanho": 2048576,
      "caminhoArquivo": "https://storage.googleapis.com/bucket/123/contrato_20250120101000.pdf",
      "status": "Processado",
      "erroMensagem": null,
      "data": "2025-01-20T10:10:00.123Z",
      "tipoDocumento": "Contrato",
      "descricao": "Contrato principal de prestação de serviços"
    },
    {
      "id": 457,
      "nome": "anexo_20250120101030.jpg",
      "tipo": "image/jpeg",
      "tamanho": 512000,
      "caminhoArquivo": "https://storage.googleapis.com/bucket/123/anexo_20250120101030.jpg",
      "status": "Processado",
      "erroMensagem": null,
      "data": "2025-01-20T10:10:30.456Z",
      "tipoDocumento": "Anexo",
      "descricao": null
    }
  ],
  "resultado": {
    "id": 789,
    "resultado": "# Análise do Contrato de Prestação de Serviços\n\n## Resumo Executivo\n\nO contrato apresentado estabelece uma relação de prestação de serviços...\n\n## Cláusulas Principais\n\n1. **Objeto:** Prestação de serviços de consultoria...\n2. **Prazo:** 12 meses, renovável...\n3. **Valor:** R$ 10.000,00 mensais...\n\n## Pontos de Atenção\n\n- Cláusula de rescisão unilateral favorável ao contratante\n- Ausência de cláusula de confidencialidade específica\n- Multa rescisória de 20% do valor total do contrato",
    "metadados": "{\"duracao_ms\":15340,\"tokens_input\":2500,\"tokens_output\":800,\"custo_usd\":0.0245}",
    "dataCriacao": "2025-01-20T10:25:00.789Z"
  }
}

Exemplo sem resultado (análise em andamento)​

{
  "id": 124,
  "chave": "DOC-2025-002",
  "documento": "98.765.432-10",
  "data": "2025-01-20T11:00:00Z",
  "status": "EmAnalise",
  "tipoAnaliseId": 1,
  "tipoAnalise": "Análise de Contrato",
  "empresaNome": "Empresa XYZ Ltda",
  "camposExtras": null,
  "totalArquivos": 1,
  "arquivos": [
    {
      "id": 458,
      "nome": "documento_20250120110000.pdf",
      "tipo": "application/pdf",
      "tamanho": 1024000,
      "caminhoArquivo": "https://storage.googleapis.com/bucket/124/documento_20250120110000.pdf",
      "status": "Processado",
      "erroMensagem": null,
      "data": "2025-01-20T11:05:00.123Z",
      "tipoDocumento": null,
      "descricao": null
    }
  ],
  "resultado": null
}

Status Code 401​

Requisição não autenticada ou token inválido/expirado.

ParâmetroDescriçãoTipoExemplos
errorCódigo do erroString"unauthorized"
errorDescriptionDescrição do erroString"Token inválido ou empresa não identificada"

Exemplo​

{
  "error": "unauthorized",
  "errorDescription": "Token inválido ou empresa não identificada"
}

Status Code 404​

Análise não encontrada.

ParâmetroDescriçãoTipoExemplos
errorCódigo do erroString"not_found"
errorDescriptionDescrição do erroString"Análise não encontrada"

Exemplo​

{
  "error": "not_found",
  "errorDescription": "Análise não encontrada"
}

Status Code 500​

Erro interno do servidor.

ParâmetroDescriçãoTipoExemplos
errorCódigo do erroString"server_error"
errorDescriptionDescrição do erroString"Erro interno ao obter análise"

Exemplo​

{
  "error": "server_error",
  "errorDescription": "Erro interno ao obter análise"
}

Observações​

  • A resposta inclui todos os detalhes da análise, incluindo arquivos anexados e resultado (se disponível)
  • O campo resultado será null se a análise ainda não foi concluída
  • O campo camposExtras será null se não foram informados campos extras na criação
  • O campo metadados dentro de resultado é uma string JSON com informações de execução
  • Os campos tipoDocumento e descricao dos arquivos podem ser null se não foram informados no upload
  • O campo erroMensagem nos arquivos só terá valor se houver erro no processamento

Próximos Passos​

Outros endpoints relacionados:

  1. Consultar Análise por Chave - Busque usando a chave única
  2. Criar Análise - Crie uma nova análise
  3. Upload de Arquivos - Anexe documentos
  4. Executar Análise - Inicie o processamento