Parameters
The Parameter API handles global parameters that either affects the current environment, or Bots individually. Bot parameters overrides environment parameters locally.
Environment Parameters
Represents the id of organization
Represents the id of environment
DTO to request create or update parameter/configuration with key, value, description and enabled
Parameter's key
Parameter's value
Parameter's description
Flag that indicates if the parameter is enabled
OK
Created
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
This key is already being used
Unprocessable Entity
Bot not exists
POST /org/{orgUUID}/env/{envUUID}/parameters HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"key": "text",
"value": "text",
"description": "text",
"enabled": true
}{
"data": {
"uuid": "text",
"enabled": true,
"description": "text",
"key": "text",
"value": "text"
},
"message": "text"
}It is the id that represents an organization
It is the id that represents an environment
Parameter key to search only for this
It is an identifier provided by the API client that will be used to identify distributed logs.
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /org/{orgUUID}/env/{envUUID}/v2/parameters HTTP/1.1
Host:
Accept: */*
{
"parameters": {
"cockpitVersion": "text",
"confidenceMin": 1,
"timeouts": {
"genai": {
"min": 1,
"recommendation": 1,
"value": 1,
"max": 1
},
"al": {
"min": 1,
"recommendation": 1,
"value": 1,
"max": 1
},
"rephrasing": {
"min": 1,
"recommendation": 1,
"value": 1,
"max": 1
},
"zeroShot": {
"min": 1,
"recommendation": 1,
"value": 1,
"max": 1
},
"multilanguage": {
"min": 1,
"recommendation": 1,
"value": 1,
"max": 1
}
},
"maxTokens": {
"zeroShot": {
"min": 1,
"value": 1,
"max": 1
}
}
},
"extensions": {
"improveAnswers": true,
"generateExamples": true,
"genaiCell": true,
"rephrase": true,
"multilanguage": {
"enabled": true,
"properties": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"kai": {
"enabled": true,
"properties": {
"ANY_ADDITIONAL_PROPERTY": {}
}
}
},
"list": [
{
"uuid": "text",
"key": "text",
"value": "text",
"description": "text",
"enabled": true
}
],
"parameter": {
"uuid": "text",
"key": "text",
"value": "text",
"description": "text",
"enabled": true
}
}Represents the id of organization
Represents the id of environment
It is the parameter's name to find
OK
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /org/{orgUUID}/env/{envUUID}/parameters HTTP/1.1
Host:
Accept: */*
{
"data": [
{
"id": "text",
"enabled": true,
"description": "text",
"key": "text",
"value": "text",
"extension": true
}
],
"extensions": {
"timeouts": {
"genai": {
"min": 1,
"recommendation": 1,
"value": 1,
"max": 1
},
"al": {
"min": 1,
"recommendation": 1,
"value": 1,
"max": 1
},
"rephrasing": {
"min": 1,
"recommendation": 1,
"value": 1,
"max": 1
},
"zeroShot": {
"min": 1,
"recommendation": 1,
"value": 1,
"max": 1
},
"multilanguage": {
"min": 1,
"recommendation": 1,
"value": 1,
"max": 1
}
}
},
"message": "text"
}Represents the id of organization
Represents the id of environment
Represents the id of configuration
DTO to request create or update parameter/configuration with key, value, description and enabled
Parameter's key
Parameter's value
Parameter's description
Flag that indicates if the parameter is enabled
OK
Bad Request
Unauthorized
Forbidden
Parameter with that id and botUUID doesn't exist
Conflict
This key is already being used
Unprocessable Entity
Bot not exists
PUT /org/{orgUUID}/env/{envUUID}/parameters/{parameterId} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"key": "text",
"value": "text",
"description": "text",
"enabled": true
}{
"data": {
"uuid": "text",
"enabled": true,
"description": "text",
"key": "text",
"value": "text"
},
"message": "text"
}Represents the id of organization
Represents the id of environment
Represents the id of configuration
OK
Bad Request
Unauthorized
Configuration is not erasable
Parameter with that id doesn't exist
Conflict
Unprocessable Entity
Internal Server Error
DELETE /org/{orgUUID}/env/{envUUID}/parameters/{parameterId} HTTP/1.1
Host:
Accept: */*
No content
Represents the id of organization
Represents the id of environment
OK
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Configuration not found
GET /org/{orgUUID}/env/{envUUID}/parameters/version HTTP/1.1
Host:
Accept: */*
{
"data": {
"value": "text"
},
"message": "text"
}Return if the environment has the license to use automated learning. Deprecated method which will me removed past 4.5.0
Represents the id of organization
Represents the id of environment
OK
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /org/{orgUUID}/env/{envUUID}/parameters/automated-learning HTTP/1.1
Host:
Accept: */*
{
"hasLicense": true
}Bot Parameters
Represents the id of organization
Represents the id of environment
Represents the id of bot
DTO to request create or update parameter/configuration with key, value, description and enabled
Parameter's key
Parameter's value
Parameter's description
Flag that indicates if the parameter is enabled
OK
Created
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
This key is already being used
Unprocessable Entity
Bot not exists
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"key": "text",
"value": "text",
"description": "text",
"enabled": true
}{
"data": {
"uuid": "text",
"enabled": true,
"description": "text",
"key": "text",
"value": "text"
},
"message": "text"
}A valid organization uuid
A valid environment uuid
A valid bot uuid
It is an identifier provided by the API client that will be used to identify distributed logs.
DTO with type and value to the slides.
The slide type, it can be CONFIDENCE_MIN, GENAI, AL OR REPHRASING.
The slide value.
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/update-reserved HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"type": "text",
"value": 1
}No content
It is the id that represents an organization
It is the id that represents an environment
It is the id that represents a bot.
Parameter key to search only for this
It is an identifier provided by the API client that will be used to identify distributed logs.
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/v2/parameters HTTP/1.1
Host:
Accept: */*
{
"parameters": {
"cockpitVersion": "text",
"confidenceMin": 1,
"timeouts": {
"genai": {
"min": 1,
"recommendation": 1,
"value": 1,
"max": 1
},
"al": {
"min": 1,
"recommendation": 1,
"value": 1,
"max": 1
},
"rephrasing": {
"min": 1,
"recommendation": 1,
"value": 1,
"max": 1
},
"zeroShot": {
"min": 1,
"recommendation": 1,
"value": 1,
"max": 1
},
"multilanguage": {
"min": 1,
"recommendation": 1,
"value": 1,
"max": 1
}
},
"maxTokens": {
"zeroShot": {
"min": 1,
"value": 1,
"max": 1
}
}
},
"extensions": {
"improveAnswers": true,
"generateExamples": true,
"genaiCell": true,
"rephrase": true,
"multilanguage": {
"enabled": true,
"properties": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"kai": {
"enabled": true,
"properties": {
"ANY_ADDITIONAL_PROPERTY": {}
}
}
},
"list": [
{
"uuid": "text",
"key": "text",
"value": "text",
"description": "text",
"enabled": true
}
],
"parameter": {
"uuid": "text",
"key": "text",
"value": "text",
"description": "text",
"enabled": true
}
}Represents the id of organization
Represents the id of environment
Represents the id of bot
It is the parameter's name to find
OK
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters HTTP/1.1
Host:
Accept: */*
{
"data": [
{
"id": "text",
"enabled": true,
"description": "text",
"key": "text",
"value": "text",
"extension": true
}
],
"extensions": {
"timeouts": {
"genai": {
"min": 1,
"recommendation": 1,
"value": 1,
"max": 1
},
"al": {
"min": 1,
"recommendation": 1,
"value": 1,
"max": 1
},
"rephrasing": {
"min": 1,
"recommendation": 1,
"value": 1,
"max": 1
},
"zeroShot": {
"min": 1,
"recommendation": 1,
"value": 1,
"max": 1
},
"multilanguage": {
"min": 1,
"recommendation": 1,
"value": 1,
"max": 1
}
}
},
"message": "text"
}Represents the id of organization
Represents the id of environment
Represents the id of bot
Represents the id of configuration
DTO to request create or update parameter/configuration with key, value, description and enabled
Parameter's key
Parameter's value
Parameter's description
Flag that indicates if the parameter is enabled
OK
Bad Request
Unauthorized
Forbidden
Parameter with that id and botUUID doesn't exist
Conflict
This key is already being used
Unprocessable Entity
Bot not exists
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/{parameterId} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"key": "text",
"value": "text",
"description": "text",
"enabled": true
}{
"data": {
"uuid": "text",
"enabled": true,
"description": "text",
"key": "text",
"value": "text"
},
"message": "text"
}Represents the id of organization
Represents the id of environment
Represents the id of bot
Represents the id of configuration
OK
Bad Request
Unauthorized
Configuration is not erasable
Parameter with that id doesn't exist
Conflict
Unprocessable Entity
Internal Server Error
DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/{parameterId} HTTP/1.1
Host:
Accept: */*
No content
Environment Extensions
Represents the id of organization
Represents the id of environment
OK
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /org/{orgUUID}/env/{envUUID}/extensions/genai-enabled HTTP/1.1
Host:
Accept: */*
{
"hasLicense": true
}Bot Extensions
A valid organization uuid
A valid environment uuid
A valid bot uuid
It is the key extension to toggle. Possible values are: al.enabled, genai.cell.enabled, utterance.completetions.enabled, genai.enhancements.enabled and genai.rephrasing.enabled
It is an identifier provided by the API client that will be used to identify distributed logs.
DTO to enable or disable an extension in a bot.
Parameter's value
No Content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Bot's key validation error
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/extensions/update-status/{extension} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 86
{
"value": true,
"properties": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"configurationValue": "text"
}No content
It is the id that represents an organization
It is the id that represents an environment
It is the id that represents a bot.
Ok
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/extensions HTTP/1.1
Host:
Accept: */*
{
"improveAnswers": true,
"generateExamples": true,
"genaiCell": true,
"rephrase": true,
"multilanguage": {
"enabled": true,
"properties": {
"ANY_ADDITIONAL_PROPERTY": {}
}
},
"kai": {
"enabled": true,
"properties": {
"ANY_ADDITIONAL_PROPERTY": {}
}
}
}Last updated
Was this helpful?