Playbooks

Fetch an archived playbook version

Returns the definition a version held: what a case pinned to it is evaluated against.

get/v1/projects/{project_id}/playbooks/{playbook_id}/versions/{version}

Request

  • Base URL: https://api.naturali.ai
  • URL: https://api.naturali.ai/v1/projects/{project_id}/playbooks/{playbook_id}/versions/{version}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.naturali.ai/authorize, token URL https://api.naturali.ai/token, scopes: mcp:access)

Path parameters

playbook_idstring required
Example:pbk_V1StGXR8Z5jdHi6B

The playbook ID

versioninteger required

The archived version number

Response

Archived playbook version

idstring
playbook_idstring
versioninteger
labelstring nullable
created_by_principal_type'user' | 'api_key' | 'agent' | 'automation' | 'approval' | 'system'

What kind of principal acted. user and api_key are authenticated callers, and the id is the user's (user_…) or the key's own (key_…), so a record names which key acted rather than its owner. agent is an agent writing under its own identity (agent_…). automation is the task engine acting on a dispatch outcome and approval an approval resolution; neither carries an id. system is the platform itself, with an id naming the mechanism (retention_sweep, zero_retention).

created_by_principal_idstring nullable

Public id of that principal: the user (user_…), or for API key auth the key itself (key_…), so the record names which key acted.

created_atstring date-time

Example response

{
  "id": "pbk_ver_V1StGXR8Z5jdHi6B",
  "playbook_id": "pbk_V1StGXR8Z5jdHi6B",
  "version": 1,
  "config": {
    "definition": {
      "nodes": [
        {
          "id": "regime",
          "title": "Tax regime",
          "inputs": [
            {
              "name": "revenue",
              "schema": {
                "type": "number"
              },
              "source": {
                "node_id": "revenue",
                "field": "output.annual_revenue"
              }
            }
          ],
          "executor": {
            "id": "dcd_V1StGXR8Z5jdHi6B"
          },
          "transformations": [
            {
              "name": "proposal",
              "format": "pdf",
              "tool": "tool_V1StGXR8Z5jdHi6B"
            }
          ]
        }
      ]
    }
  },
  "label": "restored from v2",
  "created_by_principal_type": "user",
  "created_by_principal_id": "user_V1StGXR8Z5jdHi6B"
}

Changes

No recorded changes to this operation across all 1 revision of this API.