Overview
The IncidentFox API provides programmatic access to:
- Trigger investigations
- Manage team configuration
- Query investigation history
- Integrate with custom workflows
Base URL
https://api.incidentfox.ai/api/v1
Authentication
All API endpoints require authentication via Bearer token.
curl -X GET https://api.incidentfox.ai/api/v1/config/me/effective \
-H "Authorization: Bearer YOUR_TEAM_TOKEN"
Token Types
| Type | Format | Scope |
|---|
| Team Token | tokid.toksecret | Team operations |
| Admin Token | admin.tokensecret | Organization admin |
| OIDC JWT | Standard JWT | SSO authenticated users |
Team tokens are issued by your organization admin. Contact them if you need API access.
{
"data": { ... },
"meta": {
"request_id": "req_abc123",
"timestamp": "2024-01-15T10:30:00Z"
}
}
Error Responses
{
"error": {
"code": "unauthorized",
"message": "Invalid or expired token",
"request_id": "req_abc123"
}
}
HTTP Status Codes
| Code | Description |
|---|
| 200 | Success |
| 400 | Bad request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not found |
| 429 | Rate limited |
| 500 | Server error |
Rate Limiting
API requests are rate limited:
| Endpoint Type | Limit |
|---|
| Read operations | 100/minute |
| Write operations | 20/minute |
| Investigation triggers | 10/minute |
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1705318260
API Categories
Quick Start
Trigger an Investigation
curl -X POST https://api.incidentfox.ai/api/v1/agents/run \
-H "Authorization: Bearer $TEAM_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"agent_name": "planner",
"message": "Investigate high latency in payments service"
}'
Get Team Configuration
curl -X GET https://api.incidentfox.ai/api/v1/config/me/effective \
-H "Authorization: Bearer $TEAM_TOKEN"
SDKs
Official SDKs are available:
- Python:
pip install incidentfox
- JavaScript:
npm install @incidentfox/sdk
Python Example
from incidentfox import IncidentFoxClient
client = IncidentFoxClient(token="YOUR_TEAM_TOKEN")
# Trigger investigation
result = client.investigate("High error rate in checkout service")
print(result.summary)
print(result.root_cause)
# Get team config
config = client.config.get_effective()
print(config.mcp_servers)
Webhooks
Configure webhooks to receive investigation results:
{
"webhooks": {
"investigation_complete": "https://your-app.com/webhooks/incidentfox"
}
}
{
"event": "investigation_complete",
"investigation_id": "inv_abc123",
"summary": "Root cause identified",
"root_cause": { ... },
"recommendations": [ ... ]
}
Next Steps
