Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"conversationId": "chat_9d02",
"visitorToken": "vt_abc123",
"transport": {
"kind": "sse"
}
}
}{
"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>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Chat
Start a widget chat session
Starts a chat session for the embeddable browser widget, authenticated with a publishable key from an allowed origin. Creates an anonymous visitor and returns the connection details; a bot-check token may be required.
POST
/
chat
/
widget
/
sessions
Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"conversationId": "chat_9d02",
"visitorToken": "vt_abc123",
"transport": {
"kind": "sse"
}
}
}{
"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>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Browser publishable key (Authorization: Bearer flowyte_pk_…), scope chat:public only — origin-allowlisted, agent-pinned, rate-limited. Used only by the embeddable chat widget; can never read tenant data. chat:public is restricted: it is grantable ONLY to a publishable key, never to a flowyte_sk_ secret key.
FlowClient Credentials
- Token URL
- /api/v1/agents/publishable-keys
Scopes1
chat:public
Open a chat session for the one pinned agent, from an allowed origin.
Headers
Browser origin; must be in the publishable key's allowed_origins.
Body
application/json