Sign in
Chat

List chats

Returns a paginated list of chats for the authenticated project.

get/v1/chat

Query parameters

limitinteger

Maximum number of chats to return (default: 20, max: 100)

Example:20
afterstring

Cursor for pagination - use the nextCursor value from a previous response

Example:eyJzb3J0VmFsdWUiOiIyMDI1LTAxLTE1VDEwOjAwOjAwLjAwMDAwMFoiLCJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9
sortBy'createdAt' | 'startTimestamp' | 'endTimestamp' | 'duration' | 'title'

Field to sort by (default: createdAt)

Example:createdAt
sortDirection'asc' | 'desc'

Sort direction (default: desc)

Example:desc
searchTextstring

Search text to filter chats by id, title, summary, message text, or note content

Example:account balance
simulationRunPlanJobIdstring uuid

Filter by simulation run plan job ID to get all chats from a specific simulation batch

Example:550e8400-e29b-41d4-a716-446655440000

Response

List of chats

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "660e8400-e29b-41d4-a716-446655440001",
      "organizationId": "770e8400-e29b-41d4-a716-446655440002",
      "title": "Account assistance request",
      "summary": "Customer inquired about account balance and recent transactions",
      "startTimestamp": "2024-01-15T10:00:00Z",
      "endTimestamp": "2024-01-15T10:30:00Z",
      "durationMs": 1800000,
      "createdAt": "2024-01-15T10:31:00Z",
      "updatedAt": "2024-01-15T10:31:00Z",
      "simulationJobId": "880e8400-e29b-41d4-a716-446655440003",
      "simulationRunPlanJobId": "990e8400-e29b-41d4-a716-446655440004",
      "agents": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "customers": [
        {
          "phoneNumberE164": null,
          "label": "web-visitor-abc123"
        }
      ],
      "properties": {
        "source": "web",
        "region": "US"
      },
      "policyIds": [
        "550e8400-e29b-41d4-a716-446655440000"
      ],
      "externalId": "session-abc-123"
    }
  ]
}

Changes