Pular para o conteúdo principal
Workflows são fluxos conversacionais que definem o comportamento do bot. Você pode consultar os workflows disponíveis no seu bot e redirecionar usuários para um fluxo específico.

​
Obter Workflows

Consulte todas os workflows disponíveis no seu bot. 
GET https://api.jelou.ai/v1/bots/{botId}/skills

​
Parâmetros de Path

CampoLocalizaçãoTipoObrigatórioDescrição
botIdPathstringSimIdentificador único do bot.

​
Exemplo de Requisição

curl --request GET \
  --url 'https://api.jelou.ai/v1/bots/BOT_ID/skills' \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}'

​
Respostas

{
  "message": ["Skills retrieved successfully!"],
  "statusMessage": "success",
  "status": 1,
  "data": [
    {
      "id": 1,
      "name": "Main Skill",
      "description": "Welcome skill",
      "type": "BRAIN",
      "createdAt": "2024-10-24T11:18:05.000Z",
      "updatedAt": "2024-10-24T11:18:05.000Z",
      "state": true,
      "default": true
    },
    {
      "id": 2,
      "name": "Sales Skill",
      "description": "Sales flow",
      "type": "BRAIN",
      "createdAt": "2024-10-24T11:13:32.000Z",
      "updatedAt": "2024-10-24T11:17:44.000Z",
      "state": true,
      "default": false
    }
  ]
}

{
  "message": "Authentication failed"
}

{
  "message": ["Bot not found"],
  "status": "failed"
}

​
Detalhes da Resposta

PropriedadeTipoDescrição
idintegerID do fluxo. Este ID deve ser usado para configurar redirecionamentos.
namestringNome do fluxo.
descriptionstringDescrição do fluxo.
typestringTipo do fluxo.
statebooleanEstado do fluxo. Somente workflows com estado true podem ser usadas.
defaultbooleanIndica se o fluxo está selecionada como padrão para o bot.
createdAtdateData de criação do fluxo.
updatedAtdateData da última atualização do fluxo.

​
Configurar Fluxo do Usuário

Redirecione um usuário para um fluxo específico dentro do fluxo conversacional. 
POST https://api.jelou.ai/v1/bots/{botId}/users/{userId}/skill/{skillId}

​
Requisitos

  • O usuário deve ter uma sessão ativa.

​
Parâmetros de Path

CampoLocalizaçãoTipoObrigatórioDescrição
botIdPathstringSimIdentificador único do bot.
userIdPathstringSimIdentificador único do usuário.
skillIdPathstringSimIdentificador do fluxo para a qual o usuário será redirecionado.

​
Corpo da Requisição

CampoLocalizaçãoTipoObrigatórioDescrição
memoryParamsBodyobjectNãoParâmetros opcionais que podem ser injetados e usados posteriormente no fluxo.

​
Exemplo de Requisição

curl --request POST \
  --url 'https://api.jelou.ai/v1/bots/BOT_ID/users/USER_ID/skill/SKILL_ID' \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "memoryParams": {
      "test": 1
    }
  }'

​
Respostas

{
  "message": "Skill set successfully",
  "status": "success"
}

{
  "message": "Invalid request",
  "status": "failed"
}

{
  "message": "Authentication failed"
}

{
  "message": "User or Skill not found",
  "status": "failed"
}