Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB
Agent Builder

Update agent setting

Updates instructions, model, tools, playbooks, connected accounts, and system tool settings. Requires a USER API key.

put/public/v1/agents/{agentId}/agent-setting

Path parameters

agentIdstring required
Example:uuid-xxxx-xxxx

Request body

aiModelIdnumber nullable required
temperaturenumber required
instructionsstring nullable required
maxIterationsnumber
agentType'BASIC' | 'ADVANCED'
customToolIdsnumber[] nullable

Example request

{
  "aiModelId": 1,
  "instructions": "example",
  "maxIterations": 3,
  "agentType": "BASIC",
  "customToolIds": [
    1
  ],
  "connectedAccountConfigs": [
    {
      "connectedAccountId": 1,
      "selectedToolSlugs": [
        "example"
      ]
    }
  ],
  "selectedRecordTypes": [
    {
      "recordTypeId": 1
    }
  ]
}

Response

Updated agent setting

idnumber required
aiModelIdnumber nullable
modelstring nullable
aiType'ASSISTANT' | 'AGENT'
temperaturenumber
instructionsstring nullable
agentRole'NONE' | 'CUSTOM' | 'CUSTOMER_SUPPORT' | 'SALES_REPRESENTATIVE' | 'COLLECTIONS' | 'RECRUITING_AGENT' | 'HR_MANAGER' | 'PRODUCT_COPILOT' | 'AI_ASSISTANT' | 'ANALYST' | 'POST_SALES'
toneOfVoice'NONE' | 'CUSTOM' | 'FRIENDLY' | 'NEUTRAL' | 'MATTER_OF_FACT' | 'PROFESSIONAL' | 'HUMOROUS' | 'WITTY' | 'GEN_Z'
answerLength'NONE' | 'CUSTOM' | 'DYNAMIC' | 'CONCISE' | 'STANDARD' | 'THOROUGH'
maxIterationsnumber
agentType'BASIC' | 'ADVANCED'
systemToolsConfigobject nullable

Example response

{
  "id": 1,
  "aiModelId": 1,
  "aiModel": {
    "id": 1,
    "name": "example",
    "description": "example",
    "creditsPerMessage": 1,
    "order": 1,
    "analyticsColor": "example",
    "externalId": "example",
    "aiVendor": "example",
    "type": "TEXT"
  },
  "model": "example",
  "aiType": "ASSISTANT",
  "temperature": 1,
  "instructions": "example",
  "agentRole": "NONE",
  "toneOfVoice": "NONE",
  "answerLength": "NONE",
  "maxIterations": 1,
  "agentType": "BASIC",
  "customTools": [
    {
      "id": 1,
      "name": "example",
      "description": "example",
      "status": "example",
      "type": "example"
    }
  ],
  "selectedRecordTypes": [
    {
      "recordTypeId": 1
    }
  ],
  "agentConnectedAccounts": [
    {
      "connectedAccountId": 1,
      "selectedToolSlugs": [
        "example"
      ],
      "connectedAccount": {
        "id": 1,
        "toolkit": "example",
        "alias": "example",
        "connectedEmail": "example"
      }
    }
  ],
  "agentPlaybooks": [
    {
      "playbookId": 1,
      "assignedAt": "example",
      "playbook": {
        "id": 1,
        "name": "example",
        "description": "example"
      }
    }
  ]
}