完整文档索引见 llms.txt。在页面 URL 后附加 .md 即可获取 Markdown 版本；本页的 Markdown 版本可在此获取。

执行记录

执行记录相关操作

获取所有执行记录

获取实例中的所有执行记录。

GET/executions

请求参数

参数	位置	类型	必填	说明
limit	query	number	否	最多返回的数据项数量。 默认值：100
cursor	query	string	否	将 cursor 参数设为上次请求响应中的 nextCursor 属性，以进行分页。使用默认值时，获取集合的第一页。更多信息，请参阅分页说明。
includeData	query	string	否	是否包含执行的详细数据。 默认值："false" 可选值：true, false
ignoreDataSizeLimit	query	string	否	即使执行数据超过配置的大小限制（EXECUTIONS_DATA_MAX_DISPLAY_SIZE），是否仍返回完整数据。否则，超出大小限制的执行记录将不包含其数据。 默认值："false" 可选值：true, false
redactExecutionData	query	string	否	控制执行数据遮蔽。为 true 时，始终遮蔽执行输出数据；为 false 时，请求未遮蔽的数据（显示原始数据），需要 execution:reveal 作用域。省略时遵循工作流的遮蔽策略。 可选值：true, false
status	query	string	否	用于筛选执行记录的状态。 可选值：canceled, crashed, error, new, running, success, unknown, waiting
workflowId	query	string	否	用于筛选执行记录的工作流。
projectId	query	string	否
startedAfter	query	string	否	仅返回在此时间之后开始的执行。
startedBefore	query	string	否	仅返回在此时间之前开始的执行。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
data	array	是	展开字段 字段 类型 必填 说明 data.[]id string 是 data.[]finished boolean 是 执行是否已运行完成。请改用 status。 data.[]mode string 是 可选值：cli, error, integrated, internal, manual, retry, trigger, webhook, evaluation, chat, agent data.[]retryOf string 是 此执行所重试的原执行 ID。 data.[]retrySuccessId string 是 如果此执行失败，但某次重试成功，则为该成功重试的 ID。 data.[]status string 是 可选值：canceled, crashed, error, new, running, success, unknown, waiting data.[]startedAt string 是 执行离开队列并开始运行之前为 Null。 data.[]stoppedAt string 是 执行停止的时间。状态为 new、running 或 unknown 时为 Null；waiting 状态的执行已停止当前这轮运行，因此有此时间值。 data.[]workflowId string 是 data.[]waitTill string 是 等待中的执行恢复运行的时间。 data.[]storedAt string 否 执行数据的存储位置。 可选值：db, fs, s3, az data.[]jsonSizeBytes number 否 已存储执行数据的大小，单位为字节；0 表示未知。 data.[]workflowVersionId string 否 此执行所运行的工作流版本 ID。 data.[]data object 否 详细执行数据，仅当 includeData 为 true 时包含。 展开字段 字段 类型 必填 说明 data.[]data.redactionInfo object 否 执行数据已被遮蔽时返回。 data.[]workflowData object 否 执行运行时保存的工作流。仅当 includeData 为 true 时包含。较早执行记录携带的字段比新执行记录更多。 data.[]customData object 否 由工作流设置的执行元数据，仅当 includeData 为 true 时包含。 data.[]dataTooLargeToDisplay boolean 否 执行数据超过 EXECUTIONS_DATA_MAX_DISPLAY_SIZE 时返回，值为 true。此时 data 为空，jsonSizeBytes 保存实际大小。仍需读取数据时，使用 ignoreDataSizeLimit。
nextCursor	string	是	将 cursor 参数设为先前请求返回的 nextCursor 属性，以对执行记录进行分页。使用默认值时，获取集合的第一页。

下载完整 OpenAPI 定义（JSON）

获取执行记录

获取实例中的某条执行记录。

GET/executions/{executionId}

请求参数

参数	位置	类型	必填	说明
executionId	path	integer	是	执行的 ID。
includeData	query	string	否	是否包含执行的详细数据。 默认值："false" 可选值：true, false
ignoreDataSizeLimit	query	string	否	即使执行数据超过配置的大小限制（EXECUTIONS_DATA_MAX_DISPLAY_SIZE），是否仍返回完整数据。否则，超出大小限制的执行记录将不包含其数据。 默认值："false" 可选值：true, false
redactExecutionData	query	string	否	控制执行数据遮蔽。为 true 时，始终遮蔽执行输出数据；为 false 时，请求未遮蔽的数据（显示原始数据），需要 execution:reveal 作用域。省略时遵循工作流的遮蔽策略。 可选值：true, false

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是
finished	boolean	是	执行是否已运行完成。请改用 status。
mode	string	是	可选值：cli, error, integrated, internal, manual, retry, trigger, webhook, evaluation, chat, agent
retryOf	string	是	此执行所重试的原执行 ID。
retrySuccessId	string	是	如果此执行失败，但某次重试成功，则为该成功重试的 ID。
status	string	是	可选值：canceled, crashed, error, new, running, success, unknown, waiting
createdAt	string	是
startedAt	string	是	执行离开队列并开始运行之前为 Null。
stoppedAt	string	是	执行停止的时间。状态为 new、running 或 unknown 时为 Null；waiting 状态的执行已停止当前这轮运行，因此有此时间值。
deletedAt	string	是	始终为 null，不会返回已软删除的执行记录。
workflowId	string	是
waitTill	string	是	等待中的执行恢复运行的时间。
storedAt	string	是	执行数据的存储位置。 可选值：db, fs, s3, az
tracingContext	object	是	随执行传递的 W3C 跟踪上下文。 展开字段 字段 类型 必填 说明 tracingContext.traceparent string 是 tracingContext.tracestate string 否
deduplicationKey	string	是	用于防止创建重复执行的键。
jsonSizeBytes	number	是	已存储执行数据的大小，单位为字节；0 表示未知。
binaryDataSizeBytes	number	是	已存储二进制数据的大小，单位为字节；0 表示未知。
workflowVersionId	string	是	此执行所运行的工作流版本 ID。
usedPrivateCredentials	boolean	是	执行是否使用了未与项目共享的凭据。
data	object	否	详细执行数据，仅当 includeData 为 true 时包含。 展开字段 字段 类型 必填 说明 data.redactionInfo object 否 执行数据已被遮蔽时返回。 展开字段 字段 类型 必填 说明 data.redactionInfo.isRedacted boolean 否 执行数据是否被遮蔽。 data.redactionInfo.reason string 否 遮蔽原因。 data.redactionInfo.canReveal boolean 否 当前用户是否有权显示被遮蔽的原始数据。
customData	object	否	由工作流设置的执行元数据，仅当 includeData 为 true 时包含。
workflowData	object	否	执行运行时保存的工作流。仅当 includeData 为 true 时包含。较早执行记录携带的字段比新执行记录更多。
dataTooLargeToDisplay	boolean	否	执行数据超过 EXECUTIONS_DATA_MAX_DISPLAY_SIZE 时返回，值为 true。此时 data 为空，jsonSizeBytes 保存实际大小。仍需读取数据时，使用 ignoreDataSizeLimit。

下载完整 OpenAPI 定义（JSON）

删除执行记录

从实例中删除执行记录。

DELETE/executions/{executionId}

请求参数

参数	位置	类型	必填	说明
executionId	path	integer	是	执行的 ID。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
id	number	是	被删除执行的 ID。此端点将其作为数字返回，其他所有执行端点则将其作为字符串返回。
finished	boolean	是	执行是否已运行完成。请改用 status。
mode	string	是	可选值：cli, error, integrated, internal, manual, retry, trigger, webhook, evaluation, chat, agent
retryOf	string	是	此执行所重试的原执行 ID。
retrySuccessId	string	是	如果此执行失败，但某次重试成功，则为该成功重试的 ID。
status	string	是	可选值：canceled, crashed, error, new, running, success, unknown, waiting
createdAt	string	是
startedAt	string	是	执行离开队列并开始运行之前为 Null。
stoppedAt	string	是	执行停止的时间。状态为 new、running 或 unknown 时为 Null；waiting 状态的执行已停止当前这轮运行，因此有此时间值。
deletedAt	string	是	始终为 null，不会返回已软删除的执行记录。
workflowId	string	是
waitTill	string	是	等待中的执行恢复运行的时间。
storedAt	string	是	执行数据的存储位置。 可选值：db, fs, s3, az
tracingContext	object	是	随执行传递的 W3C 跟踪上下文。 展开字段 字段 类型 必填 说明 tracingContext.traceparent string 是 tracingContext.tracestate string 否
deduplicationKey	string	是	用于防止创建重复执行的键。
jsonSizeBytes	number	是	已存储执行数据的大小，单位为字节；0 表示未知。
binaryDataSizeBytes	number	是	已存储二进制数据的大小，单位为字节；0 表示未知。
workflowVersionId	string	是	此执行所运行的工作流版本 ID。
usedPrivateCredentials	boolean	是	执行是否使用了未与项目共享的凭据。

下载完整 OpenAPI 定义（JSON）

获取执行标签

获取执行的注释标签。

GET/executions/{executionId}/tags

请求参数

参数	位置	类型	必填	说明
executionId	path	integer	是	执行的 ID。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。

响应结构：200 · application/json

字段	类型	必填	说明
[]id	string	是	只读。
[]name	string	是
[]createdAt	string	是	只读。
[]updatedAt	string	是	只读。

下载完整 OpenAPI 定义（JSON）

更新执行标签

更新执行的注释标签。

PUT/executions/{executionId}/tags

请求参数

参数	位置	类型	必填	说明
executionId	path	integer	是	执行的 ID。

请求体

application/json

字段	类型	必填	说明
[]id	string	是

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
415	不支持的媒体类型。

响应结构：200 · application/json

字段	类型	必填	说明
[]id	string	是	只读。
[]name	string	是
[]createdAt	string	是	只读。
[]updatedAt	string	是	只读。

下载完整 OpenAPI 定义（JSON）

停止多次执行

根据筛选条件停止实例中的多次执行。

POST/executions/stop

请求参数

参数	位置	类型	必填	说明
Idempotency-Key	header	string	否	此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求，会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试，会返回 409。

请求体

application/json

字段	类型	必填	说明
status	array	是	要停止的执行状态数组，至少必须包含一个状态。 可选值：queued, running, waiting
workflowId	string	否	可选的工作流 ID，用于筛选执行。不提供时，会停止所有可访问工作流中的执行。使用字面值 all 与省略此字段效果相同。
startedAfter	string	否	仅停止在此时间之后开始的执行。
startedBefore	string	否	仅停止在此时间之前开始的执行。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
409	冲突
415	不支持的媒体类型。
422	无法处理的实体

响应结构：200 · application/json

字段	类型	必填	说明
stopped	integer	是	成功停止的执行数量。

下载完整 OpenAPI 定义（JSON）

停止执行

按 id 停止某次执行。

POST/executions/{executionId}/stop

请求参数

参数	位置	类型	必填	说明
Idempotency-Key	header	string	否	此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求，会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试，会返回 409。
executionId	path	integer	是	执行的 ID。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
409	冲突
422	无法处理的实体

响应结构：200 · application/json

字段	类型	必填	说明
mode	string	是	可选值：cli, error, integrated, internal, manual, retry, trigger, webhook, evaluation, chat, agent
startedAt	string	是	执行开始的时间。
stoppedAt	string	否	执行停止的时间；未记录停止时间时不返回。
finished	boolean	是	执行是否已运行完成。请改用 status。
status	string	是	可选值：canceled, crashed, error, new, running, success, unknown, waiting

下载完整 OpenAPI 定义（JSON）

重试执行

重试实例中的某次执行。

POST/executions/{executionId}/retry

请求参数

参数	位置	类型	必填	说明
Idempotency-Key	header	string	否	此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求，会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试，会返回 409。
executionId	path	integer	是	执行的 ID。

请求体

application/json

字段	类型	必填	说明
loadWorkflow	boolean	否	是否加载当前保存的工作流执行，而非使用原执行运行时保存的工作流。设为 true 时，将使用工作流最新版本进行重试。

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
409	冲突
415	不支持的媒体类型。
422	无法处理的实体

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是	重试所启动的新执行 ID。
mode	string	是	可选值：cli, error, integrated, internal, manual, retry, trigger, webhook, evaluation, chat, agent
startedAt	string	是	新执行开始的时间。
workflowId	string	是
finished	boolean	是	执行是否已运行完成。请改用 status。
retryOf	string	是	此执行所重试的原执行 ID。
status	string	是	可选值：canceled, crashed, error, new, running, success, unknown, waiting
waitTill	string	否	等待中的执行恢复运行的时间。
data	object	否	新执行的运行数据。API 密钥所属用户无权读取此工作流的执行记录时不返回。 展开字段 字段 类型 必填 说明 data.redactionInfo object 否 执行数据已被遮蔽时返回。 展开字段 字段 类型 必填 说明 data.redactionInfo.isRedacted boolean 否 执行数据是否被遮蔽。 data.redactionInfo.reason string 否 遮蔽原因。 data.redactionInfo.canReveal boolean 否 当前用户是否有权显示被遮蔽的原始数据。
workflowData	object	否	原执行运行时保存的工作流。loadWorkflow 改变重试所运行的工作流，不改变此字段返回的内容。API 密钥所属用户无权读取此工作流的执行记录时不返回。
customData	object	否	从原执行继承的执行元数据。API 密钥所属用户无权读取此工作流的执行记录时不返回。
annotation	object	否	原执行上的注释。原执行没有注释，或 API 密钥所属用户无权读取此工作流的执行记录时不返回。 展开字段 字段 类型 必填 说明 annotation.id number 是 annotation.vote string 是 原执行上的投票。 可选值：up, down annotation.tags array 是 展开字段 字段 类型 必填 说明 annotation.tags.[]id string 是 annotation.tags.[]name string 是
storedAt	string	是	执行数据的存储位置。 可选值：db, fs, s3, az

下载完整 OpenAPI 定义（JSON）