Skip to content

Settings API ​

Manage agent settings and configuration.

Endpoints ​

MethodEndpointDescription
GET/api/agents/{id}/settingsGet settings
PUT/api/agents/{id}/settingsUpdate settings (deep-merged)

Get Settings ​

bash
GET /api/agents/{id}/settings

Response ​

Settings are a nested object (AgentSettings in src/lib/types.ts). Secret-bearing fields (API keys, wallet keys) are redacted in the response.

json
{
  "success": true,
  "data": {
    "llm": {
      "provider": "workers-ai",
      "model": "@cf/meta/llama-4-scout-17b-16e-instruct",
      "temperature": 0.7,
      "maxTokens": 2048,
      "systemPrompt": "You are a helpful assistant."
    },
    "calendar": { "timezone": "UTC" },
    "workflow": { "maxConcurrent": 5 },
    "browser": {
      "headless": true,
      "viewportWidth": 1280,
      "viewportHeight": 720,
      "defaultTimeout": 30000,
      "recording": false,
      "hitlProvider": "cf"
    },
    "toolRouting": { "jev": true, "threshold": 0.6 },
    "memory": { "provider": "local", "verify": true },
    "knowledge": { "aiSearchInstance": "" }
  }
}

Update Settings ​

bash
PUT /api/agents/{id}/settings
Content-Type: application/json

Send only the keys you want to change; nested objects are merged.

json
{
  "llm": { "provider": "openai", "model": "gpt-4o", "temperature": 0.5 }
}

Settings Categories ​

llm ​

SettingTypeDescription
providerstringAI provider
modelstringModel name
temperaturenumberCreativity (0-1)
maxTokensnumberMax response length
systemPromptstringSystem instructions
visionModelstringModel used for image inputs (auto-fallback chain when unset)

toolRouting ​

Controls the Jev tool-category router. Also exposed in Prompt Studio → Tool Categories.

SettingTypeDescription
jevbooleanDefault true. false = regex triggers only, and no partner-model decisions anywhere for this agent
thresholdnumberProbability a category must reach to be loaded (default 0.6)

memory ​

See Agent Memory → Memory providers. Exposed in Settings → Runtime.

SettingTypeDescription
provider"local" | "cloudflare"local (default): agent_state + Vectorize + FTS. cloudflare: the Agent Memory binding (private beta); falls back to local without the binding
verifybooleanDefault true. Jev checks each new memory against similar existing ones and marks replaced ones superseded

knowledge ​

SettingTypeDescription
aiSearchInstancestringName of a Cloudflare AI Search instance indexing the agents' R2 bucket; searched alongside the local index (Knowledge → Retrieval)

browser ​

SettingTypeDescription
headlessbooleanHeadless mode
viewportWidth / viewportHeightnumberViewport in pixels
userAgentstringCustom UA
defaultTimeoutnumberMilliseconds
locale / timezonestringBrowser locale and timezone
recordingbooleanDefault false. Launch Cloudflare Browser Run sessions with recording on (30-day retention); Settings → Runtime
hitlProvider"steel" | "cf"Backend for human-in-the-loop live-view sessions. Headless automation always uses the CF provider

calendar, workflow, contacts, skills, payments, integrations, prompts ​

See the respective feature pages: Calendar, Workflows, Contacts, Payments.