Playbooks

List playbooks

Returns the playbooks defined in a project, newest first.

get/v1/projects/{project_id}/playbooks

Request

  • Base URL: https://api.naturali.ai
  • URL: https://api.naturali.ai/v1/projects/{project_id}/playbooks
  • 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)

Query parameters

limitinteger

Results per page, 1 to 100 (default 50). Above 100 it is clamped; below 1 or not an integer it is 400.

offsetinteger

Results to skip. Negative or not an integer it is 400.

Response

List of playbooks

totalinteger required
limitinteger required
offsetinteger required

Example response

{
  "data": [
    {
      "id": "pbk_V1StGXR8Z5jdHi6B",
      "project_id": "proj_V1StGXR8Z5jdHi6B",
      "name": "client-pricing",
      "version": 1,
      "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"
              }
            ]
          }
        ]
      }
    }
  ]
}

Changes

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