Create AI Agent
You can interact with this API by sending a POST request that allows you to create a new AI agent.
API Endpoint
The following endpoint/URL should be used in order to access this API:
Request Headers
The API must have the following request headers:
Request Body
The API requires the following parameters in the request body:
Required Parameters
name
(Type: String) The name of the chatbot.display_name
(Type: String) Name shown on the Chat Widget.base_system_message
(Type: String) Base message given to ChatGPT.
Optional Parameters
chatgpt_model_key
(Type: Choice) The key for the version of the ChatGPT (OpenAI) model being used.temperature
(Type: Decimal) Temperature parameter for the GPT Chatbot Completion API. Determines the randomness of the response.support_email
(Type: Email) Set this email to override the default agency support email for the chatbot.conversation_starter_message
(Type: String) Enter chatbot's starter messages, separated by new lines. These are displayed to the user at the beginning of the conversation.initial_message
(Type: String) Chatbot's initial messages shown to the user, each message is separated by new line.show_data_sources
(Type: Boolean) Flag to indicate if the chatbot should show data sources in the chat widget.persistent_conversation_starter_message
(Type: Boolean) Maintains the visibility of the conversation starter messages throughout the conversation.debug_mode
(Type: Boolean) Enabling this option will display the sources/matched data from Redisearch for a given query.audio_io_enabled
(Type: Boolean) Enable audio and input/output for chatbot.
Request Example
Here's an example of the request:
Learn More - https://app.stammer.ai/en/api-docs/chatbot-create
Last updated