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.
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 |
|---|---|---|---|---|
| id | Identificador único da análise | Integer | 123 | Sim |
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âmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| id | Identificador único da análise | Integer | 123 |
| data | Data/hora da análise | String (ISO 8601) | "2025-01-20T10:00:00Z" |
| data_criacao | Data/hora de criação no sistema | String (ISO 8601) | "2025-01-20T10:05:30Z" |
| chave | Chave de identificação | String | "DOC-2025-001" |
| documento | CPF ou CNPJ | String | "123.456.789-00" |
| tipo_analise_id | ID do tipo de análise | Integer | 1 |
| empresa_id | ID da empresa | Integer | 45 |
| status | Status atual da análise (Tabela) | String | "Concluida" |
| arquivos | Lista de arquivos anexados | Array[Arquivo] | - |
| resultado | Resultado da análise (se disponível) | Object | - |
Objeto Arquivo
| Parâmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| id | ID do arquivo | Integer | 456 |
| nome | Nome original do arquivo | String | "contrato.pdf" |
| tipo | Content-Type do arquivo | String | "application/pdf" |
| tamanho | Tamanho em bytes | Integer | 2048576 |
| caminho_arquivo | URL de acesso ao arquivo | String | "https://storage.googleapis.com/..." |
| status_processamento | Status de processamento (Tabela) | String | "Processado" |
| data_criacao | Data de upload | String (ISO 8601) | "2025-01-20T10:10:00Z" |
| metadados | Metadados extraídos (se disponível) | Object | - |
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 | Object | - |
| data_criacao | Data de criação do resultado | String (ISO 8601) | "2025-01-20T10:25:00Z" |
Objeto Metadados (Resultado)
| Parâmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| duracao_ms | Duração da execução em milissegundos | Integer | 15340 |
| tokens_input | Total de tokens de entrada | Integer | 2500 |
| tokens_output | Total de tokens de saída | Integer | 800 |
| custo_usd | Custo estimado em USD | Decimal | 0.0245 |
| modelo_llm | Modelo LLM utilizado | String | "gpt-5" |
| provider | Provedor do LLM | String | "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âmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| status | Status da requisição | Integer | 1 |
| messages | Lista de mensagens de erro | Array[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âmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| status | Status da requisição | Integer | 1 |
| messages | Lista de mensagens de erro | Array[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âmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| status | Status da requisição | Integer | 1 |
| messages | Lista de mensagens de erro | Array[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âmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| status | Status da requisição | Integer | 1 |
| messages | Lista de mensagens de erro | Array[String] | ["Erro ao consultar análise"] |
Exemplo
{
"status": 1,
"messages": [
"Erro interno ao processar a requisição"
]
}