Consultar Análise por Chave

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

Esse endpoint é utilizado para consultar informações detalhadas de uma análise específica pela sua chave única de identificação. Retorna exatamente os mesmos dados do endpoint de consulta por ID.

Header

Identificador	Valor
Content-type	application/json
Accept	application/json
Authorization	Bearer [Valor do token retornado na Autenticação]

Parâmetros de URL

Parâmetro	Descrição	Tipo	Exemplos	Obrigatório
chave	Chave única de identificação da análise	String	DOC-2025-001	Sim

Exemplo CURL

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

Status Code 200

Análise encontrada com sucesso.

Parâmetro	Descrição	Tipo	Exemplos
id	Identificador único da análise	Integer	123
chave	Chave de identificação	String	"DOC-2025-001"
documento	CPF ou CNPJ	String	"123.456.789-00"
data	Data/hora da análise	String (ISO 8601)	"2025-01-20T10:00:00Z"
status	Status atual da análise	String	"Concluida"
tipoAnaliseId	ID do tipo de análise	Integer	1
tipoAnalise	Nome do tipo de análise	String	"Análise de Contrato"
empresaNome	Nome da empresa	String	"Empresa XYZ Ltda"
camposExtras	Campos extras personalizados (se informados)	Object	{"CPF": "12345678910"}
totalArquivos	Total de arquivos anexados	Integer	3
arquivos	Lista de arquivos anexados	Array[Arquivo]	-
resultado	Resultado da análise (se disponível)	Object|null	-

Objeto Arquivo

Parâmetro	Descrição	Tipo	Exemplos
id	ID do arquivo	Integer	456
nome	Nome do arquivo	String	"contrato_20250120101000.pdf"
tipo	Content-Type do arquivo	String	"application/pdf"
tamanho	Tamanho em bytes	Integer	2048576
caminhoArquivo	URL de acesso ao arquivo	String	"https://storage.googleapis.com/..."
status	Status de processamento	String	"Processado"
erroMensagem	Mensagem de erro (se houver falha)	String|null	null
data	Data de upload	String (ISO 8601)	"2025-01-20T10:10:00Z"
tipoDocumento	Tipo do documento (se informado)	String|null	"Contrato"
descricao	Descrição do documento (se informada)	String|null	"Contrato de prestação de serviços"

Objeto Resultado

Parâmetro	Descrição	Tipo	Exemplos
id	ID do resultado	Integer	789
resultado	Texto da análise gerada pelo LLM	String	"# Análise do Contrato\n\n..."
metadados	Informações de execução (formato JSON string)	String	"{\\"duracao_ms\\":15340,...}"
dataCriacao	Data de criação do resultado	String (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âmetro	Descrição	Tipo	Exemplos
error	Código do erro	String	"unauthorized"
errorDescription	Descrição do erro	String	"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 com a chave especificada.

Parâmetro	Descrição	Tipo	Exemplos
error	Código do erro	String	"not_found"
errorDescription	Descrição do erro	String	"Análise com chave 'DOC-2025-001' não encontrada"

Exemplo

{
  "error": "not_found",
  "errorDescription": "Análise com chave 'DOC-2025-001' não encontrada"
}

Status Code 500

Erro interno do servidor.

Parâmetro	Descrição	Tipo	Exemplos
error	Código do erro	String	"server_error"
errorDescription	Descrição do erro	String	"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 ID - Busque usando o ID numérico
2. Criar Análise - Crie uma nova análise
3. Upload de Arquivos - Anexe documentos
4. Executar Análise - Inicie o processamento