v1

latestOpenAPI 3.0.32026-07-24106305257.4 KB
Chats Export

Get chat logs

get/agents/chats/exports/{id}

Path parameters

idstring required

Export Id

Response

OK

agent_idstring required

The id of the agent that the export will run for

fromstring

The start of the time range for the export. If not provided, the export will start from the beginning of the agent's data

tostring

The end of the time range for the export. If not provided, the export will run until the current time

persistent_chatsboolean

Determines if the export should fetch persistent chats. Defaults to true.

created_bystring required

Who created the export

created_atstring required

When the export was created

status'created' | 'started' | 'done' | 'partial' | 'error' required
completed_atstring

When the export was completed

errorstring

Error message if the export failed. Known errors include: 'No chats found', 'No chats found in range', 'All chats in dates range have been exported'

total_files_countnumber double

The total amount of the files in the export

total_files_sizenumber double

The total size of the files in the export

export_idstring required
owner_idstring required
modifiedstring required

Example response

{
  "from": "2024-05-15T12:00:00Z",
  "to": "2024-05-15T12:00:00Z"
}