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.

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://api.evidencia.acertpix.com.br/api/analise/chave/DOC-2025-001'

Status Code 200

Análise encontrada com sucesso. Retorna os mesmos dados do endpoint Consultar por ID.

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	Descrição do documento	String	"Contrato de Prestação de Serviços"
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	-

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"
    }
  ],
  "resultado": {
    "id": 789,
    "resultado": "# Análise do Contrato\n\n...",
    "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 com a chave especificada.

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 chave 'DOC-2025-001' 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"
  ]
}