本页内容

API参考:AI

AI端点会异步运行AI提示,您可以通过轮询获取结果。

启动直接AI提示(异步;使用相同请求正文轮询POST …/ai/{promptType}/status)

端点: POST /v1/tenant/{tenantId}/ai/{promptType}

**身份验证:**环境范围API密钥 · write权限范围

参数:

名称 类型 位置 必填 说明
tenantId string path 是 格式:uuid
promptType processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit path 是 允许的值:processAnalysis、processQuestion、aiSummary、processDocumentation、processRaci、processMetaEdit

请求正文:

{
	"prompt": "string",
	"summaryVariant": "string"
}
字段 类型 必填 说明
prompt string 是 自然语言提示
最大长度:10000
summaryVariant string 否

响应(200):

AI结果(状态:success | generating | error)

{
	"status": "success",
	"result": {
		"type": "processAnalysis",
		"analysis": "string"
	},
	"error": "string"
}
字段 类型 必填 说明
status success | error | generating 是 允许的值:success、error、generating
result object | object | object | object | object | object 否 与提示类型对应的结果数据(状态为success时返回)
error string 否 状态为error时的错误消息

错误:

  • 401 API密钥缺失、无效、已停用或已过期
  • 429已达到使用上限

轮询正在进行的AI生成任务(发送与启动任务的POST请求完全相同的正文)

使用POST进行轮询是有意设计的:生成任务由prompt、promptType和summaryVariant共同标识,因此轮询时需重复发送请求正文,而不是使用任务ID。

端点: POST /v1/tenant/{tenantId}/ai/{promptType}/status

**身份验证:**环境范围API密钥 · write权限范围

参数:

名称 类型 位置 必填 说明
tenantId string path 是 格式:uuid
promptType processAnalysis | processQuestion | aiSummary | processDocumentation | processRaci | processMetaEdit path 是 允许的值:processAnalysis、processQuestion、aiSummary、processDocumentation、processRaci、processMetaEdit

请求正文:

{
	"prompt": "string",
	"summaryVariant": "string"
}
字段 类型 必填 说明
prompt string 是 自然语言提示
最大长度:10000
summaryVariant string 否

响应(200):

AI结果(状态:success | generating | error)

{
	"status": "success",
	"result": {
		"type": "processAnalysis",
		"analysis": "string"
	},
	"error": "string"
}
字段 类型 必填 说明
status success | error | generating 是 允许的值:success、error、generating
result object | object | object | object | object | object 否 与提示类型对应的结果数据(状态为success时返回)
error string 否 状态为error时的错误消息

错误:

  • 401 API密钥缺失、无效、已停用或已过期
  • 429已达到使用上限

优化流程,构建互联架构,掌控全局。

无需信用卡,也无需等待,即刻开始。将组织的实际工作方式转化为清晰、互联的流程设计。

构建流程架构,明确职责归属与管控措施,并在各层级统一角色分工。

开始免费试用,为流程治理、管理和持续改进建立可靠的统一基础。