Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"scriptSnippet": "<script async src=\"https://builder.flowyte.com/widget/v1/loader.js\" data-pk=\"flowyte_pk_live_abc_123\"></script>",
"publishableKey": "flowyte_pk_live_abc_123"
}
}{
"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>"
}
]
}Widget
Get the widget embed snippet
Returns the HTML snippet for embedding the chat widget on your site, along with a publishable key. Optionally specify which publishable key to include.
GET
/
agents
/
{agentId}
/
widget
/
embed
Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"scriptSnippet": "<script async src=\"https://builder.flowyte.com/widget/v1/loader.js\" data-pk=\"flowyte_pk_live_abc_123\"></script>",
"publishableKey": "flowyte_pk_live_abc_123"
}
}{
"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
widgets:read
Read widget config & embed snippet.
Path Parameters
The agent this resource is scoped to (the UUID returned by createAgent / listAgents).
Query Parameters
Pin the embed to a specific publishable key id (default = the newest active key).