Authorizations
Supply the API Key in the HTTP-Header
The access token received from the authorization server in the OAuth 2.0 flow.
Supply the API Key in the Url-Query
Headers
The default media type is application/hal+json. Use application/json for pure data results.
application/json
, application/hal+json
, application/xml
, text/xml
, text/csv
Body
"Cognigy AI Agent"
Avatar of the AI Agent.
"https://cognigy.com/ai-agent.png"
Whether the optimized image format defined by Cognigy is used.
true
A referenceId of a Knowledge Store this Agent will use as base knowledge or null.
"c7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"
A short description of the AI Agent, up to 1000 characters.
1000
"I am a virtual assistant that can help you with your questions."
{
"completeness": "concise",
"formality": "formal"
}
{
"ttsVoice": "Xb7hH8MSUJpSbSDYk0k2",
"ttsLanguage": "zh",
"ttsVendor": "Elevenlabs",
"ttsModel": "eleven_multilingual_v2",
"ttsLabel": "microsoft US",
"ttsDisableCache": false
}
Enables the use of voice configuration.
false
Option to enable or customize Contact profiles selection for the AI Agent.
none
, selectedProfileFields
, completeProfile
, profileMemoriesOnly
"selectedProfileFields"
Selected contact profiles for the AI Agent, it is used only when contactProfilesOption is set to 'selectedProfileFields'.
["name", "email"]
Instructions for the AI Agent.
1000
"I can help you with your questions, provide information and much more."
24
Response
Returns AI agent object.
The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.
"Cognigy AI Agent"
Avatar of the AI Agent.
"https://cognigy.com/ai-agent.png"
Whether the optimized image format defined by Cognigy is used.
true
A referenceId of a Knowledge Store this Agent will use as base knowledge or null.
"c7b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"
A short description of the AI Agent, up to 1000 characters.
1000
"I am a virtual assistant that can help you with your questions."
{
"completeness": "concise",
"formality": "formal"
}
{
"ttsVoice": "Xb7hH8MSUJpSbSDYk0k2",
"ttsLanguage": "zh",
"ttsVendor": "Elevenlabs",
"ttsModel": "eleven_multilingual_v2",
"ttsLabel": "microsoft US",
"ttsDisableCache": false
}
Enables the use of voice configuration.
false
Option to enable or customize Contact profiles selection for the AI Agent.
none
, selectedProfileFields
, completeProfile
, profileMemoriesOnly
"selectedProfileFields"
Selected contact profiles for the AI Agent, it is used only when contactProfilesOption is set to 'selectedProfileFields'.
["name", "email"]
Instructions for the AI Agent.
1000
"I can help you with your questions, provide information and much more."
24
Unix-timestamp
0 <= x <= 2147483647
1694518620
Unix-timestamp
0 <= x <= 2147483647
1694518620
24
24