Agents

Set Agent Operator Enabled

Switch this operator on or off for the organisation.

TURNING IT ON STARTS UNATTENDED WORK. The operator's monitors begin running on their own schedule, without anyone asking, and they keep running until this is set back to false. That is why this needs the run grant rather than plain write: "let something act in my org when I am not watching" is not the same permission as "edit a record".

What it is allowed to DO once it is on is a separate control - see PUT /agent/operators/{operator}/skills/{skill_key}. Enabling an operator whose skills are all OFF starts nothing.

enabled is explicit rather than a toggle, so a retried request is idempotent instead of switching it back off.

put/agent/operators/{operator}/enabled

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/agent/operators/{operator}/enabled
  • Auth: HTTP bearer

Path parameters

operatorstring required

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

enabledboolean required

Whether this operator runs for the organisation. TURNING IT ON STARTS UNATTENDED WORK: the operator's monitors run on their own schedule from then on, without a person asking. Explicit rather than a toggle, so a retried request is idempotent instead of flipping the state back.

Response

Successful Response

dataOperatorPayload required

An open envelope for one operator answer.

Open because an operator's health snapshot, scorecard and catalog are per-operator documents whose shape follows what that operator monitors - the revenue operator reports different checks from the deliverability one, and both grow. On an OVERSIGHT surface a dropped field reads as "nothing to worry about" rather than "we did not tell you", which is the failure mode worth designing against.

Changes

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