Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"agentMeta": {
"name": "Riley"
},
"theme": {
"mode": "auto",
"accent": "#4f46e5",
"headerStyle": "solid",
"radius": "soft",
"position": "bottom-right",
"offset": {
"side": 20,
"bottom": 20
},
"launcher": {
"size": "standard",
"label": null
},
"font": null,
"zIndex": 2147483647,
"overrides": {}
},
"copy": {
"headerTitle": null,
"headerSubtitle": null,
"inputPlaceholder": null,
"disclaimer": null
},
"behavior": {
"poweredBy": true,
"autoOpenMs": null
},
"configVersion": 1718000000000
}
}{
"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
Get widget bootstrap config
Returns the public configuration for the browser widget (theme, copy, and behavior) for a given publishable key. It contains no secrets and is safe to call from the browser, but the request’s origin must be allowed for the key.
GET
/
widget
/
bootstrap
Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"agentMeta": {
"name": "Riley"
},
"theme": {
"mode": "auto",
"accent": "#4f46e5",
"headerStyle": "solid",
"radius": "soft",
"position": "bottom-right",
"offset": {
"side": 20,
"bottom": 20
},
"launcher": {
"size": "standard",
"label": null
},
"font": null,
"zIndex": 2147483647,
"overrides": {}
},
"copy": {
"headerTitle": null,
"headerSubtitle": null,
"inputPlaceholder": null,
"disclaimer": null
},
"behavior": {
"poweredBy": true,
"autoOpenMs": null
},
"configVersion": 1718000000000
}
}{
"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.
Query Parameters
A publishable key (flowyte_pk_…); Origin-checked. Provide key OR pk.
Alias for key — a publishable key (flowyte_pk_…). Provide key OR pk.