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
tipoAnaliseId	Identificador do tipo de análise	Integer	1	Sim
chave	Chave única de identificação do documento (máx. 255 caracteres)	String	"DOC-2025-001"	Sim
documento	CPF ou CNPJ (máx. 20 caracteres)	String	"123.456.789-00"	Não
camposExtras	Objeto com campos adicionais em formato chave-valor	Object	{"CPF": "12345678910", "Endereço": "Av. Paulista, 1578 - Bela Vista, São Paulo"}	Não

Exemplo

{
  "tipoAnaliseId": 1,
  "chave": "DOC-2025-001",
  "documento": "123.456.789-00"
}

Exemplo com Campos Extras

{
  "chave": "DOC-2025-002",
  "tipoAnaliseId": 1,
  "documento": "123.456.789-00",
  "camposExtras": {
    "CPF": "12345678910",
    "Endereço": "Av. Paulista, 1578 - Bela Vista, São Paulo"
  }
}

Exemplo CURL

curl -X POST \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6...' \
  --data-raw '{
    "tipoAnaliseId": 1,
    "chave": "DOC-2025-001",
    "documento": "123.456.789-00"
  }' \
  'https://evidenciaapi.acertpix.com.br/api/Analise'

Exemplo CURL com Campos Extras

curl -X POST \
  --header 'Content-Type: application/json' \
  --header 'Accept: text/plain' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6...' \
  --data-raw '{
    "chave": "DOC-2025-002",
    "tipoAnaliseId": 1,
    "documento": "123.456.789-00",
    "camposExtras": {
      "CPF": "12345678910",
      "Endereço": "Av. Paulista, 1578 - Bela Vista, São Paulo"
    }
  }' \
  'https://evidenciaapi.acertpix.com.br/api/Analise'

Status Code 201

Análise criada com sucesso.

Parâmetro	Descrição	Tipo	Exemplos
analiseId	Identificador único da análise	Integer	123
dataCriacao	Data/hora de criação no sistema	String	"2025-01-20T10:05:30Z"
status	Status atual da análise	String	"Aguardando"
mensagem	Resposta do sistema	String	Análise criada com sucesso. Envie os arquivos usando POST /api/Analise/{id}/upload

Exemplo

{
  "analiseId": 123,
  "dataCriacao": "2025-01-20T10:05:30.456Z",
  "status": "Aguardando",
  "mensagem": "Análise criada com sucesso. Envie os arquivos usando POST /api/Analise/{id}/upload"
}

Status Code 400

Erro de validação nos dados da requisição ou tipo de análise inválido.

Parâmetro	Descrição	Tipo	Exemplos
error	Código do erro	String	"invalid_request"
errorDescription	Descrição do erro	String	"Os dados da requisição são inválidos"

Exemplo - Validação de campos

{
  "error": "invalid_request",
  "errorDescription": "Os dados da requisição são inválidos"
}

Exemplo - Tipo de análise inválido

{
  "error": "invalid_analysis_type",
  "errorDescription": "O tipo de análise informado não existe ou não está disponível para esta empresa"
}

Status Code 401

Token inválido ou empresa não identificada.

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 409

Conflito - Chave duplicada.

Parâmetro	Descrição	Tipo	Exemplos
error	Código do erro	String	"duplicate_key"
errorDescription	Descrição do erro	String	"Já existe uma análise com esta chave"

Exemplo

{
  "error": "duplicate_key",
  "errorDescription": "Já existe uma análise com a chave 'DOC-2025-001'"
}

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

Exemplo

{
  "error": "server_error",
  "errorDescription": "Erro interno ao criar análise"
}

Observações

• A análise criada ficará com status "Aguardando" até que arquivos sejam anexados
• A chave deve ser única dentro da empresa para facilitar consultas posteriores (máximo 255 caracteres)
• O campo documento é opcional e pode conter CPF ou CNPJ
• O tipoAnaliseId determina qual modelo LLM e template de análise serão utilizados
• O campo camposExtras permite enviar dados adicionais personalizados em formato chave-valor que serão associados à análise
• Os campos extras podem conter qualquer informação relevante para o contexto da análise (endereços, telefones, dados complementares, etc.)

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 por ID - Verifique o status e resultados
4. Consultar Análise por Chave - Busque usando a chave única