API Reference
Complete reference for all 150+ API endpoints. Every endpoint includes request/response examples, field descriptions, and cURL commands.
Base URL
https://api.withfluxgate.comFor local development: http://localhost:8000
Authentication
All API requests require a Bearer token in the Authorization header:
curl -H "Authorization: Bearer YOUR_API_KEY" \
http://localhost:8000/api/v1/agentsCommon Error Codes
| Code | Meaning | Action |
|---|---|---|
| 200 | Success | Request completed |
| 201 | Created | Resource created |
| 400 | Bad Request | Check request body/params |
| 401 | Unauthorized | Check API key |
| 403 | Forbidden | Insufficient permissions |
| 404 | Not Found | Check resource ID |
| 429 | Rate Limited | Wait and retry |
| 500 | Server Error | Contact support |
Interactive API Docs
For interactive testing, use the Swagger UI which lets you try endpoints directly in the browser.
API Modules
Agents
CRUD operations for agent registration and configuration.
Runtime
Execute agent runs, check status, get step traces.
Tools
Register, test, and manage external tools.
Memory
Store, search, and manage agent memory.
Lifecycle
Version control, promotion, rollback, A/B testing.
Coordination
Multi-agent messaging and trust policies.
Schedules
Cron jobs and interval triggers.
Budgets
Spending limits, usage, and alerts.
Events
Event subscriptions and custom event emission.
Marketplace
Browse, install, and publish templates.
Cost
Optimization rules and savings tracking.
Governance
Safety policies and compliance rules.
RBAC
Roles, permissions, users, and API keys.
Secrets
Encrypted vault operations.
Scaling
Autoscaling rules and metrics.
Intelligence
AI analytics and quality scores.
Analytics
Dashboard metrics and timeseries data.
Audit
Audit log queries.
Chat
Chat sessions and message streaming.
Knowledge
Document upload, collections, and search.
Workflows
DAG creation and execution.
MCP
MCP server connections and tool discovery.
Prompts
Prompt template management and testing.
Billing
Plans, usage metering, and invoices.
Auth
Authentication and API key management.
Admin
Platform administration endpoints.
Providers
LLM provider configuration.
Publish
Agent publishing and embed codes.