Skip to content

Reset Agent Metrics

POST
/api/agents/metrics/reset

Reset performance metrics for one or all agents with background cleanup.

Clears accumulated performance data and resets metrics to initial state. Optionally targets a specific agent or resets all agents system-wide. Includes background task for cleaning up old metric data.

Query Parameters:

  • agent_name: Optional specific agent to reset (if omitted, resets all agents)

Returns:

  • status: Operation success indicator (success/partial)
  • message: Human-readable confirmation
  • reset_successful: Boolean indicating reset success (single agent)
  • reset_results: Dictionary of per-agent reset results (all agents)
  • all_successful: Boolean indicating all resets succeeded (all agents)

Raises:

  • HTTPException 500: For unexpected errors during metrics reset

Background Tasks:

  • Cleanup of old metric data and historical records

Example Response (Single Agent):

{
    "status": "success",
    "message": "Metrics reset for agent: lorekeeper",
    "reset_successful": true
}

Example Response (All Agents):

{
    "status": "success",
    "message": "Metrics reset for all agents",
    "reset_results": {
        "lorekeeper": true,
        "creative": true,
        "business": true
    },
    "all_successful": true
}
agent_name
Any of:
string

Successful Response

ResetMetricsResponse

Metrics reset confirmation response model.

Provides reset confirmation for individual or all agent metrics with detailed status tracking. Includes per-agent reset results for bulk operations and overall success indicators for system-wide resets.

Fields:

  • status: Reset status (success/partial/error)
  • message: Human-readable reset confirmation message
  • reset_successful: Single agent reset success (individual reset only)
  • reset_results: Per-agent reset results dictionary (all agents reset only)
  • all_successful: Overall success status (all agents reset only)

Example (Single Agent):

{
    "status": "success",
    "message": "Metrics reset for agent: lorekeeper",
    "reset_successful": true
}

Example (All Agents):

{
    "status": "success",
    "message": "Metrics reset for all agents",
    "reset_results": {
        "lorekeeper": true,
        "creative": true,
        "business": true
    },
    "all_successful": true
}
object
status
required
Status

Reset status

string
message
required
Message

Reset confirmation message

string
resetSuccessful
Any of:
boolean
resetResults
Any of:
object
key
additional properties
boolean
allSuccessful
Any of:
boolean

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object