User Guide
API DOCSVOICE GATEWAYHELPSECURITY
Current Version
Current Version
  • Welcome
  • What's New
  • ๐Ÿš€GETTING STARTED
    • Login
    • Concepts and Glossary
    • Language Models
      • Syntphony NLP
      • Other NLP and LLM Connectors
      • FAQs
    • Build a Virtual Agent
      • Overview
      • From Scratch
      • By Importing
      • Pre-Built Templates
      • Training task
    • Testing
      • Automated Test
      • Advanced Request
      • Simulate Dialog
      • View Logs
    • Create and manage profiles
  • ๐Ÿ’ฌBUILD DIALOGS
    • Flows
    • Dialog Cells
      • Intent
      • Entity
      • Answer
      • Input
      • Jump
      • End
      • Service
      • Rest Connector
      • Code
      • Rule
        • Variable answers using Code and Rule cells
        • Enable and disable flows using Rule Cells
    • Data Masking of Personal Identificable Information
    • Dynamic Content and Contexts
    • Voice Agent
    • Multilingual Agent (beta)
  • โœจGENERATIVE AI
    • AI features
    • Assist Answer (beta)
    • Examples Generator
    • Knowledge AI
    • Prompt cell
      • Prompt crafting
      • Practical examples
    • Rephrase Answer
    • Zero-Shot LLM
  • ๐ŸŒCHANNELS
    • Channels
      • WhatsApp (by Infobip)
      • Facebook Messenger
      • Microsoft Teams
      • Integrating Existing Channels
    • Webchat Plugin
  • โš™๏ธCONFIGURATIONS
    • Parameters
    • Advanced Resources
    • Other Options
      • Intent Navigator
  • ๐Ÿ“ŠANALYTICS & INSIGHTS
    • Dashboards
      • Overview
      • Funnel charts
      • User messages
      • Conversations
      • Reports
    • External Analytics Platforms
  • API DOCS
    • Overview
    • API Guidelines
      • Conversation API
      • Cloner API
      • EVG Connector
      • Management API
        • Admin API
          • Bot Admin
          • Environment
          • Organization
          • User
          • Notification
        • Instance API
          • Knowledge AI
          • Knowledge AI NLP
          • Answer
          • Automated Tests
          • Bot
          • Broker
          • Channel
          • Dashboard
          • Dialog Manager
          • Entity
          • Generative Service
          • Intent
          • Parameters
          • Tag
          • Technical Log
          • Training
          • Transactional Service
          • Rest Connector
          • Wait Input
          • Websnippet
      • Webhooks
    • Infrastructure Guidelines
      • Syntphony CAI server Installation guide
      • Maintenance Methods
      • Supported/verified third-party software
    • Data Structure
      • Admin Data Structure
      • Environment Data Structure
    • Voice Gateway
      • Genesys Cloud CX
Powered by GitBook
On this page

Was this helpful?

  1. API DOCS
  2. API Guidelines
  3. Management API
  4. Instance API

Parameters

The Parameter API handles global parameters that either affects the current environment, or Bots individually. Bot parameters overrides environment parameters locally.

PreviousIntentNextTag

Last updated 6 months ago

Was this helpful?

API SUBPATH: eva-parameter

Environment Parameters

Bot Parameters

Environment Extensions

Bot Extensions

Endpoint to get parameters from environment

get
Path parameters
orgUUIDstringRequired

It is the id that represents an organization

envUUIDstringRequired

It is the id that represents an environment

Query parameters
parameterstringOptional

Parameter key to search only for this

Header parameters
x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
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
  }
}
Deprecated

Return specific or a list of parameters globals or of the bot

get
Path parameters
orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

Query parameters
parameterstringOptional

It is the parameter's name to find

Responses
200
OK
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
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"
}

Delete a parameter/configuration

delete
Path parameters
orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

parameterIdstringRequired

Represents the id of configuration

Responses
200
OK
400
Bad Request
*/*
401
Unauthorized
*/*
403
Configuration is not erasable
*/*
404
Parameter with that id doesn't exist
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
delete
DELETE /org/{orgUUID}/env/{envUUID}/parameters/{parameterId} HTTP/1.1
Host: 
Accept: */*

No content

Return a specific configuration 'cockpit-version'

get
Path parameters
orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

Responses
200
OK
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Configuration not found
*/*
get
GET /org/{orgUUID}/env/{envUUID}/parameters/version HTTP/1.1
Host: 
Accept: */*
{
  "data": {
    "value": "text"
  },
  "message": "text"
}
Deprecated

Return if the environment has the license to use automated learning. Deprecated method which will me removed past 4.5.0

get
Path parameters
orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

Responses
200
OK
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/parameters/automated-learning HTTP/1.1
Host: 
Accept: */*
{
  "hasLicense": true
}

Endpoint to get parameters from bot

get
Path parameters
orgUUIDstringRequired

It is the id that represents an organization

envUUIDstringRequired

It is the id that represents an environment

botUUIDstringRequired

It is the id that represents a bot.

Query parameters
parameterstringOptional

Parameter key to search only for this

Header parameters
x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
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
  }
}
Deprecated

Return specific or a list of parameters globals of the bot

get
Path parameters
orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

botUUIDstringRequired

Represents the id of bot

Query parameters
parameterstringOptional

It is the parameter's name to find

Responses
200
OK
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
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"
}

Delete a parameter/configuration

delete
Path parameters
orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

botUUIDstringRequired

Represents the id of bot

parameterIdstringRequired

Represents the id of configuration

Responses
200
OK
400
Bad Request
*/*
401
Unauthorized
*/*
403
Configuration is not erasable
*/*
404
Parameter with that id doesn't exist
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
delete
DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/{parameterId} HTTP/1.1
Host: 
Accept: */*

No content

Return if the environment has the license to use genai extensions

get
Path parameters
orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

Responses
200
OK
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/extensions/genai-enabled HTTP/1.1
Host: 
Accept: */*
{
  "hasLicense": true
}

Endpoint to return if all extensions is enabled or disabled

get
Path parameters
orgUUIDstringRequired

It is the id that represents an organization

envUUIDstringRequired

It is the id that represents an environment

botUUIDstringRequired

It is the id that represents a bot.

Responses
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
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": {}
    }
  }
}
  • Environment Parameters
  • POSTCreate a new parameter/configuration
  • GETEndpoint to get parameters from environment
  • GETReturn specific or a list of parameters globals or of the bot
  • PUTUpdate a parameter/configuration
  • DELETEDelete a parameter/configuration
  • GETReturn a specific configuration 'cockpit-version'
  • GETReturn if the environment has the license to use automated learning. Deprecated method which will me removed past 4.5.0
  • Bot Parameters
  • POSTCreate a new parameter/configuration
  • POSTEndpoint to reserved bot parameters
  • GETEndpoint to get parameters from bot
  • GETReturn specific or a list of parameters globals of the bot
  • PUTUpdate a parameter/configuration
  • DELETEDelete a parameter/configuration
  • Environment Extensions
  • GETReturn if the environment has the license to use genai extensions
  • Bot Extensions
  • POSTEnable or disable genai extensions
  • GETEndpoint to return if all extensions is enabled or disabled

Create a new parameter/configuration

post
Path parameters
orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

Body

DTO to request create or update parameter/configuration with key, value, description and enabled

keystringRequired

Parameter's key

valuestringRequired

Parameter's value

descriptionstringRequired

Parameter's description

enabledbooleanOptional

Flag that indicates if the parameter is enabled

Responses
200
OK
*/*
201
Created
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
420
This key is already being used
*/*
422
Unprocessable Entity
*/*
500
Bot not exists
*/*
post
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"
}

Update a parameter/configuration

put
Path parameters
orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

parameterIdstringRequired

Represents the id of configuration

Body

DTO to request create or update parameter/configuration with key, value, description and enabled

keystringRequired

Parameter's key

valuestringRequired

Parameter's value

descriptionstringRequired

Parameter's description

enabledbooleanOptional

Flag that indicates if the parameter is enabled

Responses
200
OK
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Parameter with that id and botUUID doesn't exist
*/*
409
Conflict
*/*
420
This key is already being used
*/*
422
Unprocessable Entity
*/*
500
Bot not exists
*/*
put
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"
}

Create a new parameter/configuration

post
Path parameters
orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

botUUIDstringRequired

Represents the id of bot

Body

DTO to request create or update parameter/configuration with key, value, description and enabled

keystringRequired

Parameter's key

valuestringRequired

Parameter's value

descriptionstringRequired

Parameter's description

enabledbooleanOptional

Flag that indicates if the parameter is enabled

Responses
200
OK
*/*
201
Created
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
420
This key is already being used
*/*
422
Unprocessable Entity
*/*
500
Bot not exists
*/*
post
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"
}

Endpoint to reserved bot parameters

post
Path parameters
orgUUIDstringRequired

A valid organization uuid

envUUIDstringRequired

A valid environment uuid

botUUIDstringRequired

A valid bot uuid

Header parameters
x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

DTO with type and value to the slides.

typestringRequired

The slide type, it can be CONFIDENCE_MIN, GENAI, AL OR REPHRASING.

valueinteger ยท int32Required

The slide value.

Responses
204
No content
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}/bot/{botUUID}/parameters/update-reserved HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "type": "text",
  "value": 1
}

No content

Update a parameter/configuration

put
Path parameters
orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

botUUIDstringRequired

Represents the id of bot

parameterIdstringRequired

Represents the id of configuration

Body

DTO to request create or update parameter/configuration with key, value, description and enabled

keystringRequired

Parameter's key

valuestringRequired

Parameter's value

descriptionstringRequired

Parameter's description

enabledbooleanOptional

Flag that indicates if the parameter is enabled

Responses
200
OK
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Parameter with that id and botUUID doesn't exist
*/*
409
Conflict
*/*
420
This key is already being used
*/*
422
Unprocessable Entity
*/*
500
Bot not exists
*/*
put
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"
}

Enable or disable genai extensions

post
Path parameters
orgUUIDstringRequired

A valid organization uuid

envUUIDstringRequired

A valid environment uuid

botUUIDstringRequired

A valid bot uuid

extensionstringRequired

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

Header parameters
x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

DTO to enable or disable an extension in a bot.

valuebooleanRequired

Parameter's value

configurationValuestringOptional
Responses
204
No Content
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Bot's key validation error
*/*
post
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