Agents / TypeScript SDK
Update agent chat settings
Update your private Agent Teams chat identity, model preferences and opted-in routines with revision conflict protection. Does not send messages or run hosted AI.
pipeline.updateAgentChatSettingsDeterministic operationParameters
workspaceIdOptional · string- See the input schema for this field.
actionOptional · string- See the input schema for this field.update_settings
conversationIdRequired · string- See the input schema for this field.
expectedRevisionRequired · integer- See the input schema for this field.
preferencesRequired · object- See the input schema for this field.
completeOnboardingOptional · boolean- See the input schema for this field.
await pipeline.updateAgentChatSettings({
"conversationId": "00000000-0000-4000-8000-000000000000",
"expectedRevision": 0,
"preferences": {
"routines": {
"runCompleted": false,
"approvalNeeded": false,
"weeklyReview": false,
"enabledAt": null,
"timezone": "UTC",
"quietStartHour": 20,
"quietEndHour": 8
},
"displayName": "example",
"characterPreset": "circle",
"responseStyle": "concise",
"conversationModel": {
"provider": "anthropic",
"credentialId": "00000000-0000-4000-8000-000000000000",
"model": "example"
},
"coordinatorModel": {
"provider": "anthropic",
"credentialId": "00000000-0000-4000-8000-000000000000",
"model": "example"
}
}
})Full input schema
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string"
},
"action": {
"type": "string",
"enum": [
"update_settings"
],
"default": "update_settings"
},
"conversationId": {
"type": "string",
"format": "uuid"
},
"expectedRevision": {
"type": "integer",
"minimum": 0
},
"preferences": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"routines": {
"default": {
"runCompleted": false,
"approvalNeeded": false,
"weeklyReview": false,
"enabledAt": null,
"timezone": "UTC",
"quietStartHour": 20,
"quietEndHour": 8
},
"type": "object",
"properties": {
"runCompleted": {
"default": false,
"type": "boolean"
},
"approvalNeeded": {
"default": false,
"type": "boolean"
},
"weeklyReview": {
"default": false,
"type": "boolean"
},
"morningBrief": {
"type": "boolean"
},
"replenishment": {
"type": "boolean"
},
"briefHour": {
"type": "integer",
"minimum": 0,
"maximum": 23
},
"enabledAt": {
"default": null,
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
},
{
"type": "null"
}
]
},
"timezone": {
"default": "UTC",
"type": "string"
},
"quietStartHour": {
"default": 20,
"type": "integer",
"minimum": 0,
"maximum": 23
},
"quietEndHour": {
"default": 8,
"type": "integer",
"minimum": 0,
"maximum": 23
}
},
"required": [
"runCompleted",
"approvalNeeded",
"weeklyReview",
"enabledAt",
"timezone",
"quietStartHour",
"quietEndHour"
],
"additionalProperties": false
},
"displayName": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 60
},
{
"type": "null"
}
]
},
"characterPreset": {
"anyOf": [
{
"type": "string",
"enum": [
"circle",
"rounded",
"diamond",
"arch",
"spark",
"leaf"
]
},
{
"type": "null"
}
]
},
"responseStyle": {
"type": "string",
"enum": [
"concise",
"balanced",
"detailed"
]
},
"conversationModel": {
"anyOf": [
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"anthropic",
"openai",
"gemini",
"openrouter"
]
},
"credentialId": {
"type": "string",
"format": "uuid",
"pattern": "^([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)$"
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"reasoningEffort": {
"type": "string",
"enum": [
"none",
"minimal",
"low",
"medium",
"high",
"xhigh",
"max"
]
}
},
"required": [
"provider",
"credentialId",
"model"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"coordinatorModel": {
"anyOf": [
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"anthropic",
"openai",
"gemini",
"openrouter"
]
},
"credentialId": {
"type": "string",
"format": "uuid",
"pattern": "^([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)$"
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"reasoningEffort": {
"type": "string",
"enum": [
"none",
"minimal",
"low",
"medium",
"high",
"xhigh",
"max"
]
}
},
"required": [
"provider",
"credentialId",
"model"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"routines",
"displayName",
"characterPreset",
"responseStyle",
"conversationModel",
"coordinatorModel"
],
"additionalProperties": false
},
"completeOnboarding": {
"type": "boolean"
}
},
"required": [
"conversationId",
"expectedRevision",
"preferences"
]
}