Skip to content

API.md

Latest commit

 

History

History
78 lines (67 loc) · 1.49 KB

API.md

File metadata and controls

78 lines (67 loc) · 1.49 KB

API Documentation

/api/summary

Generates an executive summary of the user's stack audit.

  • Method: POST
  • Content-Type: application/json

Request Payload

{
  "report": {
    "teamSize": 15,
    "totalSpend": 1200,
    "monthlyWaste": 300,
    "score": 75,
    "recommendations": [
      {
        "id": "overlap-llm",
        "title": "LLM Overlap Detected",
        "description": "Consolidate ChatGPT and Claude.",
        "savings": 20
      }
    ]
  }
}

Response (Success - AI Generated)

{
  "summary": "Based on your team of 15, your current spend of $1,200 has an optimization potential of $300...",
  "source": "ai",
  "prompt": "..."
}

Response (Fallback - Deterministic)

Returned gracefully if the AI provider limits the request.

{
  "summary": "Your stack audit is complete. We identified 1 overlapping tools and $300 in estimated monthly waste.",
  "source": "fallback",
  "prompt": "..."
}

/api/leads

Captures user email addresses for future optimizations and sends a transactional confirmation.

  • Method: POST
  • Content-Type: application/json

Request Payload

{
  "email": "user@example.com",
  "reportId": "uuid-string-here",
  "a_password": "" 
}

Note: a_password is a honeypot field. If populated, the server will silently discard the request to prevent bot spam.

Response (Success)

{
  "success": true
}

Response (Error)

{
  "error": "Invalid email address"
}