API Overview
The AgentFlare REST API — all endpoints at a glance.
Base URL
The SDK points to the AgentFlare backend automatically — you don't need to configure anything.
If you're self-hosting, pass backend_url when initializing:
Authentication
All endpoints require an x-api-key header:
Endpoints at a glance
| Method | Path | What it does |
|---|---|---|
POST | /events | Ingest an event from your agent |
POST | /config | Set budget threshold and Slack webhook |
POST | /config/pause | Manually pause or resume an agent |
GET | /agents | List all agents with 24h cost totals |
GET | /agents/{id} | Full detail for one agent |
GET | /agents/{id}/hourly | Hourly cost buckets (last 24h) |
Interactive docs
The backend exposes a live Swagger UI — check the link in your dashboard settings or append /docs to your backend URL.