Skip to main content
PATCH
更新自动化

权限

需要具有组织级别 ManageOrgAutomations 权限的服务用户。

合并语义

在默认的 merge_patch 语义下,PATCH 字段按成员进行合并 (采用 RFC 7396 风格) :省略的成员保留其已存储的值,显式指定的 null 会清除值,空组不执行任何操作。元数据按键合并,null 值会删除相应的键。列表会被整体替换;当某个类型在双方都恰好出现一次时,每个发送的元素会与已存储的同类型元素合并。 replace_groups 语义下,不进行任何合并:发送的对象组会整体替换已存储的组,发送的 triggersactions 列表会整体替换已存储的列表,不会逐元素合并。请重新发送所有希望保留的成员——省略的成员会被清除或重置为默认值。metadata 也会被完整替换,因此要移除某个键,就需要重新发送不包含该键的集合;null 元数据值会被拒绝并返回 400,而不会删除键。省略的顶级字段仍保持不变。 在依赖任一行为之前,请检查事件架构端点update_semantics 字段,确认你的组织当前生效的语义。请将其视为开放枚举,并能够处理上述两种以外的值。

Webhook 触发器

重新添加 webhook:incoming 触发器会生成新的密钥,并在更新响应中返回。密钥仅会在此时显示,请务必在收到后保存。替换或保留现有的 Webhook 触发器会保留原有密钥。

授权

Authorization
string
header
必填

服务用户凭据(前缀:cog_)

路径参数

automation_id
string
必填
org_id
string
必填

组织 ID(前缀:org-)

示例:

"org-abc123def456"

请求体

application/json

PATCH 字段默认按成员合并:省略的成员会保留, 显式 null 会清除,空组不执行任何操作。元数据按键合并, 值为 null 时删除相应的键。列表会整体替换(删除 = 重新发送 不含该元素的列表);当某类型在双方均恰好出现一次时, 每个已发送元素会与同类型的 已存储元素合并。创建时必填的元素成员(promptsetup_prompt、监控/分流 Slack 配置、scan_id)在存在对应项时 可省略 — 它们会像其他成员一样沿用; 显式 null 会被拒绝。

actions
(AutomationStartSessionActionUpdate · object | AutomationMessageSessionActionUpdate · object | AutomationMonitorSessionActionUpdate · object)[] | null
concurrency
AutomationConcurrency · object | null
enabled
boolean | null
limits
AutomationLimits · object | null
metadata
Metadata · object | null
name
string | null
Required string length: 1 - 500
notifications
AutomationNotifications · object | null
run_as
AutomationRunAsOrganization · object

启动的会话运行时使用的身份。organization:组织的自动化身份(应用中的系统用户)— 会话使用系统权限,因此无法选择通过个人(用户作用域)连接安装的 MCP 服务器;将自动化切换为 organization 会将这些服务器从其选择中移除。creator:个人自动化 — 使用创建者自身的权限运行,且仅对创建者和组织管理员可见;不允许由服务用户创建的自动化使用此选项。创建时必填;更新时设为 null 会重置为 organization。

security_profile
AutomationSecurityProfileSelection · object | null

自动化自身的安全 Profile 绑定:profile_id 会固定使用该 Profile,{"profile_id": null} 会记录明确不使用 Profile,而显式 null 会恢复为从组织/Enterprise 继承。需要安全 Profile 管理权限。

session_settings
AutomationSessionSettings · object | null

应用于此自动化生成的每个会话(包括监控 会话)。

tools
AutomationTools · object | null
triggers
AutomationTriggerRequest · object[] | null

响应

成功响应

actions
(AutomationStartSessionAction · object | AutomationMessageSessionAction · object | AutomationMonitorSessionAction · object)[]
必填
automation_id
string
必填
created_at
integer
必填
created_by
ActorResponse · object
必填

归因于某项操作或资源的用户或服务用户主体。

enabled
boolean
必填
name
string
必填
triggers
AutomationTriggerResponse · object[]
必填
updated_at
integer
必填
concurrency
AutomationConcurrency · object | null
last_edited_by
ActorResponse · object | null

归因于某项操作或资源的用户或服务用户主体。

last_invocation
AutomationLastInvocation · object | null
limits
AutomationLimits · object | null
metadata
Metadata · object
notifications
AutomationNotifications · object | null
run_as
AutomationRunAsOrganization · object

启动的会话使用的身份。organization:组织的自动化身份(应用中的系统用户)— 会话使用系统权限,因此无法选择通过个人(用户作用域)连接安装的 MCP 服务器;将自动化切换为 organization 会将这些服务器从可选项中移除。creator:个人自动化 — 使用创建者自身的权限运行,且仅创建者和组织管理员可见;由服务用户创建的自动化不允许使用此值。创建时必填;更新时设为 null 将重置为 organization。

security_profile
AutomationSecurityProfileResponse · object | null

自动化的安全 Profile 绑定及解析后适用的 Profile。组织未启用安全 Profile 时为 null。

session_settings
AutomationSessionSettings · object | null

应用于此自动化生成的每个会话(包括监控 会话)。

template_id
string | null
tools
AutomationTools · object | null