VEverdun
sites

Set or clear this site's operator instructions

Free-text instructions shown to the HUMAN monitoring operator on every alarm at this site, and again at the escalation step. NEVER enters an AI prompt — that is what agent_context on the agent-config route is for. Requires the owner, monitoring_manager or site_manager role (a site_manager only within its own client and granted sites). A site id outside the caller's scope, or a retired one, answers 404 rather than 403: the status code must not tell a caller which of another client's site ids exist.

put/sites/{site_id}/operator-instructions

Request

  • Base URL
    https://api.verdun.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.verdun.ai/sites/{site_id}/operator-instructions
  • Auth
    HTTP bearer

Path parameters

site_idstring required

Request body

operator_instructionsstring nullable

Free-text instructions shown to the HUMAN monitoring operator on every alarm at this level, and again at the escalation step. NEVER enters an AI prompt — that is what the agent context fields are for. Leading and trailing whitespace is trimmed BEFORE the length check, so the 2000-character limit measures the value that will actually be stored and matches the editor's character counter exactly. Empty or whitespace-only is stored as null (= no instruction), as is an explicit null or an omitted field; there is no patch semantic.

headlinestring nullable

One line shown to the operator under the alarm video. Trimmed before the 140-character check; empty or null CLEARS it. UNLIKE the text, OMITTING the key leaves the stored headline unchanged.

Response

Successful Response

idstring uuid required

Id of the account, site or camera that was written.

operator_instructionsstring nullable

The stored instructions after the write, trimmed. Null means no instruction is set at this level.

headlinestring nullable

The stored headline after the write; null when unset.

Changes

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