Error
A valid request URL is required to generate request examples{
"success": true,
"data": [
{
"id": "pbk_9a2f1c7b04e34d02",
"agentId": "agt_4f9c2b7e10a24d51",
"organizationId": "org_2a1b9c",
"flowId": "flw_7c1e5a90",
"name": "Book a service visit",
"description": "Gather the problem, address, and preferred time, confirm, then file the request.",
"isEnabled": true,
"createdAt": "2026-06-01T14:03:11.000Z",
"updatedAt": "2026-06-14T09:22:40.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"totalPages": 1
}
}{
"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>"
}
]
}Playbooks
List playbooks
Returns a paginated list of the playbooks defined for an agent. A playbook is a reusable, step-by-step procedure the agent can follow during a conversation.
GET
/
agents
/
{agentId}
/
playbooks
Error
A valid request URL is required to generate request examples{
"success": true,
"data": [
{
"id": "pbk_9a2f1c7b04e34d02",
"agentId": "agt_4f9c2b7e10a24d51",
"organizationId": "org_2a1b9c",
"flowId": "flw_7c1e5a90",
"name": "Book a service visit",
"description": "Gather the problem, address, and preferred time, confirm, then file the request.",
"isEnabled": true,
"createdAt": "2026-06-01T14:03:11.000Z",
"updatedAt": "2026-06-14T09:22:40.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"totalPages": 1
}
}{
"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
playbooks:read
Read playbooks & graphs.
Path Parameters
The agent this resource is scoped to (the UUID returned by createAgent / listAgents).
Query Parameters
1-based page number for offset pagination. Defaults to 1 (the first page).
Required range:
x >= 1Page size — how many items to return per page (1–100). Defaults to 20.
Required range:
1 <= x <= 100