Generative Service
The Generative Service API handles all integration with LLMs and generative content.
Pagination and Listing
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
Term being searched. This expects one optional String matching the name of an generativeService.
Current page, starting at 1
1Example: 1Size of the page
5Example: 1Criteria to order result, defaulted to updatedAt date. Possible fields include name, createdAt, updatedAt, createdBy and updatedBy.
updatedAtOrder direction(ASC/DESC), defaulted to DESC
DESCGET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service?page=1&size=5 HTTP/1.1
Host:
Accept: */*
{
"totalPages": 1,
"totalElements": 1,
"pageable": {
"unpaged": true,
"paged": true,
"pageNumber": 1,
"pageSize": 1,
"offset": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
}
},
"numberOfElements": 1,
"size": 1,
"content": [
{
"generativeService": {
"uuid": "text",
"name": "text",
"description": "text",
"prompt": "text",
"model": "text",
"temperature": 1,
"maximumTokens": 1,
"topP": 1,
"presencePenalty": 1,
"frequencyPenalty": 1,
"responseVariableName": "text",
"usesBlacklist": true,
"blacklistWords": "text",
"removed": true,
"createdAt": "2025-06-30T20:38:46.043Z",
"updatedAt": "2025-06-30T20:38:46.043Z",
"updatedBy": "text",
"createdBy": "text"
},
"flows": [
{
"uuid": "text",
"name": "text"
}
]
}
],
"number": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
},
"first": true,
"last": true,
"empty": true
}Searches (greedily) for any Generative Service names that exists in a bot, matching the typed term, left-to-right, and returns a list of Strings, ordered alphabetically.
A valid organization Uuid
A valid environment Uuid
A valid bot uuid to search
Term being searched
How many items will be returned in the list. Defaults to 6.
6Example: 1GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/quicksearch?searchTerm=text HTTP/1.1
Host:
Accept: */*
[
"text"
]A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/list-on-flow HTTP/1.1
Host:
Accept: */*
[
{
"uuid": "text",
"name": "text",
"model": "text"
}
]CRUD Operations
A valid uuid of organization
A valid uuid of environment
A valid uuid of bot
Contract required to request the creation of a Generative Service.
Name of this Generative Service.
An optional description of this Generative Service.
Actual prompt to be executed during AI generation when executing this service.
AI Model to be used in this Generative Service.
AI's temperature value for execution of this Generative Service.
Maximum tokens to be used during a single execution of this Generative Service.
AI's topP value for execution of this Generative Service.
AI's presence penalty value for execution of this Generative Service.
AI's frequency penalty value for execution of this Generative Service.
Name of the variable in $hiddenContext this service will store it's result.
Wether this execution should blacklist specific words.
A blacklist of comma-separated terms to be excluded from this service's generation.
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 226
{
"name": "text",
"description": "text",
"prompt": "text",
"model": "text",
"temperature": 1,
"maximumTokens": 1,
"topP": 1,
"presencePenalty": 1,
"frequencyPenalty": 1,
"responseVariableName": "text",
"usesBlacklist": true,
"blacklistWords": "text"
}{
"generativeService": {
"uuid": "text",
"name": "text",
"description": "text",
"prompt": "text",
"model": "text",
"temperature": 1,
"maximumTokens": 1,
"topP": 1,
"presencePenalty": 1,
"frequencyPenalty": 1,
"responseVariableName": "text",
"usesBlacklist": true,
"blacklistWords": "text",
"removed": true,
"createdAt": "2025-06-30T20:38:46.043Z",
"updatedAt": "2025-06-30T20:38:46.043Z",
"updatedBy": "text",
"createdBy": "text"
},
"flows": [
{
"uuid": "text",
"name": "text"
}
]
}A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entity you are searching belong to
The generativeService's uuid
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/{uuid} HTTP/1.1
Host:
Accept: */*
{
"generativeService": {
"uuid": "text",
"name": "text",
"description": "text",
"prompt": "text",
"model": "text",
"temperature": 1,
"maximumTokens": 1,
"topP": 1,
"presencePenalty": 1,
"frequencyPenalty": 1,
"responseVariableName": "text",
"usesBlacklist": true,
"blacklistWords": "text",
"removed": true,
"createdAt": "2025-06-30T20:38:46.043Z",
"updatedAt": "2025-06-30T20:38:46.043Z",
"updatedBy": "text",
"createdBy": "text"
},
"flows": [
{
"uuid": "text",
"name": "text"
}
]
}A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entity you are searching belong to
The generativeService's uuid
Contract required to request the creation of a Generative Service.
Name of this Generative Service.
An optional description of this Generative Service.
Actual prompt to be executed during AI generation when executing this service.
AI Model to be used in this Generative Service.
AI's temperature value for execution of this Generative Service.
Maximum tokens to be used during a single execution of this Generative Service.
AI's topP value for execution of this Generative Service.
AI's presence penalty value for execution of this Generative Service.
AI's frequency penalty value for execution of this Generative Service.
Name of the variable in $hiddenContext this service will store it's result.
Wether this execution should blacklist specific words.
A blacklist of comma-separated terms to be excluded from this service's generation.
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/{uuid} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 226
{
"name": "text",
"description": "text",
"prompt": "text",
"model": "text",
"temperature": 1,
"maximumTokens": 1,
"topP": 1,
"presencePenalty": 1,
"frequencyPenalty": 1,
"responseVariableName": "text",
"usesBlacklist": true,
"blacklistWords": "text"
}{
"generativeService": {
"uuid": "text",
"name": "text",
"description": "text",
"prompt": "text",
"model": "text",
"temperature": 1,
"maximumTokens": 1,
"topP": 1,
"presencePenalty": 1,
"frequencyPenalty": 1,
"responseVariableName": "text",
"usesBlacklist": true,
"blacklistWords": "text",
"removed": true,
"createdAt": "2025-06-30T20:38:46.043Z",
"updatedAt": "2025-06-30T20:38:46.043Z",
"updatedBy": "text",
"createdBy": "text"
},
"flows": [
{
"uuid": "text",
"name": "text"
}
]
}Deletes a Generative Service. The Generative Service is disabled via the 'removed' parameter rather than deleted from the DB.
A valid uuid of organization
A valid uuid of environment
A valid uuid of bot
The generativeService's uuid
DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/{uuid} HTTP/1.1
Host:
Accept: */*
No content
Execution
The following section contains methods which are useable to test or simulate the cell's working.
A valid uuid of organization
A valid uuid of environment
A valid uuid of bot
Contract required to request the creation of a Generative Service.
Name of this Generative Service.
An optional description of this Generative Service.
Actual prompt to be executed during AI generation when executing this service.
AI Model to be used in this Generative Service.
AI's temperature value for execution of this Generative Service.
Maximum tokens to be used during a single execution of this Generative Service.
AI's topP value for execution of this Generative Service.
AI's presence penalty value for execution of this Generative Service.
AI's frequency penalty value for execution of this Generative Service.
Name of the variable in $hiddenContext this service will store it's result.
Wether this execution should blacklist specific words.
A blacklist of comma-separated terms to be excluded from this service's generation.
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/simulate HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 226
{
"name": "text",
"description": "text",
"prompt": "text",
"model": "text",
"temperature": 1,
"maximumTokens": 1,
"topP": 1,
"presencePenalty": 1,
"frequencyPenalty": 1,
"responseVariableName": "text",
"usesBlacklist": true,
"blacklistWords": "text"
}{
"text": "text",
"usedTokens": 1
}A valid uuid of organization
A valid uuid of environment
A valid uuid of bot
Structure with data for a Answer Assist enhancement request.
Discerns which task will be performed to enhance this task.
Either the context, if enhancementType is GENERATE_CONTENT, or the previously existing answer otherwise.
Tone to be applied into the answer. Used only if enhancementType is 'TONE_CHANGE' or 'GENERATE_CONTENT'
Language of this bot.
It is the channel type from the answer
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/enhance HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 105
{
"enhancementType": "GENERATE_CONTENT",
"inputText": "text",
"tone": "text",
"language": "text",
"channelType": 1
}{
"answer": "text",
"enhancementType": "GENERATE_CONTENT"
}Auxiliary Methods
A valid uuid of organization
A valid uuid of environment
A valid uuid of bot
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/availability HTTP/1.1
Host:
Accept: */*
{
"availableTones": [
"ADVENTUROUS"
],
"enabled": true
}Last updated
Was this helpful?