ReferenceHTTP APIAgents

Save the agent's engine rules

PUT
/v1/agents/{id}/engine-settings

Replaces the agent's own rule set in one transaction and makes no release: a session that starts afterwards reads it, and a session already running keeps the rules it started with unless a later save only narrows them. expected_revision and the checks are those of the workspace's save (409 REVISION_CONFLICT; 400 with the parser's reason_code or engine_settings_catalog_ambiguous; 403 engine_settings_writes_closed while the gate is shut). The restrictions the agent inherited from its profile are not part of this request and are left as they are. Writes a set_agent_engine_settings receipt with the rule counts and sizes before and after, never a rule's text; receipt_id is null when the agent already held these rules. Agent managers with a web session only; API keys are refused.

Auth: cookie session only; no scope. Idempotency-Key: ignored.

Authorization

cookieSession
cookie__Host-werft_session<token>

For the web console: the browser session cookie set by POST /v1/auth/login. It holds the scopes of the user's workspace role (owner: all; admin and member: all but sessions:recover). Requests other than GET must also send X-Requested-With: werft-web.

Path Parameters

id*string

The agent's id.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Header Parameters

X-Requested-With?"werft-web"

Required with a cookie session: the literal werft-web.

Value in"werft-web"

Request Body

application/json
  1. body
expected_revision*|null
settings*

Response Body

Saved.

application/json
  1. response
settings_revision*integer
Range0 < value <= 9007199254740991
receipt_id*|null
Example Request
curl -X PUT 'https://example.com/v1/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/engine-settings' \  -H 'Content-Type: application/json' \  -d '{  "expected_revision": 1,  "settings": {    "permissions": {      "ask": [        "WebFetch"      ]    },    "auto_mode": {}  }}'
Example Response
{  "settings_revision": 2,  "receipt_id": "c4a1e9d2-7b3f-4e8a-a6c5-1d2e3f4a5b6c"}