Skip to content
Wazapin
Esc
↑↓navigate↵open⌘Jpreview

Validate Playbook Draft and return Plan preview

POST/v1/ai/agents/{agentID}/playbooks/{playbookID}/validate
Authorization
sessionsessionrequired
Path parameters
agentIDstringrequired
playbookIDstringrequired
Responses
200OK
compiler_versionstringrequired
draftDraftrequired
Show properties
agent_idstringrequired
authoring_sourceAuthoringSourcerequired
Show properties
documentAuthoringDocumentrequired
Show properties
jsonany
textstring
typestringrequired
execution_modestringrequired
guardrailsany[] | null
legacyobject
outcomeAuthoringOutcomerequired
Show properties
goalstringrequired
terminal_outcomesstring[] | nullrequired
schema_versioninteger<int64>required
settingsAuthoringSettingsrequired
Show properties
max_playbook_call_depthinteger<int64>required
max_retries_per_stepinteger<int64>required
max_stepsinteger<int64>required
success_checksany[] | null
triggerAuthoringTriggerrequired
Show properties
conditionsobject[] | nullrequired
examplesstring[] | nullrequired
created_atstringrequired
descriptionstring
last_validationany
namestring
organization_idstringrequired
plain_instructionsstringrequired
playbook_idstringrequired
revisioninteger<int64>required
schema_versioninteger<int64>required
source_hashstringrequired
statusstring
updated_atstringrequired
identityArtifactIdentityrequired
Show properties
compiler_versionstringrequired
deployment_idstring
plan_hashstringrequired
plan_step_idstring
playbook_idstringrequired
playbook_release_idstring
playbook_version_idstring
source_hashstringrequired
source_node_idstring
planPlanrequired
Show properties
compiler_versionstringrequired
entry_step_idstringrequired
execution_modestringrequired
inputsobject[] | null
resource_grantsResourceGrant[] | nullrequired
Show properties
Array of ResourceGrant
kindstringrequired
labelstring
permissionstringrequired
resource_idstringrequired
schema_versioninteger<int64>required
settingsAuthoringSettingsrequired
Show properties
max_playbook_call_depthinteger<int64>required
max_retries_per_stepinteger<int64>required
max_stepsinteger<int64>required
source_hashstringrequired
stepsPlanStep[] | nullrequired
Show properties
Array of PlanStep
branchesobject
configobject
idstringrequired
kindstringrequired
nextstring
source_node_idstring
terminal_outcomesstring[] | nullrequired
plan_hashstringrequired
referencesReference[] | nullrequired
Show properties
Array of Reference
kindstringrequired
label_snapshotstringrequired
permissionstringrequired
resource_idstringrequired
source_node_idstringrequired
source_hashstringrequired
validationValidationReportrequired
Show properties
compiled_atstring<date-time>required
compiler_versionstringrequired
diagnosticsDiagnostic[] | nullrequired
Show properties
Array of Diagnostic
codestringrequired
messagestringrequired
pathstring
severitystringrequired
source_node_idstring
okbooleanrequired
plan_hashstring
source_hashstringrequired
400Bad Request
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
401Unauthorized
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
403Forbidden
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
404Not Found
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
422Unprocessable Entity
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
500Internal Server Error
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
Request
curl -X POST "/v1/ai/agents/string/playbooks/string/validate"
Response
{
  "compiler_version": "string",
  "draft": {
    "agent_id": "string",
    "authoring_source": {
      "document": {
        "json": "string",
        "text": "string",
        "type": "string"
      },
      "execution_mode": "string",
      "guardrails": [
        "string"
      ],
      "legacy": {},
      "outcome": {
        "goal": "string",
        "terminal_outcomes": [
          "string"
        ]
      },
      "schema_version": 0,
      "settings": {
        "max_playbook_call_depth": 0,
        "max_retries_per_step": 0,
        "max_steps": 0
      },
      "success_checks": [
        "string"
      ],
      "trigger": {
        "conditions": [
          {}
        ],
        "examples": [
          "string"
        ]
      }
    },
    "created_at": "string",
    "description": "string",
    "last_validation": "string",
    "name": "string",
    "organization_id": "string",
    "plain_instructions": "string",
    "playbook_id": "string",
    "revision": 0,
    "schema_version": 0,
    "source_hash": "string",
    "status": "string",
    "updated_at": "string"
  },
  "identity": {
    "compiler_version": "string",
    "deployment_id": "string",
    "plan_hash": "string",
    "plan_step_id": "string",
    "playbook_id": "string",
    "playbook_release_id": "string",
    "playbook_version_id": "string",
    "source_hash": "string",
    "source_node_id": "string"
  },
  "plan": {
    "compiler_version": "string",
    "entry_step_id": "string",
    "execution_mode": "string",
    "inputs": [
      {}
    ],
    "resource_grants": [
      {
        "kind": "string",
        "label": "string",
        "permission": "string",
        "resource_id": "string"
      }
    ],
    "schema_version": 0,
    "settings": {
      "max_playbook_call_depth": 0,
      "max_retries_per_step": 0,
      "max_steps": 0
    },
    "source_hash": "string",
    "steps": [
      {
        "branches": {},
        "config": {},
        "id": "string",
        "kind": "string",
        "next": "string",
        "source_node_id": "string"
      }
    ],
    "terminal_outcomes": [
      "string"
    ]
  },
  "plan_hash": "string",
  "references": [
    {
      "kind": "string",
      "label_snapshot": "string",
      "permission": "string",
      "resource_id": "string",
      "source_node_id": "string"
    }
  ],
  "source_hash": "string",
  "validation": {
    "compiled_at": "2024-01-01T00:00:00Z",
    "compiler_version": "string",
    "diagnostics": [
      {
        "code": "string",
        "message": "string",
        "path": "string",
        "severity": "string",
        "source_node_id": "string"
      }
    ],
    "ok": true,
    "plan_hash": "string",
    "source_hash": "string"
  }
}