Chatflows

List all chatflows

Retrieve a list of all chatflows

GET/chatflows

Authorization

bearerAuth

Response

200500

Successful operation

Body

application/json

idstring

Example: "d290f1ee-6c54-4b01-90e6-d701748f0851"

namestring

Example: "MyChatFlow"

flowDatastring

Example: "{}"

deployedboolean

isPublicboolean

apikeyidstring

chatbotConfigstring

Example: "{}"

apiConfigstring

Example: "{}"

analyticstring

Example: "{}"

speechToTextstring

Example: "{}"

categorystring

Example: "category1;category2"

typeenum

CHATFLOWMULTIAGENT

createdDatestring (date-time)

Example: "2024-08-24T14:15:22Z"

updatedDatestring (date-time)

Example: "2024-08-24T14:15:22Z"

Request

JavaScriptCurlPython

const response = await fetch('/chatflows', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "name": "MyChatFlow",
    "flowData": "{}",
    "deployed": false,
    "isPublic": false,
    "apikeyid": "text",
    "chatbotConfig": "{}",
    "apiConfig": "{}",
    "analytic": "{}",
    "speechToText": "{}",
    "category": "category1;category2",
    "type": "CHATFLOW",
    "createdDate": "2024-08-24T14:15:22Z",
    "updatedDate": "2024-08-24T14:15:22Z"
  }
]

Create a new chatflow

Create a new chatflow with the provided details

POST/chatflows

Authorization

bearerAuth

Body

application/json

idstring

Example: "d290f1ee-6c54-4b01-90e6-d701748f0851"

namestring

Example: "MyChatFlow"

flowDatastring

Example: "{}"

deployedboolean

isPublicboolean

apikeyidstring

chatbotConfigstring

Example: "{}"

apiConfigstring

Example: "{}"

analyticstring

Example: "{}"

speechToTextstring

Example: "{}"

categorystring

Example: "category1;category2"

typeenum

CHATFLOWMULTIAGENT

createdDatestring (date-time)

Example: "2024-08-24T14:15:22Z"

updatedDatestring (date-time)

Example: "2024-08-24T14:15:22Z"

Response

200400422

Chatflow created successfully

Body

application/json

idstring

Example: "d290f1ee-6c54-4b01-90e6-d701748f0851"

namestring

Example: "MyChatFlow"

flowDatastring

Example: "{}"

deployedboolean

isPublicboolean

apikeyidstring

chatbotConfigstring

Example: "{}"

apiConfigstring

Example: "{}"

analyticstring

Example: "{}"

speechToTextstring

Example: "{}"

categorystring

Example: "category1;category2"

typeenum

CHATFLOWMULTIAGENT

createdDatestring (date-time)

Example: "2024-08-24T14:15:22Z"

updatedDatestring (date-time)

Example: "2024-08-24T14:15:22Z"

Request

JavaScriptCurlPython

const response = await fetch('/chatflows', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "name": "MyChatFlow",
  "flowData": "{}",
  "deployed": false,
  "isPublic": false,
  "apikeyid": "text",
  "chatbotConfig": "{}",
  "apiConfig": "{}",
  "analytic": "{}",
  "speechToText": "{}",
  "category": "category1;category2",
  "type": "CHATFLOW",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}

Get chatflow by ID

Retrieve a specific chatflow by ID

GET/chatflows/{id}

Authorization

bearerAuth

Path parameters

id*string

Chatflow ID

Response

200400404500

Successful operation

Body

application/json

idstring

Example: "d290f1ee-6c54-4b01-90e6-d701748f0851"

namestring

Example: "MyChatFlow"

flowDatastring

Example: "{}"

deployedboolean

isPublicboolean

apikeyidstring

chatbotConfigstring

Example: "{}"

apiConfigstring

Example: "{}"

analyticstring

Example: "{}"

speechToTextstring

Example: "{}"

categorystring

Example: "category1;category2"

typeenum

CHATFLOWMULTIAGENT

createdDatestring (date-time)

Example: "2024-08-24T14:15:22Z"

updatedDatestring (date-time)

Example: "2024-08-24T14:15:22Z"

Request

JavaScriptCurlPython

const response = await fetch('/chatflows/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "name": "MyChatFlow",
  "flowData": "{}",
  "deployed": false,
  "isPublic": false,
  "apikeyid": "text",
  "chatbotConfig": "{}",
  "apiConfig": "{}",
  "analytic": "{}",
  "speechToText": "{}",
  "category": "category1;category2",
  "type": "CHATFLOW",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}

Update chatflow details

Update the details of an existing chatflow

PUT/chatflows/{id}

Authorization

bearerAuth

Path parameters

id*string

Chatflow ID

Body

application/json

idstring

Example: "d290f1ee-6c54-4b01-90e6-d701748f0851"

namestring

Example: "MyChatFlow"

flowDatastring

Example: "{}"

deployedboolean

isPublicboolean

apikeyidstring

chatbotConfigstring

Example: "{}"

apiConfigstring

Example: "{}"

analyticstring

Example: "{}"

speechToTextstring

Example: "{}"

categorystring

Example: "category1;category2"

typeenum

CHATFLOWMULTIAGENT

createdDatestring (date-time)

Example: "2024-08-24T14:15:22Z"

updatedDatestring (date-time)

Example: "2024-08-24T14:15:22Z"

Response

200400404500

Chatflow updated successfully

Body

application/json

idstring

Example: "d290f1ee-6c54-4b01-90e6-d701748f0851"

namestring

Example: "MyChatFlow"

flowDatastring

Example: "{}"

deployedboolean

isPublicboolean

apikeyidstring

chatbotConfigstring

Example: "{}"

apiConfigstring

Example: "{}"

analyticstring

Example: "{}"

speechToTextstring

Example: "{}"

categorystring

Example: "category1;category2"

typeenum

CHATFLOWMULTIAGENT

createdDatestring (date-time)

Example: "2024-08-24T14:15:22Z"

updatedDatestring (date-time)

Example: "2024-08-24T14:15:22Z"

Request

JavaScriptCurlPython

const response = await fetch('/chatflows/{id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "name": "MyChatFlow",
  "flowData": "{}",
  "deployed": false,
  "isPublic": false,
  "apikeyid": "text",
  "chatbotConfig": "{}",
  "apiConfig": "{}",
  "analytic": "{}",
  "speechToText": "{}",
  "category": "category1;category2",
  "type": "CHATFLOW",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}

Delete a chatflow

Delete a chatflow by ID

DELETE/chatflows/{id}

Authorization

bearerAuth

Path parameters

id*string

Chatflow ID

Response

200400404500

Chatflow deleted successfully

Request

JavaScriptCurlPython

const response = await fetch('/chatflows/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Get chatflow by API key

Retrieve a chatflow using an API key

GET/chatflows/apikey/{apikey}

Authorization

bearerAuth

Path parameters

apikey*string

API key associated with the chatflow

Response

200400404500

Successful operation

Body

application/json

idstring

Example: "d290f1ee-6c54-4b01-90e6-d701748f0851"

namestring

Example: "MyChatFlow"

flowDatastring

Example: "{}"

deployedboolean

isPublicboolean

apikeyidstring

chatbotConfigstring

Example: "{}"

apiConfigstring

Example: "{}"

analyticstring

Example: "{}"

speechToTextstring

Example: "{}"

categorystring

Example: "category1;category2"

typeenum

CHATFLOWMULTIAGENT

createdDatestring (date-time)

Example: "2024-08-24T14:15:22Z"

updatedDatestring (date-time)

Example: "2024-08-24T14:15:22Z"

Request

JavaScriptCurlPython

const response = await fetch('/chatflows/apikey/{apikey}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "name": "MyChatFlow",
  "flowData": "{}",
  "deployed": false,
  "isPublic": false,
  "apikeyid": "text",
  "chatbotConfig": "{}",
  "apiConfig": "{}",
  "analytic": "{}",
  "speechToText": "{}",
  "category": "category1;category2",
  "type": "CHATFLOW",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}