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

源代码管理

源代码管理相关操作

预览待处理的源代码管理变更

按 `push` 或 `pull` 方向，预览实例与已连接 Git 分支之间的待处理变更。

GET/source-control/status

请求参数

参数	位置	类型	必填	说明
direction	query	string	是	可选值：push, pull

响应

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

响应结构：200 · application/json

字段	类型	必填	说明
data	array	是	展开字段 字段 类型 必填 说明 data.[]file string 是 data.[]id string 是 data.[]name string 是 data.[]type string 是 可选值：credential, workflow, tags, variables, file, folders, project, datatable data.[]status string 是 可选值：new, modified, deleted, created, renamed, conflicted, ignored, staged, unknown data.[]location string 是 可选值：local, remote data.[]conflict boolean 是 data.[]updatedAt string 是 data.[]pushed boolean 否 data.[]isLocalPublished boolean 否 data.[]isRemoteArchived boolean 否 data.[]parentFolderId string 否 data.[]folderPath array 否 data.[]remoteFolderPath array 否 data.[]owner object 否 展开字段 字段 类型 必填 说明 data.[]owner.type string 是 可选值：personal, team data.[]owner.projectId string 是 data.[]owner.projectName string 是 data.[]publishingError string 否 data.[]publishingErrorDetails object 否 展开字段 字段 类型 必填 说明 data.[]publishingErrorDetails.reason string 是 可选值：review_pending, changes_requested, insufficient_api_key_scope, insufficient_permissions data.[]publishingErrorDetails.workflowReviewRequestId string 否 data.[]publishingErrorDetails.versionId string 否 data.[]contentImportPolicy object 否 展开字段 字段 类型 必填 说明 data.[]contentImportPolicy.violations array 是 data.[]contentImportPolicy.checkErrors array 是

下载完整 OpenAPI 定义（JSON）

推送本地源代码管理变更

提交并推送选定文件到已连接的 Git 分支。`fileNames` 中的每一项都依据最新的待处理变更预览来解析。

POST/source-control/push

请求参数

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

请求体

application/json

字段	类型	必填	说明
commitMessage	string	是
fileNames	array	是	展开字段 字段 类型 必填 说明 fileNames.[]id string 是 fileNames.[]type string 是 可选值：credential, workflow, tags, variables, file, folders, project, datatable
force	boolean	否

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
409	推送中包含尚未解决冲突的文件。使用 force: true 重试，可仍然推送。
415	不支持的媒体类型。
422	无法处理的实体

响应结构：200 · application/json

字段	类型	必填	说明
data	array	是	展开字段 字段 类型 必填 说明 data.[]file string 是 data.[]id string 是 data.[]name string 是 data.[]type string 是 可选值：credential, workflow, tags, variables, file, folders, project, datatable data.[]status string 是 可选值：new, modified, deleted, created, renamed, conflicted, ignored, staged, unknown data.[]location string 是 可选值：local, remote data.[]conflict boolean 是 data.[]updatedAt string 是 data.[]pushed boolean 否 data.[]isLocalPublished boolean 否 data.[]isRemoteArchived boolean 否 data.[]parentFolderId string 否 data.[]folderPath array 否 data.[]remoteFolderPath array 否 data.[]owner object 否 展开字段 字段 类型 必填 说明 data.[]owner.type string 是 可选值：personal, team data.[]owner.projectId string 是 data.[]owner.projectName string 是 data.[]publishingError string 否 data.[]publishingErrorDetails object 否 展开字段 字段 类型 必填 说明 data.[]publishingErrorDetails.reason string 是 可选值：review_pending, changes_requested, insufficient_api_key_scope, insufficient_permissions data.[]publishingErrorDetails.workflowReviewRequestId string 否 data.[]publishingErrorDetails.versionId string 否 data.[]contentImportPolicy object 否 展开字段 字段 类型 必填 说明 data.[]contentImportPolicy.violations array 是 data.[]contentImportPolicy.checkErrors array 是

响应结构：409 · application/json

字段	类型	必填	说明
message	string	是
conflicts	array	是	展开字段 字段 类型 必填 说明 conflicts.[]file string 是 conflicts.[]id string 是 conflicts.[]name string 是 conflicts.[]type string 是 可选值：credential, workflow, tags, variables, file, folders, project, datatable conflicts.[]status string 是 可选值：new, modified, deleted, created, renamed, conflicted, ignored, staged, unknown conflicts.[]location string 是 可选值：local, remote conflicts.[]conflict boolean 是 conflicts.[]updatedAt string 是 conflicts.[]pushed boolean 否 conflicts.[]isLocalPublished boolean 否 conflicts.[]isRemoteArchived boolean 否 conflicts.[]parentFolderId string 否 conflicts.[]folderPath array 否 conflicts.[]remoteFolderPath array 否 conflicts.[]owner object 否 展开字段 字段 类型 必填 说明 conflicts.[]owner.type string 是 可选值：personal, team conflicts.[]owner.projectId string 是 conflicts.[]owner.projectName string 是 conflicts.[]publishingError string 否 conflicts.[]publishingErrorDetails object 否 展开字段 字段 类型 必填 说明 conflicts.[]publishingErrorDetails.reason string 是 可选值：review_pending, changes_requested, insufficient_api_key_scope, insufficient_permissions conflicts.[]publishingErrorDetails.workflowReviewRequestId string 否 conflicts.[]publishingErrorDetails.versionId string 否 conflicts.[]contentImportPolicy object 否 展开字段 字段 类型 必填 说明 conflicts.[]contentImportPolicy.violations array 是 conflicts.[]contentImportPolicy.checkErrors array 是

下载完整 OpenAPI 定义（JSON）

从远程仓库拉取变更

将已连接 Git 分支中的变更获取到实例。

POST/source-control/pull

请求参数

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

请求体

application/json

字段	类型	必填	说明
force	boolean	否	丢弃本地变更，并强制完成拉取。
autoPublish	string	否	控制导入后自动发布工作流的方式： none：保留工作流在本地的发布状态（默认）。 all：发布所有导入的工作流。 published：仅发布导入前在本地已发布的工作流。 可选值：none, all, published 默认值："none"

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
409	因未提交的本地变更或合并冲突而发生冲突。响应体列出拉取差异中的每个文件；导致冲突的文件会标有 conflict: true 或 status: modified。使用 force: true 重试，可丢弃本地变更。
415	不支持的媒体类型。
422	无法处理的实体

响应结构：200 · application/json

字段	类型	必填	说明
[]file	string	是
[]id	string	是
[]name	string	是
[]type	string	是	可选值：credential, workflow, tags, variables, file, folders, project, datatable
[]status	string	是	可选值：new, modified, deleted, created, renamed, conflicted, ignored, staged, unknown
[]location	string	是	可选值：local, remote
[]conflict	boolean	是
[]updatedAt	string	是
[]pushed	boolean	否
[]isLocalPublished	boolean	否
[]isRemoteArchived	boolean	否
[]parentFolderId	string	否
[]folderPath	array	否
[]remoteFolderPath	array	否
[]owner	object	否	展开字段 字段 类型 必填 说明 []owner.type string 是 可选值：personal, team []owner.projectId string 是 []owner.projectName string 是
[]publishingError	string	否
[]publishingErrorDetails	object	否	展开字段 字段 类型 必填 说明 []publishingErrorDetails.reason string 是 可选值：review_pending, changes_requested, insufficient_api_key_scope, insufficient_permissions []publishingErrorDetails.workflowReviewRequestId string 否 []publishingErrorDetails.versionId string 否
[]contentImportPolicy	object	否	展开字段 字段 类型 必填 说明 []contentImportPolicy.violations array 是 []contentImportPolicy.checkErrors array 是

响应结构：409 · application/json

字段	类型	必填	说明
[]file	string	是
[]id	string	是
[]name	string	是
[]type	string	是	可选值：credential, workflow, tags, variables, file, folders, project, datatable
[]status	string	是	可选值：new, modified, deleted, created, renamed, conflicted, ignored, staged, unknown
[]location	string	是	可选值：local, remote
[]conflict	boolean	是
[]updatedAt	string	是
[]pushed	boolean	否
[]isLocalPublished	boolean	否
[]isRemoteArchived	boolean	否
[]parentFolderId	string	否
[]folderPath	array	否
[]remoteFolderPath	array	否
[]owner	object	否	展开字段 字段 类型 必填 说明 []owner.type string 是 可选值：personal, team []owner.projectId string 是 []owner.projectName string 是
[]publishingError	string	否
[]publishingErrorDetails	object	否	展开字段 字段 类型 必填 说明 []publishingErrorDetails.reason string 是 可选值：review_pending, changes_requested, insufficient_api_key_scope, insufficient_permissions []publishingErrorDetails.workflowReviewRequestId string 否 []publishingErrorDetails.versionId string 否
[]contentImportPolicy	object	否	展开字段 字段 类型 必填 说明 []contentImportPolicy.violations array 是 []contentImportPolicy.checkErrors array 是

下载完整 OpenAPI 定义（JSON）