Skip to main content
GET
/
v1
/
chat
List chats
curl --request GET \
  --url https://api.roark.ai/v1/chat \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "660e8400-e29b-41d4-a716-446655440001",
      "organizationId": "770e8400-e29b-41d4-a716-446655440002",
      "startTimestamp": "2024-01-15T10:00:00Z",
      "endTimestamp": "2024-01-15T10:30:00Z",
      "durationMs": 1800000,
      "title": "Account assistance request",
      "summary": "Customer inquired about account balance and recent transactions",
      "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"
      ]
    }
  ],
  "pagination": {
    "total": 123,
    "hasMore": true,
    "nextCursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:20

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

Required range: 1 <= x <= 100
Example:

20

​
after
string

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

Example:

"eyJzb3J0VmFsdWUiOiIyMDI1LTAxLTE1VDEwOjAwOjAwLjAwMDAwMFoiLCJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"

​
sortBy
enum<string>
default:createdAt

Field to sort by (default: createdAt)

Available options:
createdAt,
startTimestamp,
endTimestamp,
duration,
title
Example:

"createdAt"

​
sortDirection
enum<string>
default:desc

Sort direction (default: desc)

Available options:
asc,
desc
Example:

"desc"

​
searchText
string

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

Example:

"account balance"

​
simulationRunPlanJobId
string<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

​
data
ChatResponse · object[]
required
​
pagination
object
required