Skip to main content

O que são Seções?

Quando você cria um relatório através da API, ele é dividido em seções (sections). Cada seção representa uma parte específica do relatório, como “Resumo Executivo”, “Análise Financeira”, ou “Conclusão”. As seções são geradas de forma assíncrona - você receberá o relatório imediatamente, mas o conteúdo das seções será processado em segundo plano pela nossa IA.

Estrutura de uma Seção

Cada seção contém as seguintes informações:

Status das Seções

Uma seção pode ter os seguintes status:

Exemplo Prático

Neste exemplo:
  • ✅ Primeira seção está pronta e você pode usar o conteúdo
  • ⏳ Segunda seção está sendo processada
  • ⏸️ Terceira seção está na fila aguardando

Como Usar as Seções

1. Criar um Relatório

Resposta:

2. Verificar o Progresso

Para ver se as seções foram processadas, faça uma nova requisição GET:
Resposta:

3. Reprocessar Seções

Se precisar gerar novamente o conteúdo de um relatório:
Isso iniciará um novo processamento de todas as seções.

Monitoramento em Tempo Real

Polling (Recomendado)

Faça requisições periódicas para verificar o status:

Webhooks (Futuro)

Em breve, você poderá configurar webhooks para receber notificações quando as seções forem concluídas.

Boas Práticas

✅ Faça

  • Verifique o status antes de usar o conteúdo
  • Implemente retry para seções com erro
  • Use polling com intervalos adequados (5-10 segundos)
  • Processe seções individualmente conforme ficam prontas

❌ Evite

  • Não assuma que o conteúdo está pronto imediatamente
  • Não faça polling muito frequente (< 3 segundos)
  • Não ignore o campo status
  • Não processe seções com content: null

Tempos Estimados

Os tempos podem variar dependendo da complexidade da análise e da carga do sistema.

Exemplos de Código

Python

JavaScript/TypeScript

Tratamento de Erros

Perguntas Frequentes

Por que as seções não estão prontas imediatamente?

As seções são geradas por IA que precisa analisar múltiplas fontes de dados, realizar pesquisas e processar informações. Isso leva alguns segundos a minutos dependendo da complexidade.

Posso processar apenas algumas seções?

Atualmente, todas as seções são processadas juntas. Em breve, será possível processar seções individualmente.

O que acontece se houver erro em uma seção?

A seção ficará com status: "error". As outras seções continuarão o processamento normalmente. Você pode tentar reprocessar o relatório completo usando o endpoint /run.

Quanto tempo os relatórios ficam disponíveis?

Os relatórios e suas seções ficam disponíveis indefinidamente na sua conta.