Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"id": "chat_7f21",
"agentId": "agt_4f9c2b7e10a24d51",
"organizationId": "org_2a1b9c",
"channel": "chat",
"status": "active",
"visitorId": "visitor_abc123",
"identityVerified": false,
"startedAt": "2026-07-13T10:45:00.000Z"
}
}{
"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
Create a chat session
Starts a new chat session with an agent and returns its ID. Send messages to the session to converse with the agent.
POST
/
chat
/
sessions
Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"id": "chat_7f21",
"agentId": "agt_4f9c2b7e10a24d51",
"organizationId": "org_2a1b9c",
"channel": "chat",
"status": "active",
"visitorId": "visitor_abc123",
"identityVerified": false,
"startedAt": "2026-07-13T10:45:00.000Z"
}
}{
"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
apiKeypublishableKey
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:write
Create chat sessions & send messages (server-side).
Body
application/json