Agents Health
API endpoints for Agents Health
/api/agents/{agent_id}/health Health checks all integration health for an agent.
For each configured capability (storage, embedding, LLM), calls the provider's <Cap>Health() method which verifies reachability without exercising the full pipeline. Persists the results to the agent's health_status, healthy, and health_checked_at fields and returns the unified health response.
Response Codes
| Status Code | Description |
|---|---|
| 200 | Success |
| 404 | Resource not found |
| 500 | Internal server error |
Success
Response response.AgentHealth
Agent Health
| Property | Type | Description |
|---|---|---|
| healthy | boolean | Whether all health checks passed |
| checks | any | Map of capability name to health check result |
| checked_at | string (date-time) | Timestamp when health checks were performed |
/api/agents/{agent_id}/health/test Test exercises all integration pipelines end-to-end for an agent.
For each configured capability (storage, embedding, LLM), calls the provider's <Cap>Test() method which performs a full round-trip verification (e.g. embed a test string, send a minimal prompt). Persists the results to the agent's health_status, healthy, and health_checked_at fields and returns the unified health response.
Response Codes
| Status Code | Description |
|---|---|
| 200 | Success |
| 404 | Resource not found |
| 500 | Internal server error |
Success
Response response.AgentHealth
Agent Health
| Property | Type | Description |
|---|---|---|
| healthy | boolean | Whether all health checks passed |
| checks | any | Map of capability name to health check result |
| checked_at | string (date-time) | Timestamp when health checks were performed |