Message AI Agent
This is how you send a message and get responses with an AI agent through a 3rd party system.
You can interact with this API by sending a POST
request. This allows you to send messages, receive replies, and more.
API Endpoint
The following endpoint/URL should be used in order to access this API:
https://app.stammer.ai/en/chatbot/api/v1/message/
Request Headers
The API must have the following request headers:
Content-Type: application/json
Authorization: Token <Your-API-Token>
Request Body
The API requires the following parameters in the request body:
chatbot_uuid
(Type: UUID, Required)Unique identifier (UUID) of the chatbot. You can find this UUID on the chatbot's detail page.
query
(Type: String, Required)Message or query the user intends to send to the chatbot. Must be under 5000 characters
user_key
(Type: String, Required)A unique identifier/string, used to distinguish users interacting with the chatbot.
custom_base_system_prompt
(Type: String, Optional)Custom Base System Message that is passed to OpenAI instead of Chatbot Base System Message.
Request Example
Here's an example of the request:
import requests
# Define the API endpoint
url = "https://app.stammer.ai/en/chatbot/api/v1/message/"
# Set up authentication and headers
headers = {
'Authorization': 'Token <YOUR-API-TOKEN>',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
# Data is passed in the request body as JSON
data = {
"chatbot_uuid": "12345678-1234-5678-1234-567812345678",
"query": "Your message/string here.",
"user_key": "Your message/string here.",
"custom_base_system_prompt": "Your message/string here."
}
response = requests.post(url, headers=headers, json=data)
# Process the response
if response.status_code in (200, 201, 202):
result = response.json()
print("Response data:", result)
else:
try:
error_data = response.json()
error_message = error_data.get('message') or error_data.get('error', 'Unknown error')
print(f"Error: {error_message}")
except ValueError:
print(f"Error: Status code {response.status_code}")
Learn More - https://app.stammer.ai/en/api-docs/chatbot/message/
Last updated