Pular para o conteúdo principal
Roberty Studio
IDPIDP

Usar templates em automações

Chame um template de IDP pela API pública, por um robô RPA ou por um agente de IA, e veja os limites de cada forma.

Usar templates em automações

Um template de IDP publicado pode ser chamado de três formas: pela API pública, por um robô RPA ou por um agente de IA. As três executam sempre a versão ativa — nunca o rascunho —, registram a execução no ambiente Produção, em Execuções, e contam no consumo de requisições de IDP do workspace.

Sem uma versão ativa, as três falham com o erro NO_ACTIVE_VERSION. Quando a identificação rejeita o documento, a chamada não falha: o resultado informa a rejeição.

Comparação​

API públicaAção de robôAção de agente de IA
Quem chamaQualquer sistema externoUm robô RPA do workspaceUm agente de IA do workspace
AutenticaçãoChave de API do workspace com o escopo Templates IDPNenhuma: o robô usa a identidade do dispositivoNenhuma: o agente roda no workspace
De onde vem o arquivoEnviado pelo sistema numa URL assinadaUm caminho no dispositivo que executa o robôUm anexo da conversa, um arquivo da execução por API ou um arquivo baixado do Google Drive ou do OneDrive
FormatosPDF, PNG, JPG, JPEG, WEBP, TIFF, TIF e BMPPDF, PNG, JPG, JPEG, WEBP, TIFF, TIF e BMPPDF e imagens (PNG, JPG, JPEG, WEBP, TIFF e BMP) de até 15 MB
Páginas e parâmetrosCampos page e paramsOpções avançadas Páginas para processar e ParâmetrosNão enviados
Espera pelo resultadoO sistema consulta o status até o fimTempo de espera: padrão de 10 minutos; 0 aguarda indefinidamenteTempo limite: padrão de 5 minutos, máximo de 14 minutos

O envio de páginas, pela API ou pela ação de robô, só é aceito quando o template permite que a API sobrescreva as páginas. Veja Documento e páginas.

API pública​

Para integrar sistemas que não rodam na Roberty. A chamada tem três passos: solicitar a execução, enviar o documento na URL assinada devolvida, válida por 15 minutos, e consultar o resultado pelo requestId.

Veja API e webhook.

Ação de robô​

A ação Executar template IDP envia um arquivo do dispositivo que executa o robô, aguarda o processamento e devolve o requestId e o resultado completo do template. Use-a quando o documento já está numa pasta local, por exemplo depois de baixado de um portal ou de um e-mail.

  • O robô consulta o andamento a cada 2 segundos até o fim ou até o Tempo de espera.
  • A ação falha com FILE_NOT_FOUND se o arquivo não existir no dispositivo, com TIMEOUT se o tempo de espera acabar, com EXPIRED se a execução expirar, e com a mensagem de erro do template se o processamento falhar.

Veja Executar template IDP.

Ação de agente de IA​

A ação Executar template IDP permite que o agente processe um documento com um template e responda com base no resultado. Cada ação usa um único template, escolhido na configuração: o agente nunca escolhe o template.

  • Arquivos de até 15 MB.
  • Se o tempo limite acabar, o processamento continua no template e pode ser consultado em Execuções.

Veja Executar template IDP.

informação

Chamar templates pela API e pela ação de robô depende do plano do workspace incluir requisições de IDP e webhooks. Se uma chamada for recusada por falta do recurso, entre em contato com o seu gerente de contas.