Chatflows

List all chatflows

get

Retrieve a list of all chatflows

Authorizations
Responses
200
Successful operation
application/json
get
GET /chatflows HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
[
  {
    "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"
  }
]

Create a new chatflow

post

Create a new chatflow with the provided details

Authorizations
Body
idstringOptionalExample: d290f1ee-6c54-4b01-90e6-d701748f0851
namestringOptionalExample: MyChatFlow
flowDatastringOptionalExample: {}
deployedbooleanOptional
isPublicbooleanOptional
apikeyidstringOptional
chatbotConfigstringOptionalExample: {}
apiConfigstringOptionalExample: {}
analyticstringOptionalExample: {}
speechToTextstringOptionalExample: {}
categorystringOptionalExample: category1;category2
typestring · enumOptionalPossible values:
createdDatestring · date-timeOptionalExample: 2024-08-24T14:15:22Z
updatedDatestring · date-timeOptionalExample: 2024-08-24T14:15:22Z
Responses
200
Chatflow created successfully
application/json
post
POST /chatflows HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 330

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

Get chatflow by ID

get

Retrieve a specific chatflow by ID

Authorizations
Path parameters
idstringRequired

Chatflow ID

Responses
200
Successful operation
application/json
get
GET /chatflows/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "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"
}

Update chatflow details

put

Update the details of an existing chatflow

Authorizations
Path parameters
idstringRequired

Chatflow ID

Body
idstringOptionalExample: d290f1ee-6c54-4b01-90e6-d701748f0851
namestringOptionalExample: MyChatFlow
flowDatastringOptionalExample: {}
deployedbooleanOptional
isPublicbooleanOptional
apikeyidstringOptional
chatbotConfigstringOptionalExample: {}
apiConfigstringOptionalExample: {}
analyticstringOptionalExample: {}
speechToTextstringOptionalExample: {}
categorystringOptionalExample: category1;category2
typestring · enumOptionalPossible values:
createdDatestring · date-timeOptionalExample: 2024-08-24T14:15:22Z
updatedDatestring · date-timeOptionalExample: 2024-08-24T14:15:22Z
Responses
200
Chatflow updated successfully
application/json
put
PUT /chatflows/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 330

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

Delete a chatflow

delete

Delete a chatflow by ID

Authorizations
Path parameters
idstringRequired

Chatflow ID

Responses
200
Chatflow deleted successfully
delete
DELETE /chatflows/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

No content

Get chatflow by API key

get

Retrieve a chatflow using an API key

Authorizations
Path parameters
apikeystringRequired

API key associated with the chatflow

Responses
200
Successful operation
application/json
get
GET /chatflows/apikey/{apikey} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "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"
}

Last updated