POpoll-the-people
Conversations

Export conversation.

Changed on

Exports the complete conversation history (all prompts and agent responses) as a downloadable file. Use this to archive conversations, share transcripts, or analyze conversation content offline. The file format is selected by the format query parameter.

get/api/v1/projects/{projectId}/conversations/{sessionId}/export

Request

Path parameters

projectIdinteger required
Example:1

The ID of the agent to get the messages for

sessionIdstring required
Example:1

The session ID of the converstaions to get the messages for

Query parameters

format'json' | 'excel' | 'csv' | 'pdf'
Example:csv

Export file format.

isCustomRowsNumberstring

Set to true to limit the export to a specific number of rows defined by the rowsNumber parameter. When false (default), all matching conversations are exported.

rowsNumberinteger
Example:1

The maximum number of rows to include in the export. Must be a positive integer (minimum: 1). Only applied when isCustomRowsNumber is true.

startDatestring date

Start date for filtering exported conversations. Format: YYYY-MM-DD (e.g., 2024-01-15). Conversations created on or after this date are included. Omit to include all conversations up to endDate.

endDatestring date

End date for filtering exported conversations. Format: YYYY-MM-DD (e.g., 2024-03-31). Conversations created on or before this date are included. Omit to include all conversations from startDate onward.

Response

Export a conversation as a downloadable file

Changes