Saltar al contenido principal
Los Workflows son pasos conversacionales que definen el comportamiento del bot. Puedes consultar los workflows disponibles en tu bot y redirigir usuarios a un flujo específico.

Obtener Workflows

Consulta todos los workflows disponibles en tu bot.
GET https://api.jelou.ai/v1/bots/{botId}/skills

Parámetros de ruta

CampoUbicaciónTipoRequeridoDescripción
botIdPathstringIdentificador único del bot.

Ejemplo de solicitud

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

Respuestas

{
  "message": ["Skills retrieved successfully!"],
  "statusMessage": "success",
  "status": 1,
  "data": [
    {
      "id": 1,
      "name": "Skill Principal",
      "description": "Skill de bienvenida",
      "type": "BRAIN",
      "createdAt": "2024-10-24T11:18:05.000Z",
      "updatedAt": "2024-10-24T11:18:05.000Z",
      "state": true,
      "default": true
    },
    {
      "id": 2,
      "name": "Skill Ventas",
      "description": "Flujo de ventas",
      "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"
}

Detalle de la respuesta

PropiedadTipoDescripción
idintegerID del flujo. Este ID debe usarse para configurar redirecciones.
namestringNombre del flujo.
descriptionstringDescripción del flujo.
typestringTipo de flujo.
statebooleanEstado del flujo. Solo los workflows con estado true pueden ser utilizadas.
defaultbooleanIndica si el flujo está seleccionada como predeterminada para el bot.
createdAtdateFecha de creación del flujo.
updatedAtdateFecha de última actualización del flujo.

Configurar Flujo de usuario

Redirige a un usuario a un flujo específico dentro del flujo conversacional.
POST https://api.jelou.ai/v1/bots/{botId}/users/{userId}/skill/{skillId}

Requisitos

  • El usuario debe tener una sesión activa.

Parámetros de ruta

CampoUbicaciónTipoRequeridoDescripción
botIdPathstringIdentificador único del bot.
userIdPathstringIdentificador único del usuario.
skillIdPathstringIdentificador del flujo al que será redirigido el usuario.

Cuerpo de la solicitud

CampoUbicaciónTipoRequeridoDescripción
memoryParamsBodyobjectNoParámetros opcionales que se pueden inyectar y utilizar posteriormente en el flujo.

Ejemplo de solicitud

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

Respuestas

{
  "message": "Skill set successfully",
  "status": "success"
}
{
  "message": "Invalid request",
  "status": "failed"
}
{
  "message": "Authentication failed"
}
{
  "message": "User or Skill not found",
  "status": "failed"
}