Workflows

Workflows are conversational flows that define the channel’s behavior. You can query the workflows available in your channel and redirect users to a specific workflow.

Get Workflows

Query all workflows available in your channel.

GET https://api.jelou.ai/v1/bots/{botId}/skills

Path Parameters

Field	Location	Type	Required	Description
botId	Path	string	Yes	Unique identifier of the channel.

Request Example

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

Responses

200 - Successful response

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

401 - Unauthorized

{
  "message": "Authentication failed"
}

404 - Not Found

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

Response Detail

Property	Type	Description
id	integer	Workflow ID. This ID must be used to configure redirects.
name	string	Workflow name.
description	string	Workflow description.
type	string	Workflow type.
state	boolean	Workflow state. Only workflows with state `true` can be used.
default	boolean	Indicates whether the workflow is selected as the default for the channel.
createdAt	date	Workflow creation date.
updatedAt	date	Date of last update of the workflow.

Configure User Workflow

Redirect a user to a specific workflow within the conversational flow.

POST https://api.jelou.ai/v1/bots/{botId}/users/{userId}/skill/{skillId}

Requirements

The user must have an active session.

Path Parameters

Field	Location	Type	Required	Description
botId	Path	string	Yes	Unique identifier of the channel.
userId	Path	string	Yes	Unique identifier of the user.
skillId	Path	string	Yes	Identifier of the workflow to which the user will be redirected.

Request Body

Field	Location	Type	Required	Description
memoryParams	Body	object	No	Optional parameters that can be injected and used later in the workflow.

Request Example

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

Responses

200 - Successful response

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

400 - Bad Request

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

401 - Unauthorized

{
  "message": "Authentication failed"
}

404 - Not Found

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

API reference

Send Messages

Campaigns

Conversations

Metrics

Users

Resources

Widget

Datum

External Support Panel

Custom Channel

Memory Management

Get Workflows

Path Parameters

Request Example

Responses

Response Detail

Configure User Workflow

Requirements

Path Parameters

Request Body

Request Example

Responses

​Get Workflows

​Path Parameters

​Request Example

​Responses

​Response Detail

​Configure User Workflow

​Requirements

​Path Parameters

​Request Body

​Request Example

​Responses

Get Workflows

Path Parameters

Request Example

Responses

Response Detail

Configure User Workflow

Requirements

Path Parameters

Request Body

Request Example

Responses