Chatflows

List all chatflows

Retrieve a list of all chatflows

get

/chatflows

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/chatflows' \
  --header 'Authorization: Bearer JWT'

200

500

200

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

Successful operation

Create a new chatflow

Create a new chatflow with the provided details

post

/chatflows

Authorizations

Body

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

createdDatestring · date-time

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

updatedDatestring · date-time

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

typestring · enum

Options: CHATFLOW, MULTIAGENT

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/chatflows' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"id":"d290f1ee-6c54-4b01-90e6-d701748f0851","name":"MyChatFlow","flowData":"{}","chatbotConfig":"{}","apiConfig":"{}","analytic":"{}","speechToText":"{}","category":"category1;category2","createdDate":"2024-08-24T14:15:22Z","updatedDate":"2024-08-24T14:15:22Z","type":"CHATFLOW"}'

200

400

422

200

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

Chatflow created successfully

Get chatflow by ID

Retrieve a specific chatflow by ID

get

/chatflows/{id}

Authorizations

Path parameters

idstringrequired

Chatflow ID

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/chatflows/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

200

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

Successful operation

Update chatflow details

Update the details of an existing chatflow

put

/chatflows/{id}

Authorizations

Path parameters

idstringrequired

Chatflow ID

Body

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

createdDatestring · date-time

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

updatedDatestring · date-time

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

typestring · enum

Options: CHATFLOW, MULTIAGENT

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/chatflows/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"id":"d290f1ee-6c54-4b01-90e6-d701748f0851","name":"MyChatFlow","flowData":"{}","chatbotConfig":"{}","apiConfig":"{}","analytic":"{}","speechToText":"{}","category":"category1;category2","createdDate":"2024-08-24T14:15:22Z","updatedDate":"2024-08-24T14:15:22Z","type":"CHATFLOW"}'

200

400

404

500

200

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

Chatflow updated successfully

Delete a chatflow

Delete a chatflow by ID

delete

/chatflows/{id}

Authorizations

Path parameters

idstringrequired

Chatflow ID

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/chatflows/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

200

No body

Chatflow deleted successfully

Get chatflow by API key

Retrieve a chatflow using an API key

get

/chatflows/apikey/{apikey}

Authorizations

Path parameters

apikeystringrequired

API key associated with the chatflow

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/chatflows/apikey/{apikey}' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

200

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

Successful operation