API

O nó API permite que você se comunique com serviços externos a partir do seu fluxo de conversa. Você pode consultar dados, enviar informações, autenticar contra APIs e processar respostas — tudo sem escrever código. Pense neste nó como um mensageiro: você diz a ele para onde ir (URL), o que carregar (body) e o que trazer de volta (resposta).

URL e método HTTP

Na parte superior do painel você configura os dois campos essenciais: Método HTTP — define que tipo de operação você vai realizar:

Método	Finalidade	Exemplo
GET	Recuperar dados	Consultar o saldo de um cliente
POST	Criar um recurso	Registrar um novo pedido
PUT	Substituir um recurso completo	Atualizar todos os dados de um perfil
PATCH	Atualização parcial	Alterar apenas o e-mail de um usuário
DELETE	Excluir um recurso	Cancelar uma assinatura

URL — o endereço do serviço. Você pode injetar variáveis diretamente:

https://api.example.com/users/{{$user.id}}/orders/{{$memory.orderId}}

Se você colar uma URL que já contém parâmetros (como ?key=value), o nó os extrai automaticamente e os move para a aba Parâmetros.

Importar a partir de cURL

Se você tiver um comando cURL pronto (por exemplo, da documentação de uma API), pode colá-lo diretamente no campo URL. O nó interpreta automaticamente o método, cabeçalhos, body e autenticação do comando.

Abas de configuração

O painel tem 6 abas para configurar todos os aspectos da requisição:

Parâmetros

Adicione parâmetros de query string como pares chave-valor. Cada parâmetro tem uma caixa de seleção para ativar ou desativar sem excluí-lo.

user: {{$user.id}}
date: {{$context.date}}

Os parâmetros são automaticamente adicionados à URL no formato ?param1=value1&param2=value2.

Autenticação

Dois métodos de autenticação disponíveis:

Método	Configuração
Basic Auth	Nome de usuário e senha. Codificados automaticamente em base64
Bearer Token	Token de acesso enviado no cabeçalho `Authorization: Bearer <token>`

Ambos os métodos suportam variáveis nos seus campos, permitindo o uso de credenciais armazenadas dinamicamente.

As credenciais são mantidas no contexto durante a execução do fluxo. Você pode editá-las a partir do modal de credenciais se já estiverem armazenadas.

Cabeçalhos

Adicione cabeçalhos HTTP personalizados como pares chave-valor. Cada cabeçalho tem uma caixa de seleção para ativar ou desativar.

Content-Type: application/json
X-API-Key: {{$memory.apiKey}}

O cabeçalho Content-Type é atualizado automaticamente quando você altera o tipo de body.

Body

Para métodos que enviam dados (POST, PUT, PATCH), configure o body da requisição em diferentes formatos:

Formato	Uso típico
JSON	O mais comum para APIs REST. Editor com validação em tempo real
XML	APIs SOAP ou serviços legados
Texto simples	Dados não estruturados
Multipart Form	Envio de arquivos junto com dados de texto
Form URL Encoded	Formulários web tradicionais

O editor JSON valida a estrutura em tempo real e suporta variáveis dentro do conteúdo:

{
  "user_id": "{{$user.id}}",
  "email": "{{$memory.email}}",
  "name": "{{$user.names}}"
}

Configurações

Configurações avançadas para controlar o comportamento da requisição:

Timeout

Tempo máximo que o nó aguarda a resposta do serviço, em milissegundos. Se a resposta não chegar dentro desse tempo, a requisição é interrompida e o fluxo continua pela saída de erro.

Limite por plano

Nas empresas self-service o timeout não pode ultrapassar o máximo que o plano concede:

Plano	Tempo máximo por requisição
Free	10 segundos
Builder	20 segundos
Growth	30 segundos

Ao criar um nó API, o timeout inicial é o máximo do seu plano. Se você digitar um valor maior, o campo mostra o limite vigente e oferece a mudança de plano.

Um nó que já tinha um valor acima do limite continua funcionando: a requisição é executada com o máximo do plano.

O que diz o log da execução

Quando a requisição é interrompida por tempo, o log indica a causa em error.cause e o detalhe em error.timeout:

Causa	Quando aparece
`PLAN_TIMEOUT_EXCEEDED`	A interrupção veio do limite do plano
`REQUEST_TIMEOUT`	O timeout configurado no nó se esgotou
`UPSTREAM_TIMEOUT`	O serviço que você chama respondeu com um timeout próprio

{
  "error": {
    "message": "timeout of 10000ms exceeded",
    "phase": "request",
    "cause": "PLAN_TIMEOUT_EXCEEDED",
    "timeout": {
      "appliedMs": 10000,
      "configuredMs": 30000,
      "limitMs": 10000,
      "planTier": "FREE",
      "source": "plan"
    }
  }
}

Campo	Descrição
`appliedMs`	Tempo realmente aplicado à requisição
`configuredMs`	Valor configurado no nó
`limitMs`	Máximo que o plano concede
`planTier`	Plano da empresa
`source`	`plan` se o limite veio do plano, `node` se foi aplicado o valor do nó

Quando o limite não se aplica

Empresas Enterprise: o limite é exclusivo dos planos self-service.
Nó Bases de dados: consulta o banco de dados da Jelou, não um serviço externo.
Nós com certificado mTLS: mantêm o próprio timeout.

Certificado SSL

Ativa a verificação SSL/TLS para conexões seguras.

Certificados mTLS

Autenticação TLS mútua com o servidor. Esta opção só aparece se a sua empresa tiver pelo menos um certificado configurado.

Quando mTLS está ativado, o certificado SSL é automaticamente desativado (são mutuamente exclusivos)
Se existir um certificado primário, ele é automaticamente selecionado
Você pode escolher qualquer certificado da lista disponível
Inclui um campo de timeout configurável entre 1000ms (1s) e 120000ms (2min) (padrão 30000ms)

Ver gerenciamento de certificados mTLS

Tentativas

Configure tentativas automáticas quando uma requisição falhar:

Opção	Descrição
Condição de tentativa	Apenas erros de rede (padrão) ou sempre tentar novamente
Número de tentativas	Número de tentativas adicionais
Tipo de espera	Sem espera, exponencial ou personalizado (em milissegundos)
Redefinir timeout	Redefine o tempo de espera em cada tentativa

Avançado

Reter a conversa enquanto aguarda

Por padrão, enquanto o nó aguarda a resposta do serviço, o usuário fica livre: se ele escrever, a mensagem é atendida pelo roteador do projeto e pode iniciar outro fluxo na mesma conversa. Para evitar isso, abra a aba Avançado e habilite Reter a conversa enquanto aguarda: o usuário permanece neste workflow até a requisição terminar.

Campo	Descrição
Reter a conversa enquanto aguarda	Mantém o usuário nesta execução enquanto a requisição é executada. Desabilitado por padrão, então os nós que você já tem se comportam como antes.
Mensagem de espera	Texto que o usuário recebe cada vez que escreve enquanto a requisição está em andamento, com até 500 caracteres. Aceita variáveis. Se você deixar vazio, a conversa é retida do mesmo jeito e as mensagens dele simplesmente não recebem resposta.

As mensagens que o usuário envia enquanto a conversa está retida não entram no fluxo: são sempre descartadas, então os nós seguintes —incluindo um Agente IA— não verão o que ele escreveu.

Quanto tempo dura

A conversa é liberada assim que a requisição termina, tanto pela saída de sucesso quanto pela de erro, e o fluxo continua. Como garantia, a retenção dura no máximo o timeout configurado em Configurações; se você não configurou um, dura 60 segundos. Nunca ultrapassa 1 hora.

O limite é calculado com o timeout de uma única tentativa. Se você habilitou Tentativas, a requisição pode demorar mais que esse limite: ao atingi-lo, o usuário volta a conversar com o roteador mesmo que o nó continue tentando.

Quando não se aplica

Nós dentro de uma Tool: só o workflow que conversa com o usuário pode retê-lo, então a opção é ignorada em um nó API executado dentro de uma Tool. Nesse caso, habilite-a no nó Tool do workflow; consulte Sua primeira Ferramenta.
Conversas com um operador: se um agente humano assumir a conversa, as mensagens dele não passam pela retenção.
Usuário já retido: se outro nó —por exemplo, uma Pausa ou uma Tool com a mesma opção— já estiver retendo o usuário, essa retenção é mantida e este nó não a substitui.

Salvando a resposta

Ative o toggle “Salvar resposta” na parte superior e defina um nome de variável. A resposta completa da API será armazenada nessa variável.

Acessando a resposta sem manipulação

Use a variável diretamente em outros nós:

{{$context.apiResponse}}

Manipulando a resposta em um nó de Código

Se você precisar extrair dados específicos do JSON:

let apiResponse = $context.getHttpResponse('apiResponse')
apiResponse = apiResponse.json()

let name = apiResponse.data.user.name
$memory.set('name', name)

A chave que você usa em $context.getHttpResponse('apiResponse') deve corresponder exatamente à que você especificou no campo “Salvar resposta”.

Resposta de teste

Após executar um teste a partir do painel, a resposta é exibida em uma seção expansível com:

Código de status (por exemplo, 200 OK)
Aba Body — Resposta formatada como JSON com botão de cópia
Aba Headers — Cabeçalhos de resposta do servidor

Alertas

Você pode receber um e-mail quando este nó falhar 100 vezes em 5 minutos contra o mesmo endpoint. Consulte Alertas de nós.

Primeiros Passos

Desenvolvedor

Jelou CLI

Mensagens Outbound

Caixa de entrada

Marketplace

Canais

Configuração

Faturamento

URL e método HTTP

Importar a partir de cURL

Abas de configuração

Parâmetros

Autenticação

Cabeçalhos

Body

Configurações

Timeout

Limite por plano

O que diz o log da execução

Quando o limite não se aplica

Certificado SSL

Certificados mTLS

Tentativas

Avançado

Reter a conversa enquanto aguarda

Quanto tempo dura

Quando não se aplica

Salvando a resposta

Acessando a resposta sem manipulação

Manipulando a resposta em um nó de Código

Resposta de teste

Alertas

​URL e método HTTP

​Importar a partir de cURL

​Abas de configuração

​Parâmetros

​Autenticação

​Cabeçalhos

​Body

​Configurações

​Timeout

Limite por plano

O que diz o log da execução

Quando o limite não se aplica

​Certificado SSL

​Certificados mTLS

​Tentativas

​Avançado

​Reter a conversa enquanto aguarda

Quanto tempo dura

Quando não se aplica

​Salvando a resposta

​Acessando a resposta sem manipulação

​Manipulando a resposta em um nó de Código

​Resposta de teste

​Alertas

URL e método HTTP

Importar a partir de cURL

Abas de configuração

Parâmetros

Autenticação

Cabeçalhos

Body

Configurações

Timeout

Certificado SSL

Certificados mTLS

Tentativas

Avançado

Reter a conversa enquanto aguarda

Salvando a resposta

Acessando a resposta sem manipulação

Manipulando a resposta em um nó de Código

Resposta de teste

Alertas