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

List published Playbook Versions

GET/v1/ai/agents/{agentID}/playbooks/{playbookID}/versions
Authorization
sessionsessionrequired
Path parameters
agentIDstringrequired
playbookIDstringrequired
Responses
200OK
itemsVersionArtifact[] | nullrequired
Show properties
Array of VersionArtifact
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
compiled_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
compiler_versionstringrequired
eval_policyany
notesstring
organization_idstringrequired
plan_hashstringrequired
playbook_idstringrequired
playbook_version_idstringrequired
published_atstringrequired
published_bystring
resource_manifestResourceGrant[] | nullrequired
Show properties
Array of ResourceGrant
kindstringrequired
labelstring
permissionstringrequired
resource_idstringrequired
schema_versioninteger<int64>required
source_hashstringrequired
validation_reportValidationReportrequired
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
version_numberinteger<int32>
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 GET "/v1/ai/agents/string/playbooks/string/versions"
Response
{
  "items": [
    {
      "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"
          ]
        }
      },
      "compiled_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"
        ]
      },
      "compiler_version": "string",
      "eval_policy": "string",
      "notes": "string",
      "organization_id": "string",
      "plan_hash": "string",
      "playbook_id": "string",
      "playbook_version_id": "string",
      "published_at": "string",
      "published_by": "string",
      "resource_manifest": [
        {
          "kind": "string",
          "label": "string",
          "permission": "string",
          "resource_id": "string"
        }
      ],
      "schema_version": 0,
      "source_hash": "string",
      "validation_report": {
        "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"
      },
      "version_number": 0
    }
  ]
}