API Reference

Getting Started

The Xynapse AI API allows you to programmatically access cost data, recommendations, and alerts. All API access requires authentication via API keys.

Base URL

https://api.xynapse.ai/v1

Authentication

Include your API key in the Authorization header of every request:

Authorization: Bearer YOUR_API_KEY

Core Endpoints

Cost Data

• GET /costs/summary - Get cost summary for a date range
• GET /costs/breakdown - Get detailed cost breakdown by service
• GET /costs/forecast - Get cost forecast for next 30/60/90 days

Recommendations

• GET /recommendations - List all optimization recommendations
• GET /recommendations/:id - Get details for a specific recommendation
• POST /recommendations/:id/apply - Apply a recommendation
• POST /recommendations/:id/dismiss - Dismiss a recommendation

Alerts

• GET /alerts - List all alerts
• POST /alerts - Create a new alert
• PUT /alerts/:id - Update an alert
• DELETE /alerts/:id - Delete an alert

Reports

• GET /reports - List all reports
• POST /reports/generate - Generate a new report
• GET /reports/:id/download - Download a report

Rate Limits

API requests are rate limited based on your plan:

• Starter: 60 requests/minute, 10,000 requests/day
• Professional: 300 requests/minute, 100,000 requests/day
• Enterprise: Unlimited

SDKs & Libraries

Official SDKs are available for popular programming languages:

• Python - pip install xynapse-ai
• Node.js - npm install @xynapse/sdk
• Go - go get github.com/xynapse/go-sdk
• Ruby - gem install xynapse