Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"flowId": "flw_7c1e5a90",
"nodes": [
{
"id": "n_start",
"type": "start",
"position": {
"x": 0,
"y": 0
},
"data": {
"message": "Happy to book a visit — let's get a few details."
}
},
{
"id": "n_problem",
"type": "collect",
"position": {
"x": 240,
"y": 0
},
"data": {
"slot": "problem",
"prompt": "What seems to be the issue?"
}
},
{
"id": "n_file",
"type": "skill",
"position": {
"x": 480,
"y": 0
},
"data": {
"tool": "create_service_request",
"args": {
"summary": "{problem}",
"address": "{address}"
},
"output": {
"ticket_id": "id"
}
}
},
{
"id": "n_done",
"type": "end",
"position": {
"x": 720,
"y": 0
},
"data": {}
}
],
"connections": [
{
"id": "e1",
"source": "n_start",
"target": "n_problem",
"sourceHandle": "success"
},
{
"id": "e2",
"source": "n_problem",
"target": "n_file",
"sourceHandle": "success"
},
{
"id": "e3",
"source": "n_file",
"target": "n_done",
"sourceHandle": "success"
}
]
}
}{
"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
Get a playbook's steps
Returns the playbook’s step graph: the nodes and the connections between them that define the procedure the agent runs.
GET
/
agents
/
{agentId}
/
playbooks
/
{id}
/
graph
Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"flowId": "flw_7c1e5a90",
"nodes": [
{
"id": "n_start",
"type": "start",
"position": {
"x": 0,
"y": 0
},
"data": {
"message": "Happy to book a visit — let's get a few details."
}
},
{
"id": "n_problem",
"type": "collect",
"position": {
"x": 240,
"y": 0
},
"data": {
"slot": "problem",
"prompt": "What seems to be the issue?"
}
},
{
"id": "n_file",
"type": "skill",
"position": {
"x": 480,
"y": 0
},
"data": {
"tool": "create_service_request",
"args": {
"summary": "{problem}",
"address": "{address}"
},
"output": {
"ticket_id": "id"
}
}
},
{
"id": "n_done",
"type": "end",
"position": {
"x": 720,
"y": 0
},
"data": {}
}
],
"connections": [
{
"id": "e1",
"source": "n_start",
"target": "n_problem",
"sourceHandle": "success"
},
{
"id": "e2",
"source": "n_problem",
"target": "n_file",
"sourceHandle": "success"
},
{
"id": "e3",
"source": "n_file",
"target": "n_done",
"sourceHandle": "success"
}
]
}
}{
"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).
The playbook's unique ID (the value returned by createPlaybook / listPlaybooks).