🛡️ AgentFlare Docs

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:

guard = AgentFlare(api_key="ag_...", agent_id="my-agent", backend_url="https://your-backend.com")

Authentication

All endpoints require an x-api-key header:

x-api-key: ag_your_key_here

Endpoints at a glance

MethodPathWhat it does
POST/eventsIngest an event from your agent
POST/configSet budget threshold and Slack webhook
POST/config/pauseManually pause or resume an agent
GET/agentsList all agents with 24h cost totals
GET/agents/{id}Full detail for one agent
GET/agents/{id}/hourlyHourly 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.

On this page