Chatflows

PreviousChat Message NextDocument Store

Last updated 2 months ago

Get chatflow by ID

get

Retrieve a specific chatflow by ID

Authorizations

Path parameters

idstringrequired

Chatflow ID

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

404

500

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

Successful operation

Delete a chatflow

delete

Delete a chatflow by ID

Authorizations

Path parameters

idstringrequired

Chatflow ID

Responses

cURL

JavaScript

Python

HTTP

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

200

400

404

500

No body

Chatflow deleted successfully

Get chatflow by API key

get

Retrieve a chatflow using an API key

Authorizations

Path parameters

apikeystringrequired

API key associated with the chatflow

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

404

500

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

Successful operation

List all chatflows

get

Retrieve a list of all chatflows

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

500

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

Successful operation

Create a new chatflow

post

Create a new chatflow with the provided details

Authorizations

Body

idstringoptional

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

namestringoptional

Example: MyChatFlow

flowDatastringoptional

Example: {}

deployedbooleanoptional

isPublicbooleanoptional

apikeyidstringoptional

chatbotConfigstringoptional

Example: {}

apiConfigstringoptional

Example: {}

analyticstringoptional

Example: {}

speechToTextstringoptional

Example: {}

categorystringoptional

Example: category1;category2

typestring · enumoptional

Options: CHATFLOW, MULTIAGENT

createdDatestring · date-timeoptional

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

updatedDatestring · date-timeoptional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

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": "{}",
    "deployed": true,
    "isPublic": true,
    "apikeyid": "text",
    "chatbotConfig": "{}",
    "apiConfig": "{}",
    "analytic": "{}",
    "speechToText": "{}",
    "category": "category1;category2",
    "type": "CHATFLOW",
    "createdDate": "2024-08-24T14:15:22Z",
    "updatedDate": "2024-08-24T14:15:22Z"
  }'

200

400

422

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

Chatflow created successfully

Update chatflow details

put

Update the details of an existing chatflow

Authorizations

Path parameters

idstringrequired

Chatflow ID

Body

idstringoptional

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

namestringoptional

Example: MyChatFlow

flowDatastringoptional

Example: {}

deployedbooleanoptional

isPublicbooleanoptional

apikeyidstringoptional

chatbotConfigstringoptional

Example: {}

apiConfigstringoptional

Example: {}

analyticstringoptional

Example: {}

speechToTextstringoptional

Example: {}

categorystringoptional

Example: category1;category2

typestring · enumoptional

Options: CHATFLOW, MULTIAGENT

createdDatestring · date-timeoptional

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

updatedDatestring · date-timeoptional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

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": "{}",
    "deployed": true,
    "isPublic": true,
    "apikeyid": "text",
    "chatbotConfig": "{}",
    "apiConfig": "{}",
    "analytic": "{}",
    "speechToText": "{}",
    "category": "category1;category2",
    "type": "CHATFLOW",
    "createdDate": "2024-08-24T14:15:22Z",
    "updatedDate": "2024-08-24T14:15:22Z"
  }'

200

400

404

500

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

Chatflow updated successfully