cURL
curl -X DELETE https://reygrid.com/api/v1/agents/{AgentId}/conversations/user_42 \
-H "Authorization: Bearer $REYGRID_API_KEY"from reygrid import ReyGrid
client = ReyGrid(api_key="YOUR_API_KEY")
res = client.delete_conversation("{AgentId}", "user_42")
print(res.deletedMessages.count)import { ReyGrid } from "reygrid";
const client = new ReyGrid({ apiKey: "YOUR_API_KEY" });
const { deletedMessages } = await client.deleteConversation("{AgentId}", "user_42");
console.log(deletedMessages.count);{
"success": true,
"deletedMessages": {
"count": 14
}
}{
"error": "Unauthorized",
"code": "AUTH_REQUIRED"
}{
"success": false,
"error": {
"code": "CONVERSATION_NOT_FOUND",
"message": "This conversation does not exist"
}
}Conversations
Delete a conversation
Deletes all messages belonging to a conversation.
conversationRef can be either a conversationId or a persistent userId.
DELETE
/
agents
/
{agentId}
/
conversations
/
{conversationRef}
cURL
curl -X DELETE https://reygrid.com/api/v1/agents/{AgentId}/conversations/user_42 \
-H "Authorization: Bearer $REYGRID_API_KEY"from reygrid import ReyGrid
client = ReyGrid(api_key="YOUR_API_KEY")
res = client.delete_conversation("{AgentId}", "user_42")
print(res.deletedMessages.count)import { ReyGrid } from "reygrid";
const client = new ReyGrid({ apiKey: "YOUR_API_KEY" });
const { deletedMessages } = await client.deleteConversation("{AgentId}", "user_42");
console.log(deletedMessages.count);{
"success": true,
"deletedMessages": {
"count": 14
}
}{
"error": "Unauthorized",
"code": "AUTH_REQUIRED"
}{
"success": false,
"error": {
"code": "CONVERSATION_NOT_FOUND",
"message": "This conversation does not exist"
}
}Authorizations
ReyGrid API key sent as a Bearer token.
Path Parameters
The ID of the agent.
A conversation ID or persistent user ID.