Error
A valid request URL is required to generate request examples{
"success": true,
"data": [
{
"id": "msg_1",
"sessionId": "chat_7f21",
"seq": 1,
"role": "user",
"content": "Do you service heat pumps?",
"contentType": "text",
"createdAt": "2026-07-13T10:45:10.000Z"
},
{
"id": "msg_2",
"sessionId": "chat_7f21",
"seq": 2,
"role": "agent",
"content": "Yes — we service heat pumps 7 days a week. Want to book a visit?",
"contentType": "markdown",
"quickReplies": [
"Book a visit",
"Ask another question"
],
"createdAt": "2026-07-13T10:45:12.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 2,
"totalPages": 1
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Chat
List chat messages
Returns the paginated message history for a chat session.
GET
/
chat
/
sessions
/
{id}
/
messages
Error
A valid request URL is required to generate request examples{
"success": true,
"data": [
{
"id": "msg_1",
"sessionId": "chat_7f21",
"seq": 1,
"role": "user",
"content": "Do you service heat pumps?",
"contentType": "text",
"createdAt": "2026-07-13T10:45:10.000Z"
},
{
"id": "msg_2",
"sessionId": "chat_7f21",
"seq": 2,
"role": "agent",
"content": "Yes — we service heat pumps 7 days a week. Want to book a visit?",
"contentType": "markdown",
"quickReplies": [
"Book a visit",
"Ask another question"
],
"createdAt": "2026-07-13T10:45:12.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 2,
"totalPages": 1
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.
FlowClient Credentials
- Token URL
- /api/v1/api-keys
Scopes1
chat:read
Read chat sessions & messages.
Path Parameters
The chat session id (from createChatSession).
Query Parameters
1-based page number for offset pagination. Defaults to 1 (the first page).
Required range:
x >= 1Page size — how many items to return per page (1–100). Defaults to 20.
Required range:
1 <= x <= 100