Browse documentation

Endpoint

Where burn is actually coming from

Ranks outflow categories so product and finance can agree on what to cut first.

Surface the top spend categories driving burn so cuts and negotiations line up on one list.

POST /api/v1/burn-rate-optimizer

Try in playground

What it returns

Observed monthly burn with ranked reduction opportunities by category.

Structured fields: monthly_burn_minor, reduction_opportunities[]

Extra envelope blocks: categorized outflows improve ranking

Responses always include a template-generated narrative string alongside structured — safe to show to non-technical stakeholders when you need a spoken summary.

Response shape

Every successful response includes the same top-level keys: endpoint, account_id, processing (ephemeral mode + note), structured, and narrative.

Structured subfields for this route: monthly_burn_minor, reduction_opportunities[]

Minimal example

{
  "endpoint": "burn-rate-optimizer",
  "account_id": "acct_demo_001",
  "processing": {
    "mode": "ephemeral",
    "note": "Cashytics processes this request in memory only. Your payload is not stored as a ledger of record after the response is sent."
  },
  "structured": {
    "monthly_burn_minor": 310000,
    "reduction_opportunities": [
      {
        "category": "payroll",
        "amount_minor": 95000,
        "impact_score": 31
      },
      {
        "category": "software",
        "amount_minor": 42000,
        "impact_score": 14
      }
    ]
  },
  "narrative": "Burn and levers\nMonthly burn (minor units): 310000\nTop focus: payroll (~95000 minor units)\n\nThis narrative is generated from structured signals using fixed templates."
}

Minimal curl

curl -sS -X POST "https://api.cashytics.com/api/v1/burn-rate-optimizer" \
  -H "Authorization: Bearer cyt_live_YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d @envelope.json

Use the same envelope.json for every endpoint — add optional blocks when this route requires them.

← All endpoints