Skip to main content
POST
/
chat
/
widget
/
sessions
Error
A valid request URL is required to generate request examples
{
  "success": true,
  "data": {
    "conversationId": "<string>",
    "visitorToken": "<string>",
    "transport": {
      "kind": "realtime",
      "url": "<string>",
      "token": "<string>"
    }
  },
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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.

Headers

​
Origin
string
required

Browser origin; must be in the publishable key's allowed_origins.

Body

application/json
​
turnstileToken
string
​
identityToken
string

Response

Widget conversation + transport.

​
success
boolean
required
​
data
object
required
​
message
string
​
errors
object[]