Send Message
curl --request POST \
--url https://api.example.com/api/conversations/{conversation_id}/events \
--header 'Content-Type: application/json' \
--header 'X-Session-API-Key: <api-key>' \
--data '
{
"content": [
{
"text": "<string>",
"cache_prompt": false,
"type": "text"
}
],
"role": "user",
"run": false
}
'import requests
url = "https://api.example.com/api/conversations/{conversation_id}/events"
payload = {
"content": [
{
"text": "<string>",
"cache_prompt": False,
"type": "text"
}
],
"role": "user",
"run": False
}
headers = {
"X-Session-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Session-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
content: [{text: '<string>', cache_prompt: false, type: 'text'}],
role: 'user',
run: false
})
};
fetch('https://api.example.com/api/conversations/{conversation_id}/events', 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/api/conversations/{conversation_id}/events",
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([
'content' => [
[
'text' => '<string>',
'cache_prompt' => false,
'type' => 'text'
]
],
'role' => 'user',
'run' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Session-API-Key: <api-key>"
],
]);
$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/api/conversations/{conversation_id}/events"
payload := strings.NewReader("{\n \"content\": [\n {\n \"text\": \"<string>\",\n \"cache_prompt\": false,\n \"type\": \"text\"\n }\n ],\n \"role\": \"user\",\n \"run\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Session-API-Key", "<api-key>")
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/api/conversations/{conversation_id}/events")
.header("X-Session-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"content\": [\n {\n \"text\": \"<string>\",\n \"cache_prompt\": false,\n \"type\": \"text\"\n }\n ],\n \"role\": \"user\",\n \"run\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/conversations/{conversation_id}/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Session-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"content\": [\n {\n \"text\": \"<string>\",\n \"cache_prompt\": false,\n \"type\": \"text\"\n }\n ],\n \"role\": \"user\",\n \"run\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Events
Send Message
Send a message to a conversation.
If starting the run returns 429, the message is already saved. Retry the conversation’s /run endpoint instead of resending the message.
POST
/
api
/
conversations
/
{conversation_id}
/
events
Send Message
curl --request POST \
--url https://api.example.com/api/conversations/{conversation_id}/events \
--header 'Content-Type: application/json' \
--header 'X-Session-API-Key: <api-key>' \
--data '
{
"content": [
{
"text": "<string>",
"cache_prompt": false,
"type": "text"
}
],
"role": "user",
"run": false
}
'import requests
url = "https://api.example.com/api/conversations/{conversation_id}/events"
payload = {
"content": [
{
"text": "<string>",
"cache_prompt": False,
"type": "text"
}
],
"role": "user",
"run": False
}
headers = {
"X-Session-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Session-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
content: [{text: '<string>', cache_prompt: false, type: 'text'}],
role: 'user',
run: false
})
};
fetch('https://api.example.com/api/conversations/{conversation_id}/events', 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/api/conversations/{conversation_id}/events",
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([
'content' => [
[
'text' => '<string>',
'cache_prompt' => false,
'type' => 'text'
]
],
'role' => 'user',
'run' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Session-API-Key: <api-key>"
],
]);
$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/api/conversations/{conversation_id}/events"
payload := strings.NewReader("{\n \"content\": [\n {\n \"text\": \"<string>\",\n \"cache_prompt\": false,\n \"type\": \"text\"\n }\n ],\n \"role\": \"user\",\n \"run\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Session-API-Key", "<api-key>")
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/api/conversations/{conversation_id}/events")
.header("X-Session-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"content\": [\n {\n \"text\": \"<string>\",\n \"cache_prompt\": false,\n \"type\": \"text\"\n }\n ],\n \"role\": \"user\",\n \"run\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/conversations/{conversation_id}/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Session-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"content\": [\n {\n \"text\": \"<string>\",\n \"cache_prompt\": false,\n \"type\": \"text\"\n }\n ],\n \"role\": \"user\",\n \"run\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Authorizations
Path Parameters
Body
application/json
Payload to send a message to the agent.
Response
Successful Response
Was this page helpful?