Get a chat by ID

Retrieve an existing chat by its unique identifier

GET /v1/chat/{id}

Get a chat by ID

cURL

curl --request GET \
  --url https://api.roark.ai/v1/chat/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "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"
    ],
    "externalId": "session-abc-123"
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string<uuid> · required

Response

200

application/json

Chat retrieved successfully

data · ChatResponse · object · required

Response containing the chat information

Show child attributes