Skip to content

Settings API

Manage agent settings and configuration.

Endpoints

MethodEndpointDescription
GET/api/agents/{id}/settingsGet settings
PUT/api/agents/{id}/settingsUpdate settings

Get Settings

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

Response

json
{
  "llm_provider": "workers-ai",
  "llm_model": "@cf/meta/llama-3.1-8b-instruct",
  "llm_temperature": 0.7,
  "llm_max_tokens": 2048,
  "llm_system_prompt": "You are a helpful assistant.",

  "calendar_timezone": "UTC",
  "calendar_working_hours_start": "09:00",
  "calendar_working_hours_end": "17:00",
  "calendar_default_duration": 30,

  "workflow_max_concurrent": 5,
  "workflow_default_timeout": 300,
  "workflow_retry_attempts": 3,
  "workflow_retry_delay": 60,

  "browser_headless": true,
  "browser_viewport_width": 1280,
  "browser_viewport_height": 720,
  "browser_user_agent": null,
  "browser_default_timeout": 30000
}

Update Settings

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

Request Body

json
{
  "llm_provider": "openai",
  "llm_model": "gpt-4-turbo-preview",
  "llm_temperature": 0.5
}

Settings Categories

LLM Settings

SettingTypeDescription
llm_providerstringAI provider
llm_modelstringModel name
llm_temperaturenumberCreativity (0-1)
llm_max_tokensnumberMax response length
llm_system_promptstringSystem instructions

Calendar Settings

SettingTypeDescription
calendar_timezonestringTimezone
calendar_working_hours_startstringStart time
calendar_working_hours_endstringEnd time
calendar_default_durationnumberMinutes

Workflow Settings

SettingTypeDescription
workflow_max_concurrentnumberMax parallel
workflow_default_timeoutnumberSeconds
workflow_retry_attemptsnumberRetry count
workflow_retry_delaynumberSeconds

Browser Settings

SettingTypeDescription
browser_headlessbooleanHeadless mode
browser_viewport_widthnumberWidth pixels
browser_viewport_heightnumberHeight pixels
browser_user_agentstringCustom UA
browser_default_timeoutnumberMilliseconds

Released under the MIT License.