API de Integração ANTVIAS

Bem-vindo à documentação oficial da API ANTVIAS. Nossa API REST permite que você integre consultas processuais, autos, publicações DJEN e inteligência jurídica diretamente nos seus sistemas.

A chave completa aparece uma única vez e cada conta pode manter até 10 chaves ativas. Chaves de membros respeitam as permissões atuais e são revogadas quando o acesso à API é removido.

nunca exponha a chave no navegador ou em aplicativos móveis. Esta documentação gera exemplos para copiar, mas não executa consultas nem armazena suas credenciais.

API e painel compartilham os dados de processos e os resultados das consultas: as consultas criadas pela API também aparecem no painel. Contas associadas a um plano do painel têm cotas mensais e financeiro próprios desse plano; a API mantém suas cotas, créditos e contratos atuais e não consome a cota do plano. Contas não associadas a um plano mantêm as condições atuais. Revogar uma chave não apaga consultas nem consumo.

Operações da API

Consulte os caminhos, métodos e descrições do contrato público da API ANTVIAS.

GET /api/v1/processos: Buscar processos

Busca por número CNJ, nome de parte ou documento (texto livre em q), combinável com filtros avançados (parte, advogado, tribunal, classe)

GET /api/v1/processos/busca-progressiva: Buscar processos progressivamente

Fluxo SSE para uma busca isolada por CPF, CNPJ ou OAB. Envia eventos inicio, descoberta, processo, progresso, concluido e erro conforme os processos são localizados e importados.

POST /api/v1/processos/mesa: Enviar vários processos para a mesa de trabalho

Adiciona, sem duplicar, vários processos à mesa do usuário autenticado

GET /api/v1/processos/mesa: Processos na mesa de trabalho

Lista os processos que o usuário autenticado colocou na mesa de trabalho

POST /api/v1/processos/lotes: Criar consulta em lote

Envia uma lista de CNJs, CPFs, CNPJs ou OABs para consulta em lote. Os identificadores históricos são resolvidos em processos e todos os resultados vão ficando disponíveis de forma assíncrona.

GET /api/v1/processos/lotes: Listar consultas em lote

Lista os lotes de consulta do usuário autenticado

POST /api/v1/processos/consultas-historicas: Criar consulta histórica persistente

GET /api/v1/processos/consultas-historicas: Listar consultas históricas persistentes

POST /api/v1/processos/consultas-historicas/{id}/ocultar: Ocultar uma consulta histórica da listagem

Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

POST /api/v1/processos/consultas-processuais: Criar consulta processual persistente

GET /api/v1/processos/consultas-processuais: Listar consultas processuais persistentes

POST /api/v1/processos/consultas-processuais/{id}/ocultar: Ocultar uma consulta processual da listagem

Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

POST /api/v1/processos/lotes/{id}/ocultar: Ocultar uma consulta em lote da listagem

Remove apenas da lista do titular, preservando consumo, resultados e processamento em andamento. Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

PATCH /api/v1/processos/lotes/{id}: Renomear uma consulta em lote

Define o nome do lote pertencente ao usuário autenticado

GET /api/v1/processos/lotes/{id}: Detalhe de uma consulta em lote

Itens do lote com status individual. Enquanto houver itens na fila, a consulta também reconcilia o andamento junto aos tribunais.

GET /api/v1/processos/numero/{numero}/{grau}: Detalhe do processo por número CNJ e instância

Busca o processo pelo número CNJ (com ou sem pontuação) e pelo slug da instância (ex. 1-grau, 2-grau, 3-grau, 4-grau). Necessário porque o mesmo número pode existir em instâncias diferentes.

GET /api/v1/processos/{id}: Detalhe do processo

POST /api/v1/processos/{id}/autos/baixar: Adquirir e baixar os autos do processo

Registra o aceite e a cobrança única dos autos (anexos) do processo. A cobrança ocorre uma vez por CNJ, independentemente da quantidade de anexos. Retorna a lista de documentos disponíveis para download. Repetir a chamada para o mesmo processo não cobra de novo (idempotente).

GET /api/v1/processos/{id}/documentos/{docId}/download: Download do documento

Faz o proxy do arquivo do documento obtido junto ao tribunal (stream com Content-Length para permitir barra de progresso). Exige que os autos do processo já tenham sido adquiridos (POST /processos/{id}/autos/baixar). Disponível apenas para documentos com downloadDisponivel=true.

GET /api/v1/processos/{id}/autos/zip: Download de todos os autos em .zip

Monta em streaming um único arquivo .zip com todos os documentos do processo que têm downloadDisponivel=true, obtidos um a um junto ao tribunal (sem Content-Length: o tamanho só é conhecido ao final). Exige que os autos já tenham sido adquiridos (POST /processos/{id}/autos/baixar); não gera nova cobrança. Os arquivos vêm numerados na ordem de juntada; os que o tribunal não disponibilizar no momento são listados num "LEIA-ME" dentro do .zip, e podem ser baixados individualmente depois. Se nenhum arquivo puder ser obtido, responde 502.

GET /api/v1/processos/{id}/partes/{parteId}/entidade: Dados cadastrais de uma parte do processo

Consulta os dados cadastrais (master-data) da parte junto à fonte externa, pelo documento (CPF/CNPJ) registrado no processo. Disponível apenas para partes com documento informado.

POST /api/v1/processos/{id}/partes/{parteId}/entidade/atualizar: Atualiza os dados cadastrais de uma parte em tempo real

Dispara uma atualização em tempo real dos dados cadastrais da parte junto às fontes oficiais (crawl sob demanda na fonte externa) e retorna os dados atualizados. Mais lento que a consulta normal. Não gera nova cobrança para processos já consultados. Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

POST /api/v1/processos/{id}/atualizar: Atualizar processo em tempo real

Dispara a busca em tempo real junto ao tribunal (crawl sob demanda) e reimporta os dados do processo. Mais lento que a consulta normal, mas garante a informação mais recente. Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

POST /api/v1/processos/{id}/comunicacoes/atualizar: Atualizar comunicações do DJEN em tempo real

Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

GET /api/v1/processos/{id}/intel: Obter a análise Intel do processo

Estado atual da análise inteligente do caso (fase atual, próximos passos e pesquisa na web). A análise pertence ao número CNJ, portanto é compartilhada por todas as instâncias do mesmo processo.

POST /api/v1/processos/{id}/intel: Gerar (ou regerar) a análise Intel do processo

Inicia a análise em segundo plano e responde imediatamente com o estado `processando`. Se já houver uma geração em andamento para o mesmo CNJ, ela é reaproveitada em vez de iniciar outra. Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

GET /api/v1/processos/{id}/intel/chat: Obter a conversa com o agente jurídico

Histórico da conversa do usuário autenticado com o agente jurídico sobre este processo (todas as instâncias do mesmo CNJ), em ordem cronológica.

POST /api/v1/processos/{id}/intel/chat: Enviar uma pergunta ao agente jurídico

Fluxo SSE com a resposta do agente: eventos `inicio`, `status` (analisando/pesquisando), `delta` (trechos do texto), `concluido` (pergunta e resposta gravadas) e `erro`.

DELETE /api/v1/processos/{id}/intel/chat: Apagar a conversa com o agente jurídico

POST /api/v1/processos/{id}/monitorar: Migrar uma marcação antiga de monitoramento

Compatibilidade com a operação antiga: não cria marcações nem monitores pagos. Responde 409 com code MONITORAMENTO_CONFIGURACAO_NECESSARIA. Cadastre um destino e use POST /monitoramento/monitores com confirmação de custo. As marcações antigas permanecem pendentes, sem avisos automáticos.

DELETE /api/v1/processos/{id}/monitorar: Remover uma marcação antiga de monitoramento

Remove somente a marcação legada do processo nesta conta, de forma idempotente. Não exclui monitores de webhook e não cancela inscrições do sino no painel. Para cancelar acompanhamento recorrente use DELETE /monitoramento/monitores/{id}.

POST /api/v1/processos/{id}/mesa: Enviar processo para a mesa de trabalho

Adiciona o processo à mesa de trabalho do usuário autenticado Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

DELETE /api/v1/processos/{id}/mesa: Remover processo da mesa de trabalho

Remove o processo da mesa de trabalho do usuário autenticado

GET /api/v1/monitoramento/config: Consultar disponibilidade e limites de monitoramento

O limite de monitores é uma trava de segurança para monitores criados pela API, definida pela ANTVIAS; zero bloqueia novas ativações via API. Acompanhamentos ativados no painel web são cobrados por uso e não entram nesse limite.

POST /api/v1/monitoramento/cotacoes: Cotar monitoramento mensal

Apenas calcula o preço da proposta assinada da conta. Não consulta fontes, não cria monitor e não inicia trabalho remoto.

GET /api/v1/monitoramento/destinos: Listar destinos de webhook

POST /api/v1/monitoramento/destinos: Criar destino de webhook

Aceita somente URLs HTTPS públicas. O segredo é exibido somente nesta resposta.

PATCH /api/v1/monitoramento/destinos/{id}: Atualizar destino de webhook

Desativar interrompe envios; entregas pendentes retomam no mesmo destino quando reativado.

DELETE /api/v1/monitoramento/destinos/{id}: Excluir destino de webhook

POST /api/v1/monitoramento/destinos/{id}/rotacionar-segredo: Rotacionar segredo do destino

O novo segredo é exibido somente nesta resposta. Entregas pendentes para a URL atual passam a usá-lo na próxima tentativa; uma entrega já em andamento pode concluir com o segredo anterior, portanto mantenha uma breve sobreposição. Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

POST /api/v1/monitoramento/destinos/{id}/testar: Enfileirar teste do destino

Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

GET /api/v1/monitoramento/monitores: Listar monitores

POST /api/v1/monitoramento/monitores: Criar monitor diário

Cria monitor nativo de CNJ ou CPF. No CPF, a primeira varredura é uma linha de base, não um novo aviso. Somente os CNJs explicitamente selecionados em cnjsVinculados são acompanhados separadamente, e cada um consome uma vaga.

GET /api/v1/monitoramento/monitores/{id}: Consultar monitor

PATCH /api/v1/monitoramento/monitores/{id}: Atualizar, pausar ou retomar monitor

Retomar com status ativo exige confirmarCusto igual a true.

DELETE /api/v1/monitoramento/monitores/{id}: Solicitar exclusão do monitor

A vaga permanece em uso até a exclusão remota ser confirmada.

GET /api/v1/monitoramento/eventos: Listar eventos persistidos

GET /api/v1/monitoramento/entregas: Listar entregas de webhook

POST /api/v1/monitoramento/entregas/{id}/reenviar: Reenviar entrega com o mesmo evento

Enfileira nova tentativa preservando o identificador estável do evento. Envie um objeto JSON vazio (`{}`) quando não houver parâmetros no corpo.

GET /api/v1/consumo: Consumo do usuário autenticado

Eventos faturáveis do próprio usuário (consultas processuais e downloads de autos) no período informado; por padrão, o mês corrente. consumoApi sempre representa o mês civil corrente em America/Sao_Paulo, independentemente do filtro histórico informado.

GET /api/v1/consumo/acessos: Acessos de consumo da conta

Lista os acessos e eventos de consumo da conta no período informado