Bot

Bots are your Virtual Agents.

API SUBPATH: eva-bot

Paginations and Listings

List bots (v2)

get

Returns a paginated list of bots for a given user, environment, and organization. Supports search and sorting.

Path parameters

orgUUIDstringRequired

A valid UUID of the organization

envUUIDstringRequired

A valid UUID of the environment

Query parameters

searchTermstringOptional

Optional search term to filter bots

pageinteger · int32Optional

Page number (1-based index)

Default: 1

linesPerPageinteger · int32Optional

Number of items per page

Default: 7

orderBystringOptional

Field to sort by

Default: createdAt

directionstringOptional

Sort direction: ASC or DESC

Default: DESC

Responses

200

List of bots returned successfully

*/*

400

Bad Request

*/*

401

Forbidden

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

GET /org/{orgUUID}/env/{envUUID}/v2/bots HTTP/1.1
Host: 
Accept: */*

{
  "uuid": "c51f7211-b89c-4841-8958-d2eeae76ed0a",
  "name": "Customer Support Bot",
  "description": "Handles customer service inquiries",
  "companyName": "NTT DATA",
  "locale": "en-US",
  "industry": "Banking",
  "image": {
    "url": "https://cdn.example.com/images/bot123.png",
    "contentType": "image/png",
    "botHasCustomImage": true
  },
  "engine": {
    "nlu": {
      "id": 101,
      "name": "Clever/DialogFlow/Lex/Luis/Watson/OpenAI/Azure OpenAI/eva Azure OpenAI",
      "first": true,
      "metadata": "{\"version\":\"v2\"}",
      "nlutype": "NLUEngineType.CLEVER(value=Clever)"
    },
    "kai": {
      "id": 123,
      "name": "KAI",
      "metadata": "{\"version\":\"1.0\",\"status\":\"active\"}"
    },
    "agentic": {
      "id": 101,
      "name": "OpenAI/Azure OpenAI/eva Azure OpenAI",
      "first": true,
      "metadata": "{\"priority\":\"high\",\"enabled\":true}"
    },
    "isHybrid": true,
    "isAgentic": false,
    "isClever": true,
    "isBotLLM": false
  },
  "channel": {
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "botUuid": "567e8910-e89b-12d3-a456-426614174000",
    "name": "Support Channel",
    "description": "Channel used for customer support",
    "channelType": {
      "id": 1,
      "name": "WhatsApp",
      "image": "https://cdn.example.com/images/whatsapp-icon.png",
      "channelClassification": {
        "id": 1,
        "name": "web"
      }
    },
    "createdAt": "2025-09-09T03:23:10.285Z",
    "updatedAt": "2025-09-09T03:23:10.285Z"
  },
  "analytic": {
    "apiKey": "abc123-analytics-key"
  }
}

Paginates through all Bots in an Environment. Removed Bots are not retrieved, and neither are Bots whose the current used has no access to.

get

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

Query parameters

searchTermstringOptional

Term being searched. This expects one optional String matching the name of a bot, left to right from the beginning of it's name.

pageinteger · int32Optional

Current page, starting at 1.

Default: 1

linesPerPageinteger · int32Optional

Items per page, defaulted to 7.

Default: 7

orderBystringOptional

Criteria to order result, defaulted to createdAt date.

Default: createdAt

directionstringOptional

Order direction(ASC/DESC), defaulted to DESC

Default: DESC

Responses

200

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

GET /org/{orgUUID}/env/{envUUID}/bots HTTP/1.1
Host: 
Accept: */*

{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "paged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "unpaged": true,
    "offset": 1,
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "content": [
    {
      "uuid": "text",
      "name": "text",
      "description": "text",
      "industry": "text",
      "locale": "text",
      "nlpId": 1,
      "nlp": "text",
      "metadata": "text",
      "image": "text",
      "contentType": "text",
      "botHasCustomImage": true,
      "isClever": true,
      "isBotLLM": true,
      "channel": {
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "botUuid": "567e8910-e89b-12d3-a456-426614174000",
        "name": "Support Channel",
        "description": "Channel used for customer support",
        "channelType": {
          "id": 1,
          "name": "WhatsApp",
          "image": "https://cdn.example.com/images/whatsapp-icon.png",
          "channelClassification": {
            "id": 1,
            "name": "web"
          }
        },
        "createdAt": "2025-09-09T03:23:10.285Z",
        "updatedAt": "2025-09-09T03:23:10.285Z"
      },
      "api_key": "text"
    }
  ],
  "number": 1,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

Searches (greedily) for any tag names that exists in a bot, matching the typed term, left-to-right, and returns a list of up to 6 Strings, ordered alphabetically.

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

Query parameters

searchTermstringRequired

Term being searched

limitinteger · int32Optional

How many items will be returned in the list. Defaults to 6.

Default: 6

Responses

200

*/*

Responsestring[]

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

GET /org/{orgUUID}/env/{envUUID}/quicksearch?searchTerm=text HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

Retrieves a list containing simplified information from all Bots within an Environment. Does not retrieve removed Bots.

get

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

Responses

200

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

GET /org/{orgUUID}/env/{envUUID}/bots/simple HTTP/1.1
Host: 
Accept: */*

{
  "data": [
    {
      "uuid": "text",
      "name": "text",
      "locale": "text",
      "image": "text"
    }
  ]
}

CRUD Operation

Create a new bot (v2)

post

Creates a new bot in the specified environment and organization using the provided configuration data.

Path parameters

orgUUIDstringRequired

A valid UUID of the organization

envUUIDstringRequired

A valid UUID of the environment

Body

Data to create a new bot

namestringRequired

The name of the agent

Example: SupportBot

descriptionstringRequired

A brief description of the agent

Example: Handles customer support queries

localestringRequired

The locale of the agent

Example: en-US

industrystringRequired

The industry the agent is associated with

Example: E-commerce

companyNamestringRequired

The name of the company

Example: Acme Corp

imagestringOptional

Optional image URL or base64 string

Example: https://example.com/image.png

Responses

201

Bot created successfully

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden - user does not have permission to create a bot

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity - invalid input data

*/*

500

Internal Server Error

*/*

post

POST /org/{orgUUID}/env/{envUUID}/v2/bots HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 2690

{
  "name": "SupportBot",
  "description": "Handles customer support queries",
  "locale": "en-US",
  "industry": "E-commerce",
  "companyName": "Acme Corp",
  "image": "https://example.com/image.png",
  "engine": {
    "nlu": {
      "name": "Dialogflow",
      "first": true,
      "metadata": "{\"language\":\"en-US\"}",
      "nlutype": "NLUEngineType.CLEVER(value=Clever)"
    },
    "agentic": {
      "name": "GPT_AGENTIC",
      "first": true,
      "metadata": "{\"personaId\":\"12345\"}",
      "persona": {
        "name": "Ava",
        "image": "https://example.com/images/ava.png",
        "backstory": "Ava is a seasoned customer support expert with a calm and reassuring tone.",
        "personality": "Empathetic, patient, and detail-oriented",
        "communicationStyle": "POLITE_AND_PERSUASIVE"
      },
      "agenticType": "AgenticEngineType.OPENAI(value=OpenAI)"
    },
    "llm": true
  },
  "analytic": {
    "apiKey": "abc123-analytics-key"
  },
  "channel": {
    "name": "Voice",
    "description": "Voice channel for customer support",
    "type": 1,
    "ivrConfiguration": {
      "vendor": "text",
      "dnis": "text",
      "secret": "text",
      "fetchData": {
        "timeoutInterval": 45000,
        "audio": {
          "url": "text",
          "delay": 0,
          "minimum": 0,
          "interval": 0
        }
      },
      "transferCall": {
        "uui": "text",
        "destination": "text"
      },
      "defaultErrorHandling": {
        "transferOnError": true,
        "audio": {
          "url": "text",
          "delay": 0,
          "minimum": 0,
          "interval": 0
        },
        "tts": "text",
        "transferCall": {
          "uui": "text",
          "destination": "text"
        }
      },
      "callEstablishmentErrorHandling": {
        "transferOnError": true,
        "audio": {
          "url": "text",
          "delay": 0,
          "minimum": 0,
          "interval": 0
        },
        "tts": "text",
        "transferCall": {
          "uui": "text",
          "destination": "text"
        }
      },
      "settings": {
        "firstConversationRequest": "{\"text\":\"\",\"code\":\"%EVA_WELCOME_MSG\",\"context\":{}}",
        "conversationTimeout": 40000,
        "sendPostCallEvents": true,
        "regionalExpressionsFileUrl": "text",
        "welcomeTimeout": 40000,
        "maxCallDuration": 300000
      },
      "ttsAudioConfiguration": {
        "mask": "text",
        "tts": {
          "voiceProvider": "AZURE_WHISPER",
          "voiceProviderConfig": "{\"azureOpenAIKey\":\"your-azure-openai-key\",\"azureOpenAIEndpoint\":\"your-azure-openai-endpoint\",\"gptDeployment\":\"your-gpt-deployment\",\"whisperDeployment\":\"your-whisper-deployment\",\"languageCode\":\"your-language-code\",\"prompt\":\"your-prompt\"}"
        },
        "flush": false,
        "bargeIn": false,
        "voiceBargeIn": false,
        "bargeInOffset": 1,
        "time": 1
      },
      "dtmfMenu": {
        "interdigitTimeout": 5000,
        "numberOfDigits": 1,
        "timeoutInterval": 15000,
        "terminationTimeout": 2500,
        "terminationCharacter": "#"
      },
      "voiceMenu": {
        "timeoutInterval": 15000,
        "sensitivity": 0.25,
        "confidence": 0.6,
        "maxSpeechTimeout": 20000,
        "incompleteTimeout": 20000,
        "asr": {
          "voiceProvider": "AZURE_WHISPER",
          "voiceProviderConfig": "{\"azureOpenAIKey\":\"your-azure-openai-key\",\"azureOpenAIEndpoint\":\"your-azure-openai-endpoint\",\"gptDeployment\":\"your-gpt-deployment\",\"whisperDeployment\":\"your-whisper-deployment\",\"languageCode\":\"your-language-code\",\"prompt\":\"your-prompt\"}"
        }
      }
    }
  }
}

{
  "uuid": "c51f7211-b89c-4841-8958-d2eeae76ed0a",
  "name": "Customer Support Bot",
  "description": "Handles customer service inquiries",
  "companyName": "NTT DATA",
  "locale": "en-US",
  "industry": "Banking",
  "image": {
    "url": "https://cdn.example.com/images/bot123.png",
    "contentType": "image/png",
    "botHasCustomImage": true
  },
  "engine": {
    "nlu": {
      "id": 101,
      "name": "Clever/DialogFlow/Lex/Luis/Watson/OpenAI/Azure OpenAI/eva Azure OpenAI",
      "first": true,
      "metadata": "{\"version\":\"v2\"}",
      "nlutype": "NLUEngineType.CLEVER(value=Clever)"
    },
    "kai": {
      "id": 123,
      "name": "KAI",
      "metadata": "{\"version\":\"1.0\",\"status\":\"active\"}"
    },
    "agentic": {
      "id": 101,
      "name": "OpenAI/Azure OpenAI/eva Azure OpenAI",
      "first": true,
      "metadata": "{\"priority\":\"high\",\"enabled\":true}"
    },
    "isHybrid": true,
    "isAgentic": false,
    "isClever": true,
    "isBotLLM": false
  },
  "channel": {
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "botUuid": "567e8910-e89b-12d3-a456-426614174000",
    "name": "Support Channel",
    "description": "Channel used for customer support",
    "channelType": {
      "id": 1,
      "name": "WhatsApp",
      "image": "https://cdn.example.com/images/whatsapp-icon.png",
      "channelClassification": {
        "id": 1,
        "name": "web"
      }
    },
    "createdAt": "2025-09-09T03:23:10.285Z",
    "updatedAt": "2025-09-09T03:23:10.285Z"
  },
  "analytic": {
    "apiKey": "abc123-analytics-key"
  }
}

Retrieve a bot (v2)

get

Fetches the details of a specific bot by its UUID within a given organization and environment. Optionally includes a thumbnail.

Path parameters

orgUUIDstringRequired

A valid UUID of the organization

envUUIDstringRequired

A valid UUID of the environment

botUUIDstringRequired

A valid UUID of the bot

Query parameters

thumbnailbooleanOptional

Whether to include a thumbnail in the response

Default: false

Responses

200

Bot retrieved successfully

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden - user does not have permission to view the bot

*/*

404

Bot not found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

GET /org/{orgUUID}/env/{envUUID}/v2/bots/{botUUID} HTTP/1.1
Host: 
Accept: */*

{
  "uuid": "c51f7211-b89c-4841-8958-d2eeae76ed0a",
  "name": "Customer Support Bot",
  "description": "Handles customer service inquiries",
  "companyName": "NTT DATA",
  "locale": "en-US",
  "industry": "Banking",
  "image": {
    "url": "https://cdn.example.com/images/bot123.png",
    "contentType": "image/png",
    "botHasCustomImage": true
  },
  "engine": {
    "nlu": {
      "id": 101,
      "name": "Clever/DialogFlow/Lex/Luis/Watson/OpenAI/Azure OpenAI/eva Azure OpenAI",
      "first": true,
      "metadata": "{\"version\":\"v2\"}",
      "nlutype": "NLUEngineType.CLEVER(value=Clever)"
    },
    "kai": {
      "id": 123,
      "name": "KAI",
      "metadata": "{\"version\":\"1.0\",\"status\":\"active\"}"
    },
    "agentic": {
      "id": 101,
      "name": "OpenAI/Azure OpenAI/eva Azure OpenAI",
      "first": true,
      "metadata": "{\"priority\":\"high\",\"enabled\":true}"
    },
    "isHybrid": true,
    "isAgentic": false,
    "isClever": true,
    "isBotLLM": false
  },
  "channel": {
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "botUuid": "567e8910-e89b-12d3-a456-426614174000",
    "name": "Support Channel",
    "description": "Channel used for customer support",
    "channelType": {
      "id": 1,
      "name": "WhatsApp",
      "image": "https://cdn.example.com/images/whatsapp-icon.png",
      "channelClassification": {
        "id": 1,
        "name": "web"
      }
    },
    "createdAt": "2025-09-09T03:23:10.285Z",
    "updatedAt": "2025-09-09T03:23:10.285Z"
  },
  "analytic": {
    "apiKey": "abc123-analytics-key"
  }
}

Update an existing bot (v2)

put

Updates the configuration of an existing bot identified by its UUID within a specific organization and environment.

Path parameters

orgUUIDstringRequired

A valid UUID of the organization

envUUIDstringRequired

A valid UUID of the environment

botUUIDstringRequired

A valid UUID of the bot

Body

Data to update the bot

namestringRequired

The name of the agent

Example: SupportBot

descriptionstringRequired

A brief description of the agent

Example: Handles customer support queries

localestringRequired

The locale of the agent

Example: en-US

industrystringRequired

The industry the agent is associated with

Example: E-commerce

companyNamestringRequired

The name of the company

Example: Acme Corp

imagestringOptional

Optional image URL or base64 string

Example: https://example.com/image.png

Responses

200

Bot updated successfully

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden - user does not have permission to update the bot

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity - invalid input data

*/*

500

Internal Server Error

*/*

put

PUT /org/{orgUUID}/env/{envUUID}/v2/bots/{botUUID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 771

{
  "name": "SupportBot",
  "description": "Handles customer support queries",
  "locale": "en-US",
  "industry": "E-commerce",
  "companyName": "Acme Corp",
  "image": "https://example.com/image.png",
  "engine": {
    "nlu": {
      "name": "Dialogflow",
      "first": true,
      "metadata": "{\"language\":\"en-US\"}",
      "nlutype": "NLUEngineType.CLEVER(value=Clever)"
    },
    "agentic": {
      "name": "GPT_AGENTIC",
      "first": true,
      "metadata": "{\"personaId\":\"12345\"}",
      "persona": {
        "name": "Ava",
        "image": "https://example.com/images/ava.png",
        "backstory": "Ava is a seasoned customer support expert with a calm and reassuring tone.",
        "personality": "Empathetic, patient, and detail-oriented",
        "communicationStyle": "POLITE_AND_PERSUASIVE"
      },
      "agenticType": "AgenticEngineType.OPENAI(value=OpenAI)"
    },
    "llm": true
  },
  "analytic": {
    "apiKey": "abc123-analytics-key"
  }
}

{
  "uuid": "c51f7211-b89c-4841-8958-d2eeae76ed0a",
  "name": "Customer Support Bot",
  "description": "Handles customer service inquiries",
  "companyName": "NTT DATA",
  "locale": "en-US",
  "industry": "Banking",
  "image": {
    "url": "https://cdn.example.com/images/bot123.png",
    "contentType": "image/png",
    "botHasCustomImage": true
  },
  "engine": {
    "nlu": {
      "id": 101,
      "name": "Clever/DialogFlow/Lex/Luis/Watson/OpenAI/Azure OpenAI/eva Azure OpenAI",
      "first": true,
      "metadata": "{\"version\":\"v2\"}",
      "nlutype": "NLUEngineType.CLEVER(value=Clever)"
    },
    "kai": {
      "id": 123,
      "name": "KAI",
      "metadata": "{\"version\":\"1.0\",\"status\":\"active\"}"
    },
    "agentic": {
      "id": 101,
      "name": "OpenAI/Azure OpenAI/eva Azure OpenAI",
      "first": true,
      "metadata": "{\"priority\":\"high\",\"enabled\":true}"
    },
    "isHybrid": true,
    "isAgentic": false,
    "isClever": true,
    "isBotLLM": false
  },
  "channel": {
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "botUuid": "567e8910-e89b-12d3-a456-426614174000",
    "name": "Support Channel",
    "description": "Channel used for customer support",
    "channelType": {
      "id": 1,
      "name": "WhatsApp",
      "image": "https://cdn.example.com/images/whatsapp-icon.png",
      "channelClassification": {
        "id": 1,
        "name": "web"
      }
    },
    "createdAt": "2025-09-09T03:23:10.285Z",
    "updatedAt": "2025-09-09T03:23:10.285Z"
  },
  "analytic": {
    "apiKey": "abc123-analytics-key"
  }
}

Delete a bot

delete

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Responses

204

No content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable entity

*/*

500

Internal Server Error

*/*

delete

DELETE /org/{orgUUID}/env/{envUUID}/bots/{botUUID} HTTP/1.1
Host: 
Accept: */*

No content

Deprecated Endpoints

Create a new bot with his dependencies: nlpEngine, bot-admin, channels and parameters

post

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

Body

Data to create a new bot

namestringRequired

Name of the bot

descriptionstring · max: 250Optional

Description of the bot

industrystringOptional

Type of bot business

localestringRequired

Locale of the bot

imagestringOptional

Base64 of the bot's image in the DataURI format.

contentTypestringOptionalDeprecated

[DEPRECATED] Content-Type of the bot image. Inferred from the image field.

metadatastringOptional

Metadata of bot's nlp engine. OBS: Its not required if wants to insert or update bot clever

channelNamestringRequired

Name of the first channel to create with the bot

channelTypeinteger · int64Required

Type of the first channel to create with the bot. Types: 1 - Amazon Echo, 2 - Google Home, 4 - Jibo, 5 - Alexa, 6 - Cortana, 7 - Google Assistant, 8 - Siri, 9 - Facebook, 10 - RCS, 11 - SMS, 12 - Skype, 13 - ARCore, 14 - ARKit, 15 - Android, 16 - iOS, 17 - IVR, 18 - VR, 19 - Web, 20 - Web Mobile, 21 - App Mobile, 22 - WhatsApp, 24 - Skype for Business, 25 - Telegram, 26 - Twitter, 27 - WhatsApp (Infobip), 28 - HTC Vive, 29 - Oculus Rift, 30 - Oculus Go, 31 - Samsung Gear VR, 32 - Hololens, 33 - Apple Business Chat, 34 - Microsoft Teams

channelDescriptionstringOptional

Description of the first channel to create with the bot

nlpNamestringRequired

NlpName of the bot. Options: Clever, Watson, Luis, DialogFlow, Lex, Azure OpenAI, OpenAI, eva Azure OpenAI

api_keystringOptional

Api key of the analytic platform: Dashbot, Chatbase...

Responses

201

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable entity

*/*

500

Internal Server Error

*/*

post

POST /org/{orgUUID}/env/{envUUID}/bots HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 2034

{
  "name": "text",
  "description": "text",
  "industry": "text",
  "locale": "text",
  "image": "text",
  "metadata": "text",
  "channelName": "text",
  "channelType": 1,
  "channelDescription": "text",
  "nlpName": "text",
  "ivrConfiguration": {
    "vendor": "text",
    "dnis": "text",
    "secret": "text",
    "fetchData": {
      "timeoutInterval": 45000,
      "audio": {
        "url": "text",
        "delay": 0,
        "minimum": 0,
        "interval": 0
      }
    },
    "transferCall": {
      "uui": "text",
      "destination": "text"
    },
    "defaultErrorHandling": {
      "transferOnError": true,
      "audio": {
        "url": "text",
        "delay": 0,
        "minimum": 0,
        "interval": 0
      },
      "tts": "text",
      "transferCall": {
        "uui": "text",
        "destination": "text"
      }
    },
    "callEstablishmentErrorHandling": {
      "transferOnError": true,
      "audio": {
        "url": "text",
        "delay": 0,
        "minimum": 0,
        "interval": 0
      },
      "tts": "text",
      "transferCall": {
        "uui": "text",
        "destination": "text"
      }
    },
    "settings": {
      "firstConversationRequest": "{\"text\":\"\",\"code\":\"%EVA_WELCOME_MSG\",\"context\":{}}",
      "conversationTimeout": 40000,
      "sendPostCallEvents": true,
      "regionalExpressionsFileUrl": "text",
      "welcomeTimeout": 40000,
      "maxCallDuration": 300000
    },
    "ttsAudioConfiguration": {
      "mask": "text",
      "tts": {
        "voiceProvider": "AZURE_WHISPER",
        "voiceProviderConfig": "{\"azureOpenAIKey\":\"your-azure-openai-key\",\"azureOpenAIEndpoint\":\"your-azure-openai-endpoint\",\"gptDeployment\":\"your-gpt-deployment\",\"whisperDeployment\":\"your-whisper-deployment\",\"languageCode\":\"your-language-code\",\"prompt\":\"your-prompt\"}"
      },
      "flush": false,
      "bargeIn": false,
      "voiceBargeIn": false,
      "bargeInOffset": 1,
      "time": 1
    },
    "dtmfMenu": {
      "interdigitTimeout": 5000,
      "numberOfDigits": 1,
      "timeoutInterval": 15000,
      "terminationTimeout": 2500,
      "terminationCharacter": "#"
    },
    "voiceMenu": {
      "timeoutInterval": 15000,
      "sensitivity": 0.25,
      "confidence": 0.6,
      "maxSpeechTimeout": 20000,
      "incompleteTimeout": 20000,
      "asr": {
        "voiceProvider": "AZURE_WHISPER",
        "voiceProviderConfig": "{\"azureOpenAIKey\":\"your-azure-openai-key\",\"azureOpenAIEndpoint\":\"your-azure-openai-endpoint\",\"gptDeployment\":\"your-gpt-deployment\",\"whisperDeployment\":\"your-whisper-deployment\",\"languageCode\":\"your-language-code\",\"prompt\":\"your-prompt\"}"
      }
    }
  },
  "api_key": "text"
}

{
  "uuid": "text",
  "name": "text",
  "description": "text",
  "industry": "text",
  "locale": "text",
  "nlpId": 1,
  "nlp": "text",
  "metadata": "text",
  "image": "text",
  "contentType": "text",
  "botHasCustomImage": true,
  "isClever": true,
  "isBotLLM": true,
  "channel": {
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "botUuid": "567e8910-e89b-12d3-a456-426614174000",
    "name": "Support Channel",
    "description": "Channel used for customer support",
    "channelType": {
      "id": 1,
      "name": "WhatsApp",
      "image": "https://cdn.example.com/images/whatsapp-icon.png",
      "channelClassification": {
        "id": 1,
        "name": "web"
      }
    },
    "createdAt": "2025-09-09T03:23:10.285Z",
    "updatedAt": "2025-09-09T03:23:10.285Z"
  },
  "api_key": "text"
}

Retrieves complete information from a Bot given it's UUID

get

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Query parameters

thumbnailbooleanOptional

Controls whether the returned default image is a thumbnail version or full image; user-submitted images are unaffected. Default value is false. (Full version)

Default: false

Responses

200

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

GET /org/{orgUUID}/env/{envUUID}/bots/{botUUID} HTTP/1.1
Host: 
Accept: */*

{
  "uuid": "text",
  "name": "text",
  "description": "text",
  "industry": "text",
  "locale": "text",
  "nlpId": 1,
  "nlp": "text",
  "metadata": "text",
  "image": "text",
  "contentType": "text",
  "botHasCustomImage": true,
  "isClever": true,
  "isBotLLM": true,
  "api_key": "text"
}

Update a bot

put

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Body

Data to update bot

namestringRequired

Name of the bot

descriptionstring · max: 250Optional

Description of the bot

industrystringOptional

Type of bot business

localestringRequired

Locale of the bot

imagestringOptional

Base64 of the bot's image in the DataURI format.

contentTypestringOptional

[DEPRECATED] Content-type of the bot image. Inferred from the image field.

metadatastringOptional

Metadata of bot's nlp engine. OBS: Its not required if wants to insert or update bot clever

api_keystringOptional

Api key of the analytic platform: Dashbot, Chatbase...

Responses

200

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable entity

*/*

500

Internal Server Error

*/*

put

PUT /org/{orgUUID}/env/{envUUID}/bots/{botUUID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "name": "text",
  "description": "text",
  "industry": "text",
  "locale": "text",
  "image": "text",
  "contentType": "text",
  "metadata": "text",
  "api_key": "text"
}

{
  "uuid": "text",
  "name": "text",
  "description": "text",
  "industry": "text",
  "locale": "text",
  "nlpId": 1,
  "nlp": "text",
  "metadata": "text",
  "image": "text",
  "contentType": "text",
  "botHasCustomImage": true,
  "isClever": true,
  "isBotLLM": true,
  "api_key": "text"
}

LLM Engine

Using the endpoit and api-key entered as parameters for this service, it will list the models and deploys available.

post

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

Body

Contains the data needed to consult account data

endpointstringOptional

User account endpoint

apiKeystringOptional

User account api-key

engineTypestring · enumOptional

LLM engine type

Possible values:

Responses

200

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

POST /org/{orgUUID}/env/{envUUID}/engines/llm/account-details HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "endpoint": "text",
  "apiKey": "text",
  "engineType": "LLMEngineType.OPENAI(value=OpenAI)"
}

{
  "models": [
    {
      "name": "text",
      "deploy": {
        "name": "text"
      }
    }
  ]
}

PreviousAutomated Tests NextBroker

Last updated 20 days ago

Was this helpful?