FurniOpsDocs
API referenceAgents

Update an agent's settings

Changes the settings given; the rest stay. autonomy: off stops the agent; proposals it made stay as they are.

  • Scopesagent:write
  • Rate classwrite
PATCH/v1/agents/{agent}

Changes the settings given; the rest stay. autonomy: off stops the agent; proposals it made stay as they are.

Authorization

apiKey
AuthorizationBearer <token>

An API key (fo_live_… / fo_test_…) as a bearer token

In: header

Path Parameters

agent*string

The agent

Value in

  • "categories"
  • "repair"
  • "onboarding"
  • "triage"

Header Parameters

FurniOps-Version?string

Dated API version; pinned per organisation on first use and overridable per request

Value in

  • "2026-10-01"
  • "2026-10-04"
FurniOps-Mode?string

The data the request acts on: test is the organisation's sandbox. An OAuth token picks it (live by default); an API key's mode is fixed, and naming the other one is refused

Value in

  • "live"
  • "test"
FurniOps-Dry-Run?string

Preview the write and change nothing: true answers the would-be response, explain a Preview (application/vnd.furniops.preview+json)

Value in

  • "true"
  • "explain"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

The settings to change; others stay

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://example.com/v1/agents/categories" \  -H "Content-Type: application/json" \  -d '{}'
{  "object": "agent_settings",  "agent": "categories",  "autonomy": "off",  "daily_budget_micros": 0,  "spent_today_micros": 0,  "shadow": {    "proposals": 0,    "agreed": 0,    "differed": 0  },  "updated_at": "2019-08-24T14:15:22Z"}