Playbooks

List a case's exports

Returns every file rendered from the case's final nodes, newest first.

get/v1/projects/{project_id}/playbook-cases/{case_id}/exports

Request

  • Base URL: https://api.naturali.ai
  • URL: https://api.naturali.ai/v1/projects/{project_id}/playbook-cases/{case_id}/exports
  • 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

case_idstring required
Example:pbk_case_V1StGXR8Z5jdHi6B

The case ID

Query parameters

node_idstring
Example:pricing

Only the exports of this node

transformationstring
Example:proposal

Only the exports of this transformation

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 exports, newest first

totalinteger required
limitinteger required
offsetinteger required

Example response

{
  "data": [
    {
      "id": "pbk_exp_V1StGXR8Z5jdHi6B",
      "case_id": "pbk_case_V1StGXR8Z5jdHi6B",
      "node_id": "pricing",
      "transformation": "proposal",
      "format": "pdf",
      "tool_id": "tool_V1StGXR8Z5jdHi6B",
      "file_id": "file_V1StGXR8Z5jdHi6B",
      "error": {
        "code": "AI_PROVIDER_ERROR",
        "message": "Provider returned 402: insufficient credits"
      },
      "created_by_principal_type": "user",
      "created_by_principal_id": "user_V1StGXR8Z5jdHi6B",
      "on_behalf_of": {
        "tool_id": "tool_V1StGXR8Z5jdHi6B",
        "agent_id": "agent_V1StGXR8Z5jdHi6B",
        "generation_id": "gen_V1StGXR8Z5jdHi6B",
        "session_id": "sess_V1StGXR8Z5jdHi6B",
        "actor_id": "actor_V1StGXR8Z5jdHi6B"
      }
    }
  ]
}

Changes

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