Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "blockers": [
      {
        "rule": "action_arg_unfillable",
        "severity": "blocker",
        "nodeId": "n_submit",
        "nodeType": "skill",
        "slot": "lead_name",
        "message": "Step \"n_submit\" sends {lead_name}, but nothing before it ever produces lead_name. That field would be sent empty — collect it first, or bind it from an earlier step's result."
      }
    ],
    "warnings": [
      {
        "rule": "unreachable_step",
        "severity": "warning",
        "nodeId": "n_old_confirm",
        "nodeType": "message",
        "message": "Step \"n_old_confirm\" (message) cannot be reached from the start step, so it never runs. Connect it or remove it."
      }
    ],
    "graphStats": {
      "steps": 15,
      "connections": 25,
      "collectSteps": 9,
      "actionSteps": 2,
      "messageSteps": 2,
      "branchSteps": 0,
      "reachableSteps": 15,
      "slots": [
        "lead_address",
        "lead_bathrooms",
        "lead_bedrooms",
        "lead_dates",
        "lead_frequency",
        "lead_name",
        "lead_notes",
        "lead_service_type",
        "lead_zip"
      ]
    }
  }
}

{
  "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

Check a playbook for problems before it goes live

Statically check the playbook’s saved graph and report what would go wrong on a real call. It answers the questions a canvas cannot: can every route actually reach the end, can a caller get stuck on a question, and — the important one — could an action step fire with a value that nothing in the conversation ever filled in. Nothing is changed or executed: this reads the saved graph, so it is safe to call as often as you like. It requires only the read scope for that reason. Findings come back in two lists. blockers are defects that will break a call (no start step; a question with no way onward; an action step whose argument nothing can ever produce, which would send that field empty). warnings are worth reading but do not stop anything (a step nothing connects to; a value bound on some routes and not others; spoken text naming a variable the playbook never produces, which the caller would hear read out literally). graphStats summarises the shape of what was checked. The same checks run automatically as part of getPrePublishReport, so a blocker here also appears there. Run this after editing a graph with putPlaybookGraph and fix the blockers before publishing.

POST

agents

{agentId}

playbooks

{id}

verify

Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "blockers": [
      {
        "rule": "action_arg_unfillable",
        "severity": "blocker",
        "nodeId": "n_submit",
        "nodeType": "skill",
        "slot": "lead_name",
        "message": "Step \"n_submit\" sends {lead_name}, but nothing before it ever produces lead_name. That field would be sent empty — collect it first, or bind it from an earlier step's result."
      }
    ],
    "warnings": [
      {
        "rule": "unreachable_step",
        "severity": "warning",
        "nodeId": "n_old_confirm",
        "nodeType": "message",
        "message": "Step \"n_old_confirm\" (message) cannot be reached from the start step, so it never runs. Connect it or remove it."
      }
    ],
    "graphStats": {
      "steps": 15,
      "connections": 25,
      "collectSteps": 9,
      "actionSteps": 2,
      "messageSteps": 2,
      "branchSteps": 0,
      "reachableSteps": 15,
      "slots": [
        "lead_address",
        "lead_bathrooms",
        "lead_bedrooms",
        "lead_dates",
        "lead_frequency",
        "lead_name",
        "lead_notes",
        "lead_service_type",
        "lead_zip"
      ]
    }
  }
}

{
  "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

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).

string

required

The playbook's unique ID (the value returned by createPlaybook / listPlaybooks).

Response

The verification report. A 200 with a non-empty blockers list is the normal way a broken playbook is reported — it is not an error.

success

boolean

required

data

object

required

The result of verifyPlaybook. blockers empty means the graph passes every check the platform can make statically — it does not promise the wording is right, only that no route is broken and no action step can fire on a value nothing produces.

Show child attributes

message

string

errors

object[]

Show child attributes

Using the API

Endpoints

Check a playbook for problems before it goes live

Authorizations

Path Parameters

Response