Sign in
Feature Readiness

Override enabled flag or params for an agent

Admin endpoint to force-enable, force-disable, or tune an agent's params.

Setting enabled=False greys out the feature in the UI regardless of data readiness. Setting enabled=True forces it active even if the data thresholds are not yet met (use with caution — results may be noisy).

patch/api/v1/features/readiness/{agent_name}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

agent_namestring required

Headers

X-API-Keystring nullable

Request body

enabledboolean nullable

Override readiness: True forces agent active, False greys it out

paramsobject nullable

Param overrides merged on top of agent defaults

notesstring nullable

Reason for the override (shown in admin UI)

Response

Successful Response

agent_namestring required
descriptionstring required
enabledboolean required
is_readyboolean required
activeboolean required

True when both enabled=True and is_ready=True — the UI should show the feature as fully available

readiness_stateobject
paramsobject
thresholdsobject
notesstring nullable
evaluated_atunknown

Changes

No recorded changes to this operation across all 2 revisions of this API.