Skip to main content
GET
/
agents
/
{agentId}
/
convos
/
{convoId}
/
export
Export Single Conversation
curl --request GET \
  --url https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/convos/{convoId}/export \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "<string>",
  "data": {}
}

Example Response

{
  "success": true,
  "message": "Conversation exported successfully",
  "data": {
    "metadata": {
      "feedback": "Positive",
      "convo": {
        "id": "convo123",
        "userName": "John Doe",
        "userEmail": "[email protected]",
        "origin": "web"
      },
      "sessions": []
    },
    "turns": [
      {
        "from": "user",
        "messages": [
          {
            "type": "text",
            "ts": "December 1st 2024, 10:30:00 am",
            "payload": {
              "message": "Hello!",
              "feedback": "Unset",
              "aiGenerated": false
            }
          }
        ]
      },
      {
        "from": "bot",
        "messages": [
          {
            "type": "text",
            "ts": "December 1st 2024, 10:30:02 am",
            "payload": {
              "message": "Hi! How can I help you today?",
              "feedback": "Positive",
              "aiGenerated": true
            }
          }
        ]
      }
    ]
  }
}

Notes

  • The conversation must belong to the specified agent
  • Includes full turn history with timestamps
  • Feedback status indicates user feedback on each message

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agentId
string
required

The unique identifier of the agent

convoId
string
required

The unique identifier of the conversation

Query Parameters

format
enum<string>
default:json

Export format (json or csv)

Available options:
json,
csv

Response

Conversation exported successfully

success
boolean
required
message
string
required
data
object

Exported conversation data including turns and metadata