Skip to main content

​
Base URL

All API requests should be made to: https://api.omium.ai/api/v1

​
Authentication

All API requests require authentication using an API key. Include it in the X-API-Key header or as a Bearer token. 
# Using X-API-Key header (recommended)
curl -X GET "https://api.omium.ai/api/v1/failures" \
  -H "X-API-Key: omium_xxxxx"

# Using Bearer token
curl -X GET "https://api.omium.ai/api/v1/failures" \
  -H "Authorization: Bearer omium_xxxxx"

​
Endpoints

​
List Failures

GET /failures List all detected failures for the authenticated tenant. Query Parameters:
  • limit: Maximum number of failures to return (default: 50).
  • offset: Number of failures to skip (for pagination).
  • status: Filter by failure status (open | resolved | ignored).
Response: 
{
  "items": [
    {
      "id": "fail_1",
      "execution_id": "exec_abc",
      "workflow_id": "workflow_xyz",
      "error_type": "AGENT_ERROR",
      "message": "Agent 'Researcher' failed to complete task.",
      "status": "open",
      "created_at": "2025-01-01T12:05:00Z",
      "resolved_at": null
    }
  ],
  "total": 10,
  "limit": 50,
  "offset": 0
}

​
Get Failure Details

GET /failures/{failure_id} Retrieve details of a specific failure. Path Parameters:
  • failure_id: The ID of the failure.
Response: 
{
  "id": "fail_1",
  "execution_id": "exec_abc",
  "workflow_id": "workflow_xyz",
  "error_type": "AGENT_ERROR",
  "message": "Agent 'Researcher' failed to complete task.",
  "details": {
    "agent_name": "Researcher",
    "task_id": "task_1",
    "traceback": "..."
  },
  "status": "open",
  "created_at": "2025-01-01T12:05:00Z",
  "resolved_at": null,
  "recovery_commands": [
    { "id": "rec_1", "type": "retry", "status": "pending" }
  ]
}

​
Get Failure Statistics

GET /failures/stats Retrieve aggregated statistics about failures. Response: 
{
  "total_failures": 150,
  "open_failures": 25,
  "resolved_failures": 100,
  "ignored_failures": 25,
  "failure_rate_last_30_days": 0.05
}

​
Resolve Failure

POST /failures/{failure_id}/resolve Mark a specific failure as resolved. Path Parameters:
  • failure_id: The ID of the failure to resolve.
Response: 
{
  "id": "fail_1",
  "status": "resolved",
  "resolved_at": "2025-01-01T13:00:00Z",
  "message": "Failure marked as resolved."
}