Skip to main content
GET
/
agents
/
{agentId}
/
playbooks
/
{id}
Error
A valid request URL is required to generate request examples
{
  "success": true,
  "data": {
    "id": "<string>",
    "agentId": "<string>",
    "organizationId": "<string>",
    "flowId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "inputSchema": {},
    "outputSchema": {},
    "isEnabled": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

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
​
id
string
required

Response

The playbook.

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