Get Conversations By Flow ID
curl --request GET \
--url https://api.trillet.ai/v1/api/conversations/flow/{flowId} \
--header 'x-api-key: <api-key>' \
--header 'x-workspace-id: <x-workspace-id>'import requests
url = "https://api.trillet.ai/v1/api/conversations/flow/{flowId}"
headers = {
"x-api-key": "<api-key>",
"x-workspace-id": "<x-workspace-id>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-api-key': '<api-key>', 'x-workspace-id': '<x-workspace-id>'}
};
fetch('https://api.trillet.ai/v1/api/conversations/flow/{flowId}', 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.trillet.ai/v1/api/conversations/flow/{flowId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>",
"x-workspace-id: <x-workspace-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.trillet.ai/v1/api/conversations/flow/{flowId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-workspace-id", "<x-workspace-id>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.trillet.ai/v1/api/conversations/flow/{flowId}")
.header("x-api-key", "<api-key>")
.header("x-workspace-id", "<x-workspace-id>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trillet.ai/v1/api/conversations/flow/{flowId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-workspace-id"] = '<x-workspace-id>'
response = http.request(request)
puts response.read_body{
"_id": "112ec528bf7946a12ab0fs21",
"userId": "60d9e3c2f42e4d03800e01a5",
"pathwayId": "pw12345",
"agentId": "ag67890",
"customer": {
"name": "Test Customer Name",
"email": "customer@example.com",
"phone": "+123456789"
},
"messages": [
{
"direction": "outbound",
"sent": true,
"message": "Thank you for your feedback!",
"status": "approved",
"_id": "675c8e368824aa5f130b94d3",
"createdAt": "2024-12-01T08:45:00Z",
"updatedAt": "2024-12-01T09:00:00Z"
},
{
"direction": "inbound",
"sent": true,
"message": "No worries!",
"status": "received",
"_id": "675c8e368824aa5f130b94d3",
"createdAt": "2024-12-01T08:55:00Z",
"updatedAt": "2024-12-01T09:00:00Z"
}
],
"createdAt": "2024-12-01T08:45:00Z",
"updatedAt": "2024-12-03T12:30:00Z"
}
Conversations
Get Conversations By Flow ID
Fetch the conversations for a specific flow.
GET
/
v1
/
api
/
conversations
/
flow
/
{flowId}
Get Conversations By Flow ID
curl --request GET \
--url https://api.trillet.ai/v1/api/conversations/flow/{flowId} \
--header 'x-api-key: <api-key>' \
--header 'x-workspace-id: <x-workspace-id>'import requests
url = "https://api.trillet.ai/v1/api/conversations/flow/{flowId}"
headers = {
"x-api-key": "<api-key>",
"x-workspace-id": "<x-workspace-id>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-api-key': '<api-key>', 'x-workspace-id': '<x-workspace-id>'}
};
fetch('https://api.trillet.ai/v1/api/conversations/flow/{flowId}', 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.trillet.ai/v1/api/conversations/flow/{flowId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>",
"x-workspace-id: <x-workspace-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.trillet.ai/v1/api/conversations/flow/{flowId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-workspace-id", "<x-workspace-id>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.trillet.ai/v1/api/conversations/flow/{flowId}")
.header("x-api-key", "<api-key>")
.header("x-workspace-id", "<x-workspace-id>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trillet.ai/v1/api/conversations/flow/{flowId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-workspace-id"] = '<x-workspace-id>'
response = http.request(request)
puts response.read_body{
"_id": "112ec528bf7946a12ab0fs21",
"userId": "60d9e3c2f42e4d03800e01a5",
"pathwayId": "pw12345",
"agentId": "ag67890",
"customer": {
"name": "Test Customer Name",
"email": "customer@example.com",
"phone": "+123456789"
},
"messages": [
{
"direction": "outbound",
"sent": true,
"message": "Thank you for your feedback!",
"status": "approved",
"_id": "675c8e368824aa5f130b94d3",
"createdAt": "2024-12-01T08:45:00Z",
"updatedAt": "2024-12-01T09:00:00Z"
},
{
"direction": "inbound",
"sent": true,
"message": "No worries!",
"status": "received",
"_id": "675c8e368824aa5f130b94d3",
"createdAt": "2024-12-01T08:55:00Z",
"updatedAt": "2024-12-01T09:00:00Z"
}
],
"createdAt": "2024-12-01T08:45:00Z",
"updatedAt": "2024-12-03T12:30:00Z"
}
Headers
string
required
API key used for authenticating requests to the API.
string
required
Workspace identifier for the API.
Path Parameters
string
required
The unique identifier of the message flow.
Response Fields
The response body will contain an array of the following fields:string
The unique identifier for the conversation.
string
The unique identifier for the user associated with the conversation.
string
The unique identifier for the flow associated with the conversation.
string
The unique identifier for the agent handling the conversation.
object
array
An array of messages exchanged in the conversation.
Show Message Details
Show Message Details
string
The direction of the message (e.g., “outbound” or “inbound”).
boolean
Indicates whether the message was sent successfully.
string
The content of the message.
string
The status of the message (e.g., “approved”, “received”).
string
The unique identifier for the message.
string
Timestamp when the message was created.
string
Timestamp when the message was last updated.
string
Timestamp when the conversation was created.
string
Timestamp when the conversation was last updated.
{
"_id": "112ec528bf7946a12ab0fs21",
"userId": "60d9e3c2f42e4d03800e01a5",
"pathwayId": "pw12345",
"agentId": "ag67890",
"customer": {
"name": "Test Customer Name",
"email": "customer@example.com",
"phone": "+123456789"
},
"messages": [
{
"direction": "outbound",
"sent": true,
"message": "Thank you for your feedback!",
"status": "approved",
"_id": "675c8e368824aa5f130b94d3",
"createdAt": "2024-12-01T08:45:00Z",
"updatedAt": "2024-12-01T09:00:00Z"
},
{
"direction": "inbound",
"sent": true,
"message": "No worries!",
"status": "received",
"_id": "675c8e368824aa5f130b94d3",
"createdAt": "2024-12-01T08:55:00Z",
"updatedAt": "2024-12-01T09:00:00Z"
}
],
"createdAt": "2024-12-01T08:45:00Z",
"updatedAt": "2024-12-03T12:30:00Z"
}
⌘I