Start a new conversation with an agent
curl --request POST \
--url http://localhost:3000/api/agents/{agentId}/conversations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"userId": "<string>",
"contactId": "<string>",
"title": "Support inquiry about refund"
}
'import requests
url = "http://localhost:3000/api/agents/{agentId}/conversations"
payload = {
"userId": "<string>",
"contactId": "<string>",
"title": "Support inquiry about refund"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userId: '<string>',
contactId: '<string>',
title: 'Support inquiry about refund'
})
};
fetch('http://localhost:3000/api/agents/{agentId}/conversations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/agents/{agentId}/conversations",
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([
'userId' => '<string>',
'contactId' => '<string>',
'title' => 'Support inquiry about refund'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://localhost:3000/api/agents/{agentId}/conversations"
payload := strings.NewReader("{\n \"userId\": \"<string>\",\n \"contactId\": \"<string>\",\n \"title\": \"Support inquiry about refund\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:3000/api/agents/{agentId}/conversations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"userId\": \"<string>\",\n \"contactId\": \"<string>\",\n \"title\": \"Support inquiry about refund\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/agents/{agentId}/conversations")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userId\": \"<string>\",\n \"contactId\": \"<string>\",\n \"title\": \"Support inquiry about refund\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"organizationId": "<string>",
"agentId": "<string>",
"mastraThreadId": "<string>",
"messageCount": 123,
"status": "pending",
"startedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"userId": "<string>",
"contactId": "<string>",
"title": "<string>",
"lastMessageAt": "<string>",
"endedAt": "<string>"
}Agent Studio - Conversations
Start a new conversation with an agent
POST
/
api
/
agents
/
{agentId}
/
conversations
Start a new conversation with an agent
curl --request POST \
--url http://localhost:3000/api/agents/{agentId}/conversations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"userId": "<string>",
"contactId": "<string>",
"title": "Support inquiry about refund"
}
'import requests
url = "http://localhost:3000/api/agents/{agentId}/conversations"
payload = {
"userId": "<string>",
"contactId": "<string>",
"title": "Support inquiry about refund"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userId: '<string>',
contactId: '<string>',
title: 'Support inquiry about refund'
})
};
fetch('http://localhost:3000/api/agents/{agentId}/conversations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/agents/{agentId}/conversations",
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([
'userId' => '<string>',
'contactId' => '<string>',
'title' => 'Support inquiry about refund'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://localhost:3000/api/agents/{agentId}/conversations"
payload := strings.NewReader("{\n \"userId\": \"<string>\",\n \"contactId\": \"<string>\",\n \"title\": \"Support inquiry about refund\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:3000/api/agents/{agentId}/conversations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"userId\": \"<string>\",\n \"contactId\": \"<string>\",\n \"title\": \"Support inquiry about refund\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/agents/{agentId}/conversations")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userId\": \"<string>\",\n \"contactId\": \"<string>\",\n \"title\": \"Support inquiry about refund\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"organizationId": "<string>",
"agentId": "<string>",
"mastraThreadId": "<string>",
"messageCount": 123,
"status": "pending",
"startedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"userId": "<string>",
"contactId": "<string>",
"title": "<string>",
"lastMessageAt": "<string>",
"endedAt": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Agent ID
Body
application/json
Response
Conversation started successfully
Conversation ID
Organization ID
Agent ID
Mastra thread ID
Message count
Conversation status
Available options:
pending, active, ended, failed, archived Started at timestamp
Created at timestamp
Updated at timestamp
User ID
Contact ID
Conversation title
Last message timestamp
Ended at timestamp