Criar Análise

POST [Url Ambiente]/api/analise

Esse endpoint é utilizado para criar uma nova análise de documentos no sistema. A análise será processada posteriormente após o upload dos arquivos e execução.

Header

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

Body

Parâmetro	Descrição	Tipo	Exemplos	Obrigatório
tipo_analise_id	Identificador do tipo de análise	Integer	1	Sim
chave	Chave única de identificação do documento	String	"DOC-2025-001"	Sim
documento	CPF ou CNPJ	String	"123.456.789-00"	Sim
data	Data da análise (opcional, padrão: data atual)	String (ISO 8601)	"2025-01-20T10:00:00Z"	Não

Exemplo

{
  "tipo_analise_id": 1,
  "chave": "DOC-2025-001",
  "documento": "123.456.789-00",
  "data": "2025-01-20T10:00:00Z"
}

Exemplo CURL

curl -X POST \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6...' \
  --data-raw '{
    "tipo_analise_id": 1,
    "chave": "DOC-2025-001",
    "documento": "123.456.789-00",
    "data": "2025-01-20T10:00:00Z"
  }' \
  'https://api.evidencia.acertpix.com.br/api/analise'

Status Code 200

Análise criada 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 fornecida	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 (extraído do token)	Integer	45
status	Status atual da análise	String	"Aguardando"
arquivos	Lista de arquivos anexados	Array	[]

Exemplo

{
  "id": 123,
  "data": "2025-01-20T10:00:00Z",
  "data_criacao": "2025-01-20T10:05:30.456Z",
  "chave": "DOC-2025-001",
  "documento": "123.456.789-00",
  "tipo_analise_id": 1,
  "empresa_id": 45,
  "status": "Aguardando",
  "arquivos": []
}

Status Code 400

Erro de validação nos dados da requisição.

Parâmetro	Descrição	Tipo	Exemplos
status	Status da requisição	Integer	1
messages	Lista de mensagens de erro	Array[String]	["O campo tipo_analise_id é obrigatório"]

Exemplo

{
  "status": 1,
  "messages": [
    "O campo tipo_analise_id é obrigatório",
    "O campo chave é obrigatório"
  ]
}

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 404

Tipo de análise não encontrado ou não disponível para a empresa.

Parâmetro	Descrição	Tipo	Exemplos
status	Status da requisição	Integer	1
messages	Lista de mensagens de erro	Array[String]	["Tipo de análise não encontrado"]

Exemplo

{
  "status": 1,
  "messages": [
    "Tipo de análise com ID 1 não encontrado ou não disponível para sua empresa"
  ]
}

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 criar análise"]

Exemplo

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

Observações

• A análise criada ficará com status "Aguardando" até que arquivos sejam anexados
• Após criar a análise, utilize o endpoint Upload de Arquivos para anexar documentos
• A chave deve ser única dentro da empresa para facilitar consultas posteriores
• O campo data é opcional - se não informado, será utilizada a data/hora atual
• O tipo_analise_id determina qual modelo LLM e template de análise serão utilizados
• O status pode ser: Aguardando, Uploaded, EmAnalise, Concluida, Erro (ver Tabela de Status)

Próximos Passos

Após criar uma análise:

1. Upload de Arquivos - Anexe os documentos que serão analisados
2. Executar Análise - Inicie o processamento dos documentos
3. Consultar Análise - Verifique o status e resultados