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.",
"inputSchema": {},
"outputSchema": {},
"isEnabled": true,
"createdAt": "2026-06-14T09:22:40.000Z",
"updatedAt": "2026-06-14T09:22:40.000Z"
}
}{
"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>"
}
]
}Create a playbook
Creates a new playbook for the agent with a name and description, plus optional input and output schemas. After creating it, define its steps with the playbook graph endpoint.
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.",
"inputSchema": {},
"outputSchema": {},
"isEnabled": true,
"createdAt": "2026-06-14T09:22:40.000Z",
"updatedAt": "2026-06-14T09:22:40.000Z"
}
}{
"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
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.
- Token URL
- /api/v1/api-keys
Path Parameters
The agent this resource is scoped to (the UUID returned by createAgent / listAgents).
Body
Short human name shown in the builder (e.g. "Book a service visit").
Plain-language summary of what the playbook gathers and does — this is what the agent reads to decide when to run it.
Optional JSON-Schema describing values the playbook may ALREADY HAVE when it starts — pre-seeded context, not questions. Send {} in almost every case. Do NOT declare the values the playbook collects here. The steps it asks for are gathered turn by turn by the runtime from what the caller says; declaring them in this schema does not make them get collected and is not required for the playbook to work. Author the questions as collect steps in the graph (putPlaybookGraph) — that is the only place they belong. Use it only for a value supplied by whatever STARTS the playbook rather than by the conversation (for example an account id carried in from an earlier step). Free-form.
Optional JSON-Schema describing the values the playbook produces for later steps. Free-form; send {} when unused.