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://api.evidencia.acertpix.com.br/api/analise/123'

Status Code 200

Análise encontrada com sucesso.

ParâmetroDescriçãoTipoExemplos
idIdentificador único da análiseInteger123
dataData/hora da análiseString (ISO 8601)"2025-01-20T10:00:00Z"
data_criacaoData/hora de criação no sistemaString (ISO 8601)"2025-01-20T10:05:30Z"
chaveChave de identificaçãoString"DOC-2025-001"
documentoCPF ou CNPJString"123.456.789-00"
tipo_analise_idID do tipo de análiseInteger1
empresa_idID da empresaInteger45
statusStatus atual da análise (Tabela)String"Concluida"
arquivosLista de arquivos anexadosArray[Arquivo]-
resultadoResultado da análise (se disponível)Object-

Objeto Arquivo

ParâmetroDescriçãoTipoExemplos
idID do arquivoInteger456
nomeNome original do arquivoString"contrato.pdf"
tipoContent-Type do arquivoString"application/pdf"
tamanhoTamanho em bytesInteger2048576
caminho_arquivoURL de acesso ao arquivoString"https://storage.googleapis.com/..."
status_processamentoStatus de processamento (Tabela)String"Processado"
data_criacaoData de uploadString (ISO 8601)"2025-01-20T10:10:00Z"
metadadosMetadados extraídos (se disponível)Object-

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çãoObject-
data_criacaoData de criação do resultadoString (ISO 8601)"2025-01-20T10:25:00Z"

Objeto Metadados (Resultado)

ParâmetroDescriçãoTipoExemplos
duracao_msDuração da execução em milissegundosInteger15340
tokens_inputTotal de tokens de entradaInteger2500
tokens_outputTotal de tokens de saídaInteger800
custo_usdCusto estimado em USDDecimal0.0245
modelo_llmModelo LLM utilizadoString"gpt-5"
providerProvedor do LLMString"OpenAI"

Exemplo

{
"id": 123,
"data": "2025-01-20T10:00:00Z",
"data_criacao": "2025-01-20T10:05:30.456Z",
"chave": "DOC-2025-001",
"documento": "Contrato de Prestação de Serviços",
"tipo_analise_id": 1,
"empresa_id": 45,
"status": "Concluida",
"arquivos": [
{
"id": 456,
"nome": "contrato.pdf",
"tipo": "application/pdf",
"tamanho": 2048576,
"caminho_arquivo": "https://storage.googleapis.com/bucket/123/contrato.pdf",
"status_processamento": "Processado",
"data_criacao": "2025-01-20T10:10:00.123Z",
"metadados": {
"paginas": 15,
"autor": "João Silva",
"data_criacao": "2025-01-15T14:30:00Z"
}
}
],
"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,
"modelo_llm": "gpt-5",
"provider": "OpenAI"
},
"data_criacao": "2025-01-20T10:25:00.789Z"
}
}

Status Code 401

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

ParâmetroDescriçãoTipoExemplos
statusStatus da requisiçãoInteger1
messagesLista de mensagens de erroArray[String]["Token de autenticação inválido"]

Exemplo

{
"status": 1,
"messages": [
"Token de autenticação inválido ou expirado"
]
}

Status Code 403

Acesso negado - a análise pertence a outra empresa.

ParâmetroDescriçãoTipoExemplos
statusStatus da requisiçãoInteger1
messagesLista de mensagens de erroArray[String]["Acesso negado"]

Exemplo

{
"status": 1,
"messages": [
"Você não tem permissão para acessar esta análise"
]
}

Status Code 404

Análise não encontrada.

ParâmetroDescriçãoTipoExemplos
statusStatus da requisiçãoInteger1
messagesLista de mensagens de erroArray[String]["Análise não encontrada"]

Exemplo

{
"status": 1,
"messages": [
"Análise com ID 123 não encontrada"
]
}

Status Code 500

Erro interno do servidor.

ParâmetroDescriçãoTipoExemplos
statusStatus da requisiçãoInteger1
messagesLista de mensagens de erroArray[String]["Erro ao consultar análise"]

Exemplo

{
"status": 1,
"messages": [
"Erro interno ao processar a requisição"
]
}