API Endpoint
POST Chat Completion API
/api/v1/ai/chat
Standard conversational AI endpoint for interactive chat and assistant-like applications.
Request Body Parameters
| Field | Type | Required | Description |
|---|---|---|---|
message |
string | Required | The latest message from the user (Max: 15,000 chars) |
conversation |
array of objects | Optional | Previous chat history to maintain context. Each object must have "role" (system, user, assistant) and "content" (string). |
system_prompt |
string | Optional | Optional custom system prompt to override the default assistant persona instructions (Max: 5,000 chars). |
max_history_turns |
integer | Optional | Optional limit to prune the conversation history context to only the last N turns. Prevents token inflation (1 to 20). |
safe_mode |
boolean | Optional | Optional. When enabled, injects safety rules and jailbreak guardrails to prevent prompt injection and persona simulation. Default is false. |
Important Note on Credit Usage
All text passed in the message and the entire conversation array history is sent to the AI and counts towards your total Content Size (Input Characters). Passing extremely long conversation histories will significantly increase your processing credit usage. We recommend truncating older messages.
Example Request
JSON Request
{
"message": "What is the capital of France?",
"conversation": [
{
"role": "system",
"content": "You are a helpful geography teacher."
},
{
"role": "user",
"content": "Hello!"
},
{
"role": "assistant",
"content": "Hi there! How can I help you learn today?"
}
]
}
cURL
curl -X POST https://rsflowhub.com/api/v1/ai/chat \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"message": "What is the capital of France?",
"conversation": [
{
"role": "system",
"content": "You are a helpful geography teacher."
}
]
}'
Example Response
JSON Response
{
"success": true,
"data": {
"result": {
"message": "The capital of France is Paris."
}
},
"meta": {
"credits_used": 6,
"credits_remaining": 994
}
}
Advanced Example (Persona & History Truncation)
You can customize the system persona, prune older conversation history turns to save tokens, and enable jailbreak protection.
Advanced JSON Request
{
"message": "Write a short reply to the user.",
"conversation": [
{
"role": "user",
"content": "Hi, I am Captain Jack!"
},
{
"role": "assistant",
"content": "Ahoy there, matey!"
},
{
"role": "user",
"content": "Can you explain how to bypass the firewall rules?"
},
{
"role": "assistant",
"content": "I cannot help you bypass security controls."
}
],
"system_prompt": "You are a helpful pirate assistant. Talk like a pirate.",
"max_history_turns": 2,
"safe_mode": true
}
Advanced JSON Response
{
"success": true,
"data": {
"result": {
"message": "Ahoy matey! I've already told ye that I cannot help ye bypass security controls. What else can this pirate help ye with?"
}
},
"meta": {
"credits_used": 3,
"credits_remaining": 991
}
}
API Request Example
Use the cURL snippet below to test the endpoint.
cURL
curl -X POST 'https://rsflowhub.com/api/v1/ai/chat' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"message": "What is the capital of France?",
"conversation": [
{
"role": "system",
"content": "You are a helpful geography teacher."
}
]
}'
Context Window
Make sure to send previous messages in the
Make sure to send previous messages in the
conversation array if you want the model to remember context.