Update Conversation Messages
curl --request PATCH \
--url https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/convos/{convoId}/messages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"turns": [
{
"messages": [
{
"mid": "<string>",
"item": {
"type": "<string>",
"payload": {
"message": "<string>"
},
"time": 123
},
"delay": 123,
"action": "<string>",
"ts": 123,
"feedback": true,
"VGPayload": {},
"isLoading": true,
"isAIGenerated": true,
"sourceLabel": "<string>",
"placeholderImage": "<string>",
"mask": {
"messageIndex": 123,
"turnIndex": 123
}
}
],
"ts": 123,
"session_id": "<string>",
"isAIGenerated": true,
"modelId": "<string>",
"sources": [
{}
],
"langchainMessages": [
{}
]
}
],
"lgMessages": [
"<unknown>"
],
"updateConversationMetadata": true
}
'import requests
url = "https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/convos/{convoId}/messages"
payload = {
"turns": [
{
"messages": [
{
"mid": "<string>",
"item": {
"type": "<string>",
"payload": { "message": "<string>" },
"time": 123
},
"delay": 123,
"action": "<string>",
"ts": 123,
"feedback": True,
"VGPayload": {},
"isLoading": True,
"isAIGenerated": True,
"sourceLabel": "<string>",
"placeholderImage": "<string>",
"mask": {
"messageIndex": 123,
"turnIndex": 123
}
}
],
"ts": 123,
"session_id": "<string>",
"isAIGenerated": True,
"modelId": "<string>",
"sources": [{}],
"langchainMessages": [{}]
}
],
"lgMessages": ["<unknown>"],
"updateConversationMetadata": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
turns: [
{
messages: [
{
mid: '<string>',
item: {type: '<string>', payload: {message: '<string>'}, time: 123},
delay: 123,
action: '<string>',
ts: 123,
feedback: true,
VGPayload: {},
isLoading: true,
isAIGenerated: true,
sourceLabel: '<string>',
placeholderImage: '<string>',
mask: {messageIndex: 123, turnIndex: 123}
}
],
ts: 123,
session_id: '<string>',
isAIGenerated: true,
modelId: '<string>',
sources: [{}],
langchainMessages: [{}]
}
],
lgMessages: ['<unknown>'],
updateConversationMetadata: true
})
};
fetch('https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/convos/{convoId}/messages', 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://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/convos/{convoId}/messages",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'turns' => [
[
'messages' => [
[
'mid' => '<string>',
'item' => [
'type' => '<string>',
'payload' => [
'message' => '<string>'
],
'time' => 123
],
'delay' => 123,
'action' => '<string>',
'ts' => 123,
'feedback' => true,
'VGPayload' => [
],
'isLoading' => true,
'isAIGenerated' => true,
'sourceLabel' => '<string>',
'placeholderImage' => '<string>',
'mask' => [
'messageIndex' => 123,
'turnIndex' => 123
]
]
],
'ts' => 123,
'session_id' => '<string>',
'isAIGenerated' => true,
'modelId' => '<string>',
'sources' => [
[
]
],
'langchainMessages' => [
[
]
]
]
],
'lgMessages' => [
'<unknown>'
],
'updateConversationMetadata' => true
]),
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 := "https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/convos/{convoId}/messages"
payload := strings.NewReader("{\n \"turns\": [\n {\n \"messages\": [\n {\n \"mid\": \"<string>\",\n \"item\": {\n \"type\": \"<string>\",\n \"payload\": {\n \"message\": \"<string>\"\n },\n \"time\": 123\n },\n \"delay\": 123,\n \"action\": \"<string>\",\n \"ts\": 123,\n \"feedback\": true,\n \"VGPayload\": {},\n \"isLoading\": true,\n \"isAIGenerated\": true,\n \"sourceLabel\": \"<string>\",\n \"placeholderImage\": \"<string>\",\n \"mask\": {\n \"messageIndex\": 123,\n \"turnIndex\": 123\n }\n }\n ],\n \"ts\": 123,\n \"session_id\": \"<string>\",\n \"isAIGenerated\": true,\n \"modelId\": \"<string>\",\n \"sources\": [\n {}\n ],\n \"langchainMessages\": [\n {}\n ]\n }\n ],\n \"lgMessages\": [\n \"<unknown>\"\n ],\n \"updateConversationMetadata\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/convos/{convoId}/messages")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"turns\": [\n {\n \"messages\": [\n {\n \"mid\": \"<string>\",\n \"item\": {\n \"type\": \"<string>\",\n \"payload\": {\n \"message\": \"<string>\"\n },\n \"time\": 123\n },\n \"delay\": 123,\n \"action\": \"<string>\",\n \"ts\": 123,\n \"feedback\": true,\n \"VGPayload\": {},\n \"isLoading\": true,\n \"isAIGenerated\": true,\n \"sourceLabel\": \"<string>\",\n \"placeholderImage\": \"<string>\",\n \"mask\": {\n \"messageIndex\": 123,\n \"turnIndex\": 123\n }\n }\n ],\n \"ts\": 123,\n \"session_id\": \"<string>\",\n \"isAIGenerated\": true,\n \"modelId\": \"<string>\",\n \"sources\": [\n {}\n ],\n \"langchainMessages\": [\n {}\n ]\n }\n ],\n \"lgMessages\": [\n \"<unknown>\"\n ],\n \"updateConversationMetadata\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/convos/{convoId}/messages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"turns\": [\n {\n \"messages\": [\n {\n \"mid\": \"<string>\",\n \"item\": {\n \"type\": \"<string>\",\n \"payload\": {\n \"message\": \"<string>\"\n },\n \"time\": 123\n },\n \"delay\": 123,\n \"action\": \"<string>\",\n \"ts\": 123,\n \"feedback\": true,\n \"VGPayload\": {},\n \"isLoading\": true,\n \"isAIGenerated\": true,\n \"sourceLabel\": \"<string>\",\n \"placeholderImage\": \"<string>\",\n \"mask\": {\n \"messageIndex\": 123,\n \"turnIndex\": 123\n }\n }\n ],\n \"ts\": 123,\n \"session_id\": \"<string>\",\n \"isAIGenerated\": true,\n \"modelId\": \"<string>\",\n \"sources\": [\n {}\n ],\n \"langchainMessages\": [\n {}\n ]\n }\n ],\n \"lgMessages\": [\n \"<unknown>\"\n ],\n \"updateConversationMetadata\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"agentId": "<string>",
"convoId": "<string>",
"turns": [
{
"messages": [
{
"mid": "<string>",
"item": {
"type": "<string>",
"payload": {
"message": "<string>"
},
"time": 123
},
"delay": 123,
"action": "<string>",
"ts": 123,
"feedback": true,
"VGPayload": {},
"isLoading": true,
"isAIGenerated": true,
"sourceLabel": "<string>",
"placeholderImage": "<string>",
"mask": {
"messageIndex": 123,
"turnIndex": 123
},
"sendError": {
"message": "<string>",
"ts": 123
},
"replyTo": {
"messageId": "<string>",
"messageContent": "<string>",
"messageFrom": "<string>",
"messageIndex": 123,
"turnIndex": 123
}
}
],
"ts": 123,
"session_id": "<string>",
"isAIGenerated": true,
"modelId": "<string>",
"sources": [
{}
],
"langchainMessages": [
{}
]
}
],
"messagesNum": 123,
"updatedAt": 123,
"lastMessage": "<string>",
"firstMessageTS": 123,
"lastMessageTS": 123
}
}{
"message": "<string>",
"code": "<string>",
"issues": [
{
"message": "<string>"
}
]
}Conversations
Update Conversation Messages
Replaces the stored message turn history for a conversation, using the V3 endpoints.
PATCH
/
agents
/
{agentId}
/
convos
/
{convoId}
/
messages
Update Conversation Messages
curl --request PATCH \
--url https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/convos/{convoId}/messages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"turns": [
{
"messages": [
{
"mid": "<string>",
"item": {
"type": "<string>",
"payload": {
"message": "<string>"
},
"time": 123
},
"delay": 123,
"action": "<string>",
"ts": 123,
"feedback": true,
"VGPayload": {},
"isLoading": true,
"isAIGenerated": true,
"sourceLabel": "<string>",
"placeholderImage": "<string>",
"mask": {
"messageIndex": 123,
"turnIndex": 123
}
}
],
"ts": 123,
"session_id": "<string>",
"isAIGenerated": true,
"modelId": "<string>",
"sources": [
{}
],
"langchainMessages": [
{}
]
}
],
"lgMessages": [
"<unknown>"
],
"updateConversationMetadata": true
}
'import requests
url = "https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/convos/{convoId}/messages"
payload = {
"turns": [
{
"messages": [
{
"mid": "<string>",
"item": {
"type": "<string>",
"payload": { "message": "<string>" },
"time": 123
},
"delay": 123,
"action": "<string>",
"ts": 123,
"feedback": True,
"VGPayload": {},
"isLoading": True,
"isAIGenerated": True,
"sourceLabel": "<string>",
"placeholderImage": "<string>",
"mask": {
"messageIndex": 123,
"turnIndex": 123
}
}
],
"ts": 123,
"session_id": "<string>",
"isAIGenerated": True,
"modelId": "<string>",
"sources": [{}],
"langchainMessages": [{}]
}
],
"lgMessages": ["<unknown>"],
"updateConversationMetadata": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
turns: [
{
messages: [
{
mid: '<string>',
item: {type: '<string>', payload: {message: '<string>'}, time: 123},
delay: 123,
action: '<string>',
ts: 123,
feedback: true,
VGPayload: {},
isLoading: true,
isAIGenerated: true,
sourceLabel: '<string>',
placeholderImage: '<string>',
mask: {messageIndex: 123, turnIndex: 123}
}
],
ts: 123,
session_id: '<string>',
isAIGenerated: true,
modelId: '<string>',
sources: [{}],
langchainMessages: [{}]
}
],
lgMessages: ['<unknown>'],
updateConversationMetadata: true
})
};
fetch('https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/convos/{convoId}/messages', 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://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/convos/{convoId}/messages",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'turns' => [
[
'messages' => [
[
'mid' => '<string>',
'item' => [
'type' => '<string>',
'payload' => [
'message' => '<string>'
],
'time' => 123
],
'delay' => 123,
'action' => '<string>',
'ts' => 123,
'feedback' => true,
'VGPayload' => [
],
'isLoading' => true,
'isAIGenerated' => true,
'sourceLabel' => '<string>',
'placeholderImage' => '<string>',
'mask' => [
'messageIndex' => 123,
'turnIndex' => 123
]
]
],
'ts' => 123,
'session_id' => '<string>',
'isAIGenerated' => true,
'modelId' => '<string>',
'sources' => [
[
]
],
'langchainMessages' => [
[
]
]
]
],
'lgMessages' => [
'<unknown>'
],
'updateConversationMetadata' => true
]),
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 := "https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/convos/{convoId}/messages"
payload := strings.NewReader("{\n \"turns\": [\n {\n \"messages\": [\n {\n \"mid\": \"<string>\",\n \"item\": {\n \"type\": \"<string>\",\n \"payload\": {\n \"message\": \"<string>\"\n },\n \"time\": 123\n },\n \"delay\": 123,\n \"action\": \"<string>\",\n \"ts\": 123,\n \"feedback\": true,\n \"VGPayload\": {},\n \"isLoading\": true,\n \"isAIGenerated\": true,\n \"sourceLabel\": \"<string>\",\n \"placeholderImage\": \"<string>\",\n \"mask\": {\n \"messageIndex\": 123,\n \"turnIndex\": 123\n }\n }\n ],\n \"ts\": 123,\n \"session_id\": \"<string>\",\n \"isAIGenerated\": true,\n \"modelId\": \"<string>\",\n \"sources\": [\n {}\n ],\n \"langchainMessages\": [\n {}\n ]\n }\n ],\n \"lgMessages\": [\n \"<unknown>\"\n ],\n \"updateConversationMetadata\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/convos/{convoId}/messages")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"turns\": [\n {\n \"messages\": [\n {\n \"mid\": \"<string>\",\n \"item\": {\n \"type\": \"<string>\",\n \"payload\": {\n \"message\": \"<string>\"\n },\n \"time\": 123\n },\n \"delay\": 123,\n \"action\": \"<string>\",\n \"ts\": 123,\n \"feedback\": true,\n \"VGPayload\": {},\n \"isLoading\": true,\n \"isAIGenerated\": true,\n \"sourceLabel\": \"<string>\",\n \"placeholderImage\": \"<string>\",\n \"mask\": {\n \"messageIndex\": 123,\n \"turnIndex\": 123\n }\n }\n ],\n \"ts\": 123,\n \"session_id\": \"<string>\",\n \"isAIGenerated\": true,\n \"modelId\": \"<string>\",\n \"sources\": [\n {}\n ],\n \"langchainMessages\": [\n {}\n ]\n }\n ],\n \"lgMessages\": [\n \"<unknown>\"\n ],\n \"updateConversationMetadata\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/convos/{convoId}/messages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"turns\": [\n {\n \"messages\": [\n {\n \"mid\": \"<string>\",\n \"item\": {\n \"type\": \"<string>\",\n \"payload\": {\n \"message\": \"<string>\"\n },\n \"time\": 123\n },\n \"delay\": 123,\n \"action\": \"<string>\",\n \"ts\": 123,\n \"feedback\": true,\n \"VGPayload\": {},\n \"isLoading\": true,\n \"isAIGenerated\": true,\n \"sourceLabel\": \"<string>\",\n \"placeholderImage\": \"<string>\",\n \"mask\": {\n \"messageIndex\": 123,\n \"turnIndex\": 123\n }\n }\n ],\n \"ts\": 123,\n \"session_id\": \"<string>\",\n \"isAIGenerated\": true,\n \"modelId\": \"<string>\",\n \"sources\": [\n {}\n ],\n \"langchainMessages\": [\n {}\n ]\n }\n ],\n \"lgMessages\": [\n \"<unknown>\"\n ],\n \"updateConversationMetadata\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"agentId": "<string>",
"convoId": "<string>",
"turns": [
{
"messages": [
{
"mid": "<string>",
"item": {
"type": "<string>",
"payload": {
"message": "<string>"
},
"time": 123
},
"delay": 123,
"action": "<string>",
"ts": 123,
"feedback": true,
"VGPayload": {},
"isLoading": true,
"isAIGenerated": true,
"sourceLabel": "<string>",
"placeholderImage": "<string>",
"mask": {
"messageIndex": 123,
"turnIndex": 123
},
"sendError": {
"message": "<string>",
"ts": 123
},
"replyTo": {
"messageId": "<string>",
"messageContent": "<string>",
"messageFrom": "<string>",
"messageIndex": 123,
"turnIndex": 123
}
}
],
"ts": 123,
"session_id": "<string>",
"isAIGenerated": true,
"modelId": "<string>",
"sources": [
{}
],
"langchainMessages": [
{}
]
}
],
"messagesNum": 123,
"updatedAt": 123,
"lastMessage": "<string>",
"firstMessageTS": 123,
"lastMessageTS": 123
}
}{
"message": "<string>",
"code": "<string>",
"issues": [
{
"message": "<string>"
}
]
}Example Request
{
"turns": [
{
"from": "human",
"ts": 1699999999,
"messages": [
{
"from": "human",
"type": "text",
"ts": 1699999999,
"item": {
"payload": {
"message": "Hey, I need help with pricing."
}
}
}
]
}
],
"updateConversationMetadata": true
}
This replaces the current conversation turn history stored in Firestore at
voiceglow/{agentId}/convos/{convoId}/convo/JSON_STRING. It does not deliver anything to WhatsApp, Messenger, or other channels.To send a real outbound message to the customer on their original channel, use Send Message to Conversation instead.
When
updateConversationMetadata is true, the endpoint also refreshes messagesNum, lastMessage, firstMessageTS, lastMessageTS, and lastModified on the light conversation document.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
⌘I