PlanPlain API Reference

// analyze-plan.js — Node.js 18+ (native fetch)
const fs = require('fs');

async function analyzePlan(planFilePath) {
  const planJson = JSON.parse(fs.readFileSync(planFilePath, 'utf8'));

  const response = await fetch('https://planplain.polsia.app/api/analyze', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${process.env.PLANPLAIN_API_KEY}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify(planJson),
  });

  if (!response.ok) {
    const err = await response.json();
    throw new Error(`PlanPlain error: ${err.message}`);
  }

  const { analysis, metadata } = await response.json();

  console.log('Summary:', analysis.summary);
  console.log('Risk level:', metadata.max_risk_level);
  console.log('Risk flags:', analysis.risk_flags.length);

  // Post pr_markdown as a GitHub PR comment (example)
  return analysis.pr_markdown;
}

analyzePlan('./plan.json')
  .then(markdown => console.log(markdown))
  .catch(console.error);

interface RiskFlag {
  severity: 'HIGH' | 'MED' | 'LOW';
  resource: string;
  message: string;
}

interface PlanPlainResponse {
  success: boolean;
  analysis: {
    summary: string;
    risk_flags: RiskFlag[];
    reviewer_checklist: string[];
    pr_markdown: string;
  };
  metadata: {
    resources_total: number;
    resources_created: number;
    resources_updated: number;
    resources_destroyed: number;
    max_risk_level: string;
    processing_time_ms: number;
  };
}

async function analyzePlan(planJson: object): Promise<PlanPlainResponse> {
  const res = await fetch('https://planplain.polsia.app/api/analyze', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${process.env.PLANPLAIN_API_KEY}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify(planJson),
  });
  if (!res.ok) throw new Error(`HTTP ${res.status}`);
  return res.json() as Promise<PlanPlainResponse>;
}

# analyze_plan.py — Python 3.7+ (no extra dependencies)
import json
import os
import urllib.request

def analyze_plan(plan_file_path: str) -> dict:
    # Load the plan JSON
    with open(plan_file_path) as f:
        plan_json = json.load(f)

    api_key = os.environ["PLANPLAIN_API_KEY"]
    url = "https://planplain.polsia.app/api/analyze"

    req = urllib.request.Request(
        url,
        data=json.dumps(plan_json).encode(),
        headers={
            "Authorization": f"Bearer {api_key}",
            "Content-Type": "application/json",
        },
        method="POST",
    )

    with urllib.request.urlopen(req) as response:
        result = json.loads(response.read())

    return result

# Usage
result = analyze_plan("plan.json")
analysis = result["analysis"]

print(f"Summary: {analysis['summary']}")
print(f"Risk flags: {len(analysis['risk_flags'])}")

for flag in analysis["risk_flags"]:
    print(f"  [{flag['severity']}] {flag['resource']}: {flag['message']}")

print("\nPR Markdown:")
print(analysis["pr_markdown"])

import requests
import json, os

with open("plan.json") as f:
    plan = json.load(f)

response = requests.post(
    "https://planplain.polsia.app/api/analyze",
    headers={"Authorization": f"Bearer {os.environ['PLANPLAIN_API_KEY']}"},
    json=plan,
    timeout=60,
)
response.raise_for_status()

data = response.json()
print(data["analysis"]["pr_markdown"])