Pular para o conteúdo principal
Skills são fluxos conversacionais que definem o comportamento do bot. Você pode consultar as skills disponíveis no seu bot e redirecionar usuários para uma skill específica.

Obter Skills

Consulte todas as skills 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 da skill. Este ID deve ser usado para configurar redirecionamentos.
namestringNome da skill.
descriptionstringDescrição da skill.
typestringTipo da skill.
statebooleanEstado da skill. Somente skills com estado true podem ser usadas.
defaultbooleanIndica se a skill está selecionada como padrão para o bot.
createdAtdateData de criação da skill.
updatedAtdateData da última atualização da skill.

Configurar Skill do Usuário

Redirecione um usuário para uma skill específica 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 da skill 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 na skill.

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"
}