Chat
Send Message
Send a chat message and receive an LLM reply.
Creates or resumes a session. Supports context threading via session_id or previous_chat_id.
POST
/
v1
/
chat
Send Message
curl --request POST \
--url https://api.example.com/v1/chat \
--header 'Content-Type: application/json' \
--data '
{
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "<string>",
"session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"previous_chat_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "api",
"customer_number": "<string>",
"turncall_number": "<string>",
"metadata": {}
}
'import requests
url = "https://api.example.com/v1/chat"
payload = {
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "<string>",
"session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"previous_chat_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "api",
"customer_number": "<string>",
"turncall_number": "<string>",
"metadata": {}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
message: '<string>',
session_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
previous_chat_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
channel: 'api',
customer_number: '<string>',
turncall_number: '<string>',
metadata: {}
})
};
fetch('https://api.example.com/v1/chat', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/chat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'message' => '<string>',
'session_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'previous_chat_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'channel' => 'api',
'customer_number' => '<string>',
'turncall_number' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/chat"
payload := strings.NewReader("{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"message\": \"<string>\",\n \"session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"previous_chat_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"channel\": \"api\",\n \"customer_number\": \"<string>\",\n \"turncall_number\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/chat")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"message\": \"<string>\",\n \"session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"previous_chat_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"channel\": \"api\",\n \"customer_number\": \"<string>\",\n \"turncall_number\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/chat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"message\": \"<string>\",\n \"session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"previous_chat_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"channel\": \"api\",\n \"customer_number\": \"<string>\",\n \"turncall_number\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Body
application/json
Response
Successful Response
The response is of type Response Send Message V1 Chat Post · object.
Was this page helpful?
⌘I
Send Message
curl --request POST \
--url https://api.example.com/v1/chat \
--header 'Content-Type: application/json' \
--data '
{
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "<string>",
"session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"previous_chat_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "api",
"customer_number": "<string>",
"turncall_number": "<string>",
"metadata": {}
}
'import requests
url = "https://api.example.com/v1/chat"
payload = {
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "<string>",
"session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"previous_chat_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "api",
"customer_number": "<string>",
"turncall_number": "<string>",
"metadata": {}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
message: '<string>',
session_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
previous_chat_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
channel: 'api',
customer_number: '<string>',
turncall_number: '<string>',
metadata: {}
})
};
fetch('https://api.example.com/v1/chat', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/chat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'message' => '<string>',
'session_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'previous_chat_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'channel' => 'api',
'customer_number' => '<string>',
'turncall_number' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/chat"
payload := strings.NewReader("{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"message\": \"<string>\",\n \"session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"previous_chat_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"channel\": \"api\",\n \"customer_number\": \"<string>\",\n \"turncall_number\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/chat")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"message\": \"<string>\",\n \"session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"previous_chat_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"channel\": \"api\",\n \"customer_number\": \"<string>\",\n \"turncall_number\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/chat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"message\": \"<string>\",\n \"session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"previous_chat_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"channel\": \"api\",\n \"customer_number\": \"<string>\",\n \"turncall_number\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}