查看 Markdown
POST/api/agent/schedule/create

创建定时任务

创建新的定时任务并注册到调度器,支持一次性(ONE_TIME)、周期性(RECURRING)和Cron表达式(CRON)三种触发类型。支持通过 bizKey 标识会话(优先级高于 sessionId),支持通过 reuseSession 控制是否复用会话。支持配置与异步运行智能体接口同口径的运行时变量、能力限制、模型思考参数和输出格式。运行特性随任务固化并在每次触发时生效;全部不传时仍在执行时读取智能体最新配置。capabilityConfig只能收窄智能体已有能力,使用该字段时必须明确传入agentId。时间参数使用北京时间,格式 yyyy-MM-dd HH:mm:ss。

触发类型(triggerType):

  • ONE_TIME:一次性任务,在指定时间执行一次,执行后不再触发
  • RECURRING:周期性任务,从起始时间开始按固定时间间隔重复执行
  • CRON:Cron 表达式任务,按标准 Cron 表达式定义的时间规则执行

响应中 triggerConfig 的时间口径: triggerConfig 以 JSON 字符串返回,其中 executeTime、startTime 为北京时间,格式 yyyy-MM-dd HH:mm:ss,与创建/修改时传入的时间口径一致,也与同一响应中的 nextExecutionTime、createdAt 保持一致。 历史上该字段曾以 UTC 的 ISO-8601(如 2026-09-07T16:00:00Z)返回,如果您解析了这两个时间字段,请按北京时间解析,不要再当作 UTC 处理;仅透传或展示该字段的调用方不受影响。

迁移存量任务:把其它系统的任务迁移进本平台时,可传入 createdAt 保留源端的创建时间,使迁移后任务列表按创建时间排序的表现与源端一致。该参数只覆盖任务的创建时间,不参与调度计算,首次触发时间仍完全由 triggerConfig 决定。 另有两点由 triggerConfig 本身决定、与 createdAt 无关的注意点:

  • 源端已过期的 ONE_TIME 任务会因 executeTime 不是未来时间被拒绝,需要在迁移前自行过滤
  • startTime 落在过去的 RECURRING 任务,注册后会被调度器视为逾期并立即真实执行一次(真实调用模型并投递结果),迁移时请先把 startTime 归一到未来时间

创建成功后任务的 taskStatus 为 ENABLED、scheduleState 为 SCHEDULED,可通过 nextExecutionTime 查看下次触发时间。

身份说明:当您通过API访问本系统时,请求头中必须传递 X-Principal-Id 以标识操作主体;当您通过页面访问本系统时,无需传递。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)17 个字段

taskNamestringrequired

任务名称,用于展示和识别任务

agentIdintegernullable

绑定的智能体ID,为空时使用主体的默认智能体

bizKeystringnullable

业务键,用于标识任务关联的会话。传入后通过 bizKey 解析出对应的会话ID,优先级高于 sessionId

sessionIdintegernullable

来源会话ID,记录任务创建的上下文会话

descriptionstringnullable

任务描述,补充说明任务用途

triggerTypestringrequired

触发类型,可选值:ONE_TIME(一次性任务,在指定时间执行一次,执行后不再触发)、RECURRING(周期性任务,从起始时间开始按固定时间间隔重复执行)、CRON(Cron表达式任务,按标准Cron表达式定义的时间规则执行)

触发配置,根据触发类型填写对应字段

userInputstringrequired

任务触发时发送给智能体的指令,描述智能体应该执行的具体任务

reuseSessionbooleannullable

是否复用会话,开启后任务执行时复用已有会话而非每次新建。开启时必须传入 sessionId 或 bizKey

runtimeVariablesobjectnullable

运行时变量,随任务保存并在每次触发时回填运行上下文。Finx服务可通过${ctx.KEY}占位符读取,沙箱脚本可通过同名环境变量读取。变量不得包含密码、密钥等敏感信息

任务运行时的工具、Skill和Finx服务能力限制。未传时沿用智能体配置;传入时只能进一步收窄智能体已有能力,不能重新启用智能体已禁用的能力。该配置随任务固化,每次触发时生效

enableThinkingbooleannullable

是否启用思考模式(已废弃,请使用reasoningEffort)。true等效high,false等效disabled

reasoningEffortstringnullable

推理力度档位,可选值:disabled、low、medium、high、xhigh。参数优先级:thinkingBudget > reasoningEffort > enableThinking > 智能体默认档位

thinkingBudgetintegernullable

思维链Token预算。传入后优先级高于reasoningEffort;内核会自动修正到模型支持范围

temperaturenumbernullable

模型温度,取值范围0~2;不传时使用系统默认值

supportedOutputFormatsarraynullable

调用终端支持渲染的输出格式列表。例如传入echarts后,模型可输出ECharts图表代码块

createdAtstringnullable

源端创建时间,仅用于将存量任务从其它系统迁移到本平台的场景,北京时间,格式 yyyy-MM-dd HH:mm:ss。传入后仅覆盖任务记录的创建时间,使迁移后任务列表按创建时间排序的表现与源端一致;不参与任何调度计算,nextExecutionTime、调度状态以及 triggerConfig 中的时间全部按原有逻辑处理。取值须不早于 2000-01-01 00:00:00 且不晚于当前时间,否则返回参数错误。不传时取系统当前时间

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
GET/api/agent/schedule/list

查询任务列表

查询当前用户下的定时任务列表,支持按智能体ID过滤和是否包含已禁用任务的筛选。agentIds按任务显式绑定的智能体批量筛选,与agentId互斥,未绑定智能体的任务不命中。

返回的任务信息使用两个独立字段描述状态,二者结合才能完整反映一个任务的状态:

taskStatus(任务开关状态):由调用方主动控制,暂停或恢复任务时改变。

  • ENABLED:启用中,任务处于生效状态,会按配置的触发规则自动执行
  • DISABLED:已暂停,任务配置保留,但不再触发执行,可随时恢复

scheduleState(实时调度状态):由系统根据任务的实际调度情况实时计算,反映此刻任务在做什么。

  • SCHEDULED:等待执行,任务已排入调度计划,将在 nextExecutionTime 指定时间触发
  • RUNNING:执行中,任务已被触发,正在运行
  • NOT_SCHEDULED:无后续执行计划,任务被暂停,或一次性任务已执行完毕

常见状态组合:

  • ENABLED + SCHEDULED:正常运行中,等待下次触发
  • ENABLED + RUNNING:正在执行本次任务
  • ENABLED + NOT_SCHEDULED:一次性任务已执行完成,无后续计划
  • DISABLED + NOT_SCHEDULED:任务已暂停,恢复后将重新排入调度计划

展示建议:以 scheduleState 作为任务的主展示状态,taskStatus 用于渲染「暂停 / 恢复」操作按钮的开关态。对于一次性任务,执行完成后 taskStatus 仍为 ENABLED,但已不会再次触发,此时应依据 scheduleState 判断任务是否还有后续执行计划。

触发类型(triggerType):

  • ONE_TIME:一次性任务,在指定时间执行一次,执行后不再触发
  • RECURRING:周期性任务,从起始时间开始按固定时间间隔重复执行
  • CRON:Cron 表达式任务,按标准 Cron 表达式定义的时间规则执行

响应中 triggerConfig 的时间口径: triggerConfig 以 JSON 字符串返回,其中 executeTime、startTime 为北京时间,格式 yyyy-MM-dd HH:mm:ss,与创建/修改时传入的时间口径一致,也与同一响应中的 nextExecutionTime、createdAt 保持一致。 历史上该字段曾以 UTC 的 ISO-8601(如 2026-09-07T16:00:00Z)返回,如果您解析了这两个时间字段,请按北京时间解析,不要再当作 UTC 处理;仅透传或展示该字段的调用方不受影响。

身份说明:当您通过API访问本系统时,请求头中必须传递 X-Principal-Id 以标识操作主体;当您通过页面访问本系统时,无需传递。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

Query 参数3 个字段

agentIdsarraynullable

智能体ID列表,使用单个逗号分隔参数,如101,102;自动去重后最多20个,必须为正整数,不接受空值或重复参数键。未传时保留原查询行为。

agentIdintegernullable

智能体ID,不传则返回全部任务

includeDisabledbooleannullable

是否包含已禁用的任务,默认为 false

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
GET/api/agent/schedule/detail

查询任务详情

根据任务ID查询任务详情,包含任务的基本信息和执行历史。

返回的任务信息使用两个独立字段描述状态,二者结合才能完整反映一个任务的状态:

taskStatus(任务开关状态):由调用方主动控制,暂停或恢复任务时改变。

  • ENABLED:启用中,任务处于生效状态,会按配置的触发规则自动执行
  • DISABLED:已暂停,任务配置保留,但不再触发执行,可随时恢复

scheduleState(实时调度状态):由系统根据任务的实际调度情况实时计算,反映此刻任务在做什么。

  • SCHEDULED:等待执行,任务已排入调度计划,将在 nextExecutionTime 指定时间触发
  • RUNNING:执行中,任务已被触发,正在运行
  • NOT_SCHEDULED:无后续执行计划,任务被暂停,或一次性任务已执行完毕

常见状态组合:

  • ENABLED + SCHEDULED:正常运行中,等待下次触发
  • ENABLED + RUNNING:正在执行本次任务
  • ENABLED + NOT_SCHEDULED:一次性任务已执行完成,无后续计划
  • DISABLED + NOT_SCHEDULED:任务已暂停,恢复后将重新排入调度计划

展示建议:以 scheduleState 作为任务的主展示状态,taskStatus 用于渲染「暂停 / 恢复」操作按钮的开关态。对于一次性任务,执行完成后 taskStatus 仍为 ENABLED,但已不会再次触发,此时应依据 scheduleState 判断任务是否还有后续执行计划。

触发类型(triggerType):

  • ONE_TIME:一次性任务,在指定时间执行一次,执行后不再触发
  • RECURRING:周期性任务,从起始时间开始按固定时间间隔重复执行
  • CRON:Cron 表达式任务,按标准 Cron 表达式定义的时间规则执行

响应中 triggerConfig 的时间口径: triggerConfig 以 JSON 字符串返回,其中 executeTime、startTime 为北京时间,格式 yyyy-MM-dd HH:mm:ss,与创建/修改时传入的时间口径一致,也与同一响应中的 nextExecutionTime、createdAt 保持一致。 历史上该字段曾以 UTC 的 ISO-8601(如 2026-09-07T16:00:00Z)返回,如果您解析了这两个时间字段,请按北京时间解析,不要再当作 UTC 处理;仅透传或展示该字段的调用方不受影响。

身份说明:当您通过API访问本系统时,请求头中必须传递 X-Principal-Id 以标识操作主体;当您通过页面访问本系统时,无需传递。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

Query 参数1 个字段

taskIdintegerrequired

任务ID,必填

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/agent/schedule/update

修改定时任务

修改指定定时任务的名称、描述、触发配置和执行指令,支持通过 reuseSession 控制是否复用会话。支持修改运行时变量、能力限制、模型思考参数和输出格式。任一运行特性字段传入时整组重建,未传字段回退到修改时点的智能体配置或系统默认值;runtimeVariables除外:不传保留,传空对象清除,传非空对象整体覆写。capabilityConfig只能收窄任务绑定智能体的已有能力。

触发类型(triggerType):

  • ONE_TIME:一次性任务,在指定时间执行一次,执行后不再触发
  • RECURRING:周期性任务,从起始时间开始按固定时间间隔重复执行
  • CRON:Cron 表达式任务,按标准 Cron 表达式定义的时间规则执行

响应中 triggerConfig 的时间口径: triggerConfig 以 JSON 字符串返回,其中 executeTime、startTime 为北京时间,格式 yyyy-MM-dd HH:mm:ss,与创建/修改时传入的时间口径一致,也与同一响应中的 nextExecutionTime、createdAt 保持一致。 历史上该字段曾以 UTC 的 ISO-8601(如 2026-09-07T16:00:00Z)返回,如果您解析了这两个时间字段,请按北京时间解析,不要再当作 UTC 处理;仅透传或展示该字段的调用方不受影响。

修改触发配置后调度计划会重新计算,可通过返回结果的 scheduleState 和 nextExecutionTime 确认新的调度情况。

身份说明:当您通过API访问本系统时,请求头中必须传递 X-Principal-Id 以标识操作主体;当您通过页面访问本系统时,无需传递。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)16 个字段

taskIdintegerrequired

要修改的任务ID

taskNamestringrequired

任务名称,用于展示和识别任务

descriptionstringnullable

任务描述,补充说明任务用途

triggerTypestringrequired

触发类型,可选值:ONE_TIME(一次性任务,在指定时间执行一次,执行后不再触发)、RECURRING(周期性任务,从起始时间开始按固定时间间隔重复执行)、CRON(Cron表达式任务,按标准Cron表达式定义的时间规则执行)

触发配置,根据触发类型填写对应字段

userInputstringrequired

任务触发时发送给智能体的指令,描述智能体应该执行的具体任务

reuseSessionbooleannullable

是否复用会话,开启后任务执行时复用已有会话而非每次新建。开启时任务必须已关联会话

bizKeystringnullable

业务键,用于标识任务关联的会话。传入后通过 bizKey 解析出对应的会话ID,优先级高于 sessionId

sessionIdintegernullable

来源会话ID,修改任务关联的会话

runtimeVariablesobjectnullable

运行时变量,随任务保存并在每次触发时回填运行上下文。本字段采用增量语义:不传时保留已有值,传空对象时清除,传非空对象时整体覆写。变量不得包含密码、密钥等敏感信息

任务运行时的工具、Skill和Finx服务能力限制。传入时只能进一步收窄智能体已有能力。任一运行特性字段传入时整组重建,本字段未传则按修改时点的智能体配置重新固化

enableThinkingbooleannullable

是否启用思考模式(已废弃,请使用reasoningEffort)。true等效high,false等效disabled

reasoningEffortstringnullable

推理力度档位,可选值:disabled、low、medium、high、xhigh。参数优先级:thinkingBudget > reasoningEffort > enableThinking > 智能体默认档位

thinkingBudgetintegernullable

思维链Token预算。传入后优先级高于reasoningEffort;内核会自动修正到模型支持范围

temperaturenumbernullable

模型温度,取值范围0~2;不传时使用系统默认值

supportedOutputFormatsarraynullable

调用终端支持渲染的输出格式列表。例如传入echarts后,模型可输出ECharts图表代码块。任一运行特性字段传入时整组重建

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/agent/schedule/disable

暂停任务

根据任务ID暂停指定的定时任务,暂停后任务将不再自动执行。

暂停成功后任务的 taskStatus 变为 DISABLED、scheduleState 变为 NOT_SCHEDULED,任务配置保留,可通过「恢复任务」接口重新排入调度计划。

身份说明:当您通过API访问本系统时,请求头中必须传递 X-Principal-Id 以标识操作主体;当您通过页面访问本系统时,无需传递。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)1 个字段

taskIdintegerrequired

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

databooleannullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/agent/schedule/enable

恢复任务

根据任务ID恢复指定的定时任务,恢复后任务将按调度配置自动执行。

恢复成功后任务的 taskStatus 变为 ENABLED,并重新排入调度计划,scheduleState 变为 SCHEDULED。

身份说明:当您通过API访问本系统时,请求头中必须传递 X-Principal-Id 以标识操作主体;当您通过页面访问本系统时,无需传递。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)1 个字段

taskIdintegerrequired

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

databooleannullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/agent/schedule/batchUpdateStatusByAgentIds

批量更新任务状态

按智能体ID批量启用或暂停当前主体的定时任务,可选按触发类型进一步筛选。仅处理显式绑定到指定智能体且未删除的任务,不处理未绑定智能体、运行时使用主体默认智能体的任务。智能体ID会自动去重,去重后最多100个;触发类型不传、传null或空数组时均表示不筛选。重复设置相同状态按幂等方式处理。暂停只停止后续调度,不会终止已经开始执行的任务。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)3 个字段

agentIdsarrayrequired

智能体ID列表,自动去重,去重后最多100个

targetStatusstringrequired

目标状态,可选值:ENABLED、DISABLED

triggerTypesarraynullable

触发类型筛选条件,可选值:ONE_TIME、RECURRING、CRON;不传、传null或空数组均表示不按触发类型筛选

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/agent/schedule/batchUpdateStatusByTaskIds

按任务ID批量更新状态

按任务ID批量启用或暂停当前主体的定时任务,适用于用户在任务列表中勾选若干条任务后统一操作的场景。与按智能体批量的接口不同,本接口可以命中未绑定智能体、运行时使用主体默认智能体的任务。任务ID会自动去重,去重后最多100个。无效的任务ID(不存在、不属于当前主体或已删除)不会导致整批操作失败,其余有效任务照常变更,无效ID通过返回结果中的 notFoundTaskIds 原样返回。重复设置相同状态按幂等方式处理。暂停只停止后续调度,不会终止已经开始执行的任务。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)2 个字段

taskIdsarrayrequired

任务ID列表,自动去重,去重后最多100个

targetStatusstringrequired

目标状态,可选值:ENABLED、DISABLED

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/agent/schedule/triggerNow

立即触发任务

根据任务ID立即触发一次任务执行,不影响后续调度。

触发后任务的 scheduleState 在执行期间为 RUNNING,taskStatus 与原有调度计划均不变,执行结果可通过「查询执行历史」接口查看。

身份说明:当您通过API访问本系统时,请求头中必须传递 X-Principal-Id 以标识操作主体;当您通过页面访问本系统时,无需传递。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)1 个字段

taskIdintegerrequired

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

databooleannullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/agent/schedule/delete

删除任务

根据任务ID删除指定的定时任务。身份说明:当您通过API访问本系统时,请求头中必须传递 X-Principal-Id 以标识操作主体;当您通过页面访问本系统时,无需传递。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)1 个字段

taskIdintegerrequired

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

databooleannullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
GET/api/agent/schedule/executionHistory

查询执行历史

分页查询定时任务的执行历史记录。agentIds按运行记录的实际智能体筛选,与taskId取交集,不受当前默认智能体变化影响。传 taskId 时查询指定任务的执行历史(行为与旧版一致);不传 taskId 时查询该用户身份下所有定时任务触发的执行记录,跨任务按时间倒序分页。返回记录包含 taskId、taskName、sessionId 等字段,可用于跨任务列表展示和跳转会话详情。

迁移进来的历史运行:通过「迁移历史运行记录」接口登记的运行也会出现在本列表中,按迁移时传入的 createdAt 参与排序,因此显式传入 createdAt 即可还原源端的历史顺序。这类记录只读,仅支持查询和随任务删除,不支持挂起、恢复、终止、重试、补充输入和订阅事件流。本列表的记录本身不带来源标识,需要在界面上区分或决定是否渲染管控按钮时,可用记录中的 requestId 调用「智能体运行」模块的「查询运行记录详情」接口,该接口返回的 triggerSource 为 imported 即表示迁移进来的历史运行。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

Query 参数4 个字段

agentIdsarraynullable

智能体ID列表,使用单个逗号分隔参数,如101,102;自动去重后最多20个,必须为正整数,不接受空值或重复参数键。未传时保留原查询行为。

taskIdintegernullable

任务ID,不传则查询该用户所有任务的执行记录

pageintegernullable

页码,从1开始

sizeintegernullable

每页记录数,取值范围1~100

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/agent/schedule/importExecution

迁移历史运行记录

把已迁入本平台的一轮历史对话,登记为某个已存在定时任务的一次历史运行,用于从其它系统迁移存量定时任务后补齐执行历史。本接口不调用模型、不消耗额度、不触发任务执行,也不会改变任务的调度计划和下次触发时间。

两阶段迁移流程:

  1. 先调用「会话」模块的「导入一问一答会话」或「导入完整会话轨迹」接口迁入历史对话,从响应的 messageMappings 中取出目标轮次的 assistantMessageId;
  2. 再调用本接口,用该 assistantMessageId 关联到已存在的 taskId 上。服务端会据此推导用户消息、会话和智能体,无需重复传入。

时间口径:所有时间均为北京时间,格式 yyyy-MM-dd HH:mm:ss(亦兼容ISO的T分隔符与省略秒两种等价写法,不接受毫秒和时区偏移),取值须不早于 2000-01-01 00:00:00 且不晚于当前时间。startedAt 到 completedAt 的区间必须覆盖本轮已导入消息及其片段的时间,本接口不会反向改写消息时间。执行历史列表的展示时间和排序取 createdAt,需要还原源端历史顺序时务必显式传入 createdAt,不传时会落到首次迁入的时间。

幂等与冲突:本接口按本地助手消息幂等,同一条助手消息重复调用不会产生第二条运行记录,重放时返回原有记录且 created 为 false。若该消息已被其它运行占用、与已有记录冲突或对应记录已删除,返回 409 冲突。注意第一阶段的会话导入接口本身并不幂等,请求超时后请先查询目标会话确认是否已导入,不要无条件重试。

迁移进来的运行是只读的:迁入的记录会出现在执行历史中,可以查询、可以随任务删除,但不支持暂停、恢复、终止、重试和补充输入,也不支持订阅事件流。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)12 个字段

taskIdintegerrequired

已存在的定时任务ID,任务必须属于当前操作主体且未删除;已暂停的任务也可以关联历史运行

assistantMessageIdintegerrequired

会话导入接口返回的本地助手消息ID,取自 messageMappings 中对应轮次的 assistantMessageId。服务端据此推导本轮的用户消息、所属会话和智能体,无需额外传入

statusstringrequired

历史运行的终态,仅支持已结束的状态,不接受执行中或等待中的状态(大小写不敏感)。

  • COMPLETED:执行完成
  • FAILED:执行失败
  • CANCELLED:执行取消
startedAtstringrequired

真实执行开始时间,北京时间,格式 yyyy-MM-dd HH:mm:ss。须不早于 2000-01-01 00:00:00 且不晚于当前时间,并且要早于或等于本轮已导入消息及其片段的最早时间

completedAtstringrequired

真实结束、失败或取消时间,格式与时区同 startedAt。不能早于 startedAt,并且要晚于或等于本轮已导入消息及其片段的最晚时间

createdAtstringnullable

源端记录创建时间,北京时间,格式 yyyy-MM-dd HH:mm:ss。执行历史列表的展示时间和排序都取这个时间,需要还原源端历史顺序时务必显式传入;不传时取首次迁入的时间,幂等重放会保留首次值

updatedAtstringnullable

源端记录更新时间,北京时间,格式 yyyy-MM-dd HH:mm:ss。与 createdAt 各自独立选填,两者都显式传入时要求 createdAt 不晚于 updatedAt;不传时取首次迁入的时间,幂等重放会保留首次值

roundsintegernullable

已知的真实循环步骤数。不传时保留已有值,没有已有值时记为0;服务端不会按导入轮数推测

已知的历史Token用量。整体选填,传入非空对象时 totalTokens 必填,也可只传总量;未传的细分项保留助手消息已有统计,没有统计时记为0。重复导入不会累加

modelstringnullable

历史运行使用的模型名称。助手消息上已有模型时以已有值为准,两处都传时必须一致;都没有时为空

errorCodestringnullable

源端的失败或取消错误码,仅在 status 为 FAILED、CANCELLED 时可传;status 为 COMPLETED 时不接受任何错误信息

errorMessagestringnullable

源端的失败或取消原因,仅在 status 为 FAILED、CANCELLED 时可传;status 为 COMPLETED 时不接受任何错误信息。不传时原因记为未知

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/agent/schedule/upsertTaskPolicy

更新定时任务执行策略

设置当前租户下定时任务的执行策略,包括最小执行间隔和启用状态。最小执行间隔用于防止任务过于频繁触发,设置后同一租户下两次任务执行之间至少间隔该时长。

请求参数

请求体(JSON)2 个字段

minIntervalSecondsintegernullable

最小执行间隔(秒),不传则不覆盖默认值;非空时不小于600

enabledbooleanrequired

是否启用该策略,true为启用,false为禁用

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

databooleannullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
GET/api/agent/schedule/getTaskPolicy

查询定时任务执行策略

查询当前租户下定时任务的最小执行间隔配置,返回值为最小执行间隔秒数。未配置时返回 null。

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

dataintegernullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理