Skip to content

Rule Overrides Snapshot

GET
/api/agents/learning/rule-overrides/{project_id}

Return every active pin/hide override for the project.

Keyed by rule_id rather than (agent, rule_id) because pins apply project-wide; the same rule pinned under any agent shows up once. "hide" wins when two agents conflict on the same rule.

project_id
required
Project Id
string

Successful Response

RuleOverridesSnapshotResponse

GET /api/agents/learning/rule-overrides/{project_id}.

Returns every active pin/hide override for the project, keyed by rule_id. "hide" wins when the same rule is pinned under two agents in the same project — see :func:UAL.rule_overrides_snapshot.

object
projectId
required
Projectid
string
overrides
required
Overrides
Array<object>
RuleOverrideRecord

One pinned rule entry in the project-wide overrides snapshot.

object
ruleId
required
Ruleid
string
action
required
Action
string
Allowed values: show hide
total
required
Total
integer

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