Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

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.

Path Parameters

agentId
string
required

The agent this resource is scoped to (the UUID returned by createAgent / listAgents).

Body

application/json
name
string
required

Short human name shown in the builder (e.g. "Book a service visit").

description
string
required

Plain-language summary of what the playbook gathers and does — this is what the agent reads to decide when to run it.

inputSchema
object

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.

outputSchema
object

Optional JSON-Schema describing the values the playbook produces for later steps. Free-form; send {} when unused.

Response

Created playbook.

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