Skip to main content
GET
/
api
/
monthly
Monthly Summary
curl --request GET \
  --url https://api.example.com/api/monthly
{
  "summary": {
    "copy": "<string>",
    "structured": {},
    "provenance": {},
    "recordDateLabel": "<string>"
  },
  "copy": "<string>",
  "structured": {},
  "provenance": {},
  "recordDateLabel": "<string>",
  "agentHandoff": {
    "payload": {},
    "prompt": "<string>"
  },
  "summaryHash": "<string>",
  "generatedAt": "<string>",
  "version": "<string>"
}

​
Endpoint

GET /api/monthly
Returns a comprehensive monthly summary of market regime assessment, including structured data for product/engineering planning and natural language copy for team communication.

​
Response

​
summary
object
required
Complete monthly summary object
​
copy
string
required
Human-readable summary (convenience field, duplicates summary.copy)
​
structured
object
required
Structured assessment data (convenience field)
​
provenance
object
required
Data lineage information (convenience field)
​
recordDateLabel
string
required
Period label (convenience field)
​
agentHandoff
object
required
Data formatted for AI agent consumption
​
summaryHash
string
required
Hash of the summary content for change detection
​
generatedAt
string
required
ISO 8601 timestamp when summary was generated
​
version
string
required
API version (e.g., “v1”)

​
Example Request

curl https://your-domain.com/api/monthly

​
Example Response

{
  "summary": {
    "copy": "Market regime shows expansion characteristics with stable Treasury yields. Base rate at 4.15% suggests accommodative conditions. Yield curve normalized with 2Y-10Y spread at +10bps. Recommend normal project velocity and standard vendor commitments.",
    "structured": {
      "regime": "EXPANSION",
      "baseRate": 4.15,
      "curveSlope": 10,
      "constraints": ["NONE"],
      "recommendations": [
        "Maintain normal hiring pace",
        "Proceed with multi-quarter infrastructure investments",
        "Standard vendor contract terms acceptable"
      ]
    },
    "provenance": {
      "source": "US_TREASURY",
      "recordDate": "2026-03-02",
      "fetchedAt": "2026-03-03T10:30:00Z",
      "isLive": true
    },
    "recordDateLabel": "March 2026"
  },
  "copy": "Market regime shows expansion characteristics...",
  "structured": {
    "regime": "EXPANSION",
    "baseRate": 4.15,
    "curveSlope": 10
  },
  "provenance": {
    "source": "US_TREASURY",
    "recordDate": "2026-03-02"
  },
  "recordDateLabel": "March 2026",
  "agentHandoff": {
    "payload": {
      "assessment": { /* full assessment data */ },
      "treasury": { /* yield curve data */ },
      "sensors": [ /* sensor readings */ ],
      "macroSeries": [ /* macro indicators */ ]
    },
    "prompt": "Based on the following market regime data..."
  },
  "summaryHash": "a1b2c3d4e5f6",
  "generatedAt": "2026-03-03T10:00:00Z",
  "version": "v1"
}

​
Caching Behavior

  • Cache Duration: 1 hour (3600 seconds)
  • Runtime: Edge
  • Revalidation: 3600 seconds

​
Agent Handoff

The agentHandoff field is specifically designed for AI agents and LLM integrations:
  • payload: Complete structured data for analysis
  • prompt: Ready-to-use prompt template for regime interpretation
This enables seamless integration with Claude, GPT-4, or other LLMs for custom regime analysis.

​
Summary Hash

The summaryHash field provides a content fingerprint useful for:
  • Change detection (has the regime assessment changed?)
  • Cache invalidation in downstream systems
  • Deduplication in notification systems

​
Use Cases

  • Monthly planning meeting briefings
  • Product roadmap risk assessment
  • Budget planning constraint identification
  • AI agent integration for custom analysis
  • Automated reporting pipelines

Build docs developers (and LLMs) love

Get started for freeTalk to us