shalu-agent-workflow/packages/api-service/agent.openapi.json

{
	"openapi": "3.0.3",
	"info": {
		"title": "默认模块",
		"description": "",
		"version": "1.0.0"
	},
	"servers": [
		{
			"url": "/",
			"description": "默认服务器"
		}
	],
	"tags": [
		{
			"name": "Agent",
			"description": "智能体相关接口"
		}
	],
	"paths": {
		"/api/agent/doEditAgent": {
			"post": {
				"summary": "智能体编辑",
				"description": "",
				"tags": ["Agent"],
				"parameters": [
					{
						"name": "Authorization",
						"in": "header",
						"description": "认证令牌",
						"required": false,
						"schema": {
							"type": "string",
							"default": "bpm_client_1473687766939209728",
							"example": "bpm_client_1473687766939209728"
						}
					}
				],
				"responses": {
					"200": {
						"description": "成功响应",
						"content": {
							"application/json": {
								"example": {
									"isSuccess": true,
									"code": 1,
									"result": "20d31522-66e7-463e-81d7-7fb7fd5864f7",
									"isAuthorized": true
								},
								"schema": {
									"type": "object",
									"properties": {
										"isSuccess": {
											"type": "boolean"
										},
										"code": {
											"type": "integer",
											"format": "int32"
										},
										"result": {
											"type": "string",
											"format": "uuid"
										},
										"isAuthorized": {
											"type": "boolean"
										}
									},
									"required": ["isSuccess", "code", "result", "isAuthorized"]
								}
							}
						}
					}
				}
			}
		},
		"/api/agent/doSaveAgentVariables": {
			"post": {
				"summary": "保存智能体变量",
				"description": "",
				"tags": ["Agent"],
				"parameters": [
					{
						"name": "Authorization",
						"in": "header",
						"description": "认证令牌",
						"required": false,
						"schema": {
							"type": "string",
							"default": "bpm_client_1473687766939209728",
							"example": "bpm_client_1473687766939209728"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"type": "object",
								"properties": {
									"appAgentId": {
										"type": "string",
										"format": "uuid"
									},
									"conversation_variables": {
										"type": "array",
										"items": {
											"type": "string"
										}
									},
									"env_variables": {
										"type": "array",
										"items": {
											"type": "object",
											"properties": {
												"name": {
													"type": "string"
												},
												"value": {
													"type": "string"
												},
												"type": {
													"type": "string",
													"enum": ["string", "number", "boolean", "object", "array"]
												}
											},
											"required": ["name", "value", "type"]
										}
									}
								},
								"required": ["appAgentId", "conversation_variables", "env_variables"]
							}
						}
					}
				},
				"responses": {
					"200": {
						"description": "成功响应",
						"content": {
							"application/json": {
								"example": {
									"isSuccess": true,
									"code": 1,
									"isAuthorized": true
								},
								"schema": {
									"type": "object",
									"properties": {
										"isSuccess": {
											"type": "boolean"
										},
										"code": {
											"type": "integer",
											"format": "int32"
										},
										"result": {
											"type": "string"
										},
										"isAuthorized": {
											"type": "boolean"
										}
									},
									"required": ["isSuccess", "code", "result", "isAuthorized"]
								}
							}
						}
					}
				}
			}
		},
		"/api/agent/getAgentInfo": {
			"post": {
				"summary": "获取智能体信息",
				"description": "",
				"tags": ["Agent"],
				"parameters": [
					{
						"name": "Authorization",
						"in": "header",
						"description": "认证令牌",
						"required": false,
						"schema": {
							"type": "string",
							"default": "bpm_client_1473687766939209728",
							"example": "bpm_client_1473687766939209728"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"type": "object",
								"properties": {
									"id": {
										"type": "string",
										"format": "uuid"
									}
								},
								"required": ["id"]
							}
						}
					}
				},
				"responses": {
					"200": {
						"description": "成功响应",
						"content": {
							"application/json": {
								"example": {
									"isSuccess": true,
									"code": 1,
									"result": {
										"conversation_variables": [],
										"edges": [],
										"env_variables": [
											{
												"is_require": false,
												"name": "api_address",
												"type": "string",
												"value": "http://shalu-componenttesting-admin-dev.shalu.com"
											}
										],
										"id": "b3a4aabb-a6b8-47f3-8a32-f45930f7d7b8",
										"name": "测试智能体",
										"nodes": [
											{
												"appAgentId": "b3a4aabb-a6b8-47f3-8a32-f45930f7d7b8",
												"creationTime": "2026-01-28 10:24:45",
												"creatorUserId": "7F8A2BFE-402D-4499-9BB8-2EF7FFC7B993",
												"data": {
													"outputs": [
														{
															"name": "body",
															"describe": "响应内容",
															"type": "string"
														},
														{
															"name": "status_code",
															"describe": "响应状态码",
															"type": "number"
														},
														{
															"name": "headers",
															"describe": "响应头列表 JSON",
															"type": "object"
														}
													],
													"output_can_alter": false,
													"variables": [],
													"method": "post",
													"ssl_verify": false,
													"isInIteration": false,
													"default_value": [],
													"body": {
														"data": [
															{
																"type": "text",
																"value": "{\"name\":\"测试智能体\",\"profilePhoto\":\"1111\",\"remark\":\"描述\",\"viewPort\":{\"x\":10,\"y\":\"10\",\"zoom\":1}}",
																"key": ""
															}
														],
														"type": "json"
													},
													"params": [],
													"title": "HTTP 请求",
													"type": "http-request",
													"error_strategy": "none",
													"retry_config": {
														"max_retries": 3,
														"retry_enabled": false,
														"retry_interval": 100
													},
													"url": "http://shalu-componenttesting-admin-dev.shalu.com/api/agent/doEditAgent",
													"authorization": {
														"type": "none",
														"config": {
															"api_key": "",
															"header": "",
															"type": ""
														}
													},
													"timeout_config": {
														"max_write_timeout": 0,
														"max_read_timeout": 0,
														"max_connect_timeout": 0
													},
													"heads": [
														{
															"name": "Authorization",
															"value": "bpm_client_1473108597171818496"
														}
													],
													"selected": true,
													"desc": "",
													"isInLoop": false
												},
												"height": 40,
												"id": "492048da-6f33-4a36-adc5-cff4b973b053",
												"isDeleted": false,
												"position": {
													"x": 20,
													"y": 30
												},
												"selected": true,
												"type": "custom",
												"updateTime": "2026-01-28 11:00:09",
												"width": 20,
												"zIndex": 1
											}
										],
										"profilePhoto": "1111",
										"viewPort": {
											"x": 10,
											"y": 10,
											"zoom": 1
										}
									},
									"isAuthorized": true
								},
								"schema": {
									"type": "object",
									"properties": {
										"isSuccess": {
											"type": "boolean"
										},
										"code": {
											"type": "integer",
											"format": "int32"
										},
										"result": {
											"type": "object",
											"properties": {
												"conversation_variables": {
													"type": "array",
													"items": {
														"type": "string"
													}
												},
												"edges": {
													"type": "array",
													"items": {
														"type": "string"
													}
												},
												"env_variables": {
													"type": "array",
													"items": {
														"type": "object",
														"properties": {
															"is_require": {
																"type": "boolean"
															},
															"name": {
																"type": "string"
															},
															"type": {
																"type": "string",
																"enum": ["string", "number", "boolean", "object", "array"]
															},
															"value": {
																"type": "string"
															}
														},
														"required": ["name", "type", "value"]
													}
												},
												"id": {
													"type": "string",
													"format": "uuid"
												},
												"name": {
													"type": "string"
												},
												"nodes": {
													"type": "array",
													"items": {
														"$ref": "#/components/schemas/AgentNode"
													}
												},
												"profilePhoto": {
													"type": "string"
												},
												"viewPort": {
													"type": "object",
													"properties": {
														"x": {
															"type": "integer"
														},
														"y": {
															"type": "integer"
														},
														"zoom": {
															"type": "integer"
														}
													},
													"required": ["x", "y", "zoom"]
												}
											},
											"required": ["id", "name", "nodes", "profilePhoto", "viewPort"]
										},
										"isAuthorized": {
											"type": "boolean"
										}
									},
									"required": ["isSuccess", "code", "result", "isAuthorized"]
								}
							}
						}
					}
				}
			}
		},
		"/api/agent/doNewAgentNode": {
			"post": {
				"summary": "智能体添加节点",
				"description": "",
				"tags": ["Agent"],
				"parameters": [
					{
						"name": "Authorization",
						"in": "header",
						"description": "认证令牌",
						"required": false,
						"schema": {
							"type": "string",
							"default": "bpm_client_1473687766939209728",
							"example": "bpm_client_1473687766939209728"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"type": "object",
								"properties": {
									"appAgentId": {
										"type": "string",
										"format": "uuid"
									},
									"position": {
										"type": "object",
										"properties": {
											"x": {
												"type": "integer"
											},
											"y": {
												"type": "integer"
											}
										},
										"required": ["x", "y"]
									},
									"width": {
										"type": "integer"
									},
									"height": {
										"type": "integer"
									},
									"selected": {
										"type": "boolean"
									},
									"nodeType": {
										"type": "string",
										"enum": ["custom", "start", "end", "condition", "task", "http-request"]
									},
									"zIndex": {
										"type": "integer"
									},
									"parentId": {
										"type": "string",
										"format": "uuid"
									}
								},
								"required": [
									"appAgentId",
									"parentId",
									"position",
									"width",
									"height",
									"selected",
									"nodeType",
									"zIndex"
								]
							}
						}
					}
				},
				"responses": {
					"200": {
						"description": "成功响应",
						"content": {
							"application/json": {
								"example": {
									"isSuccess": true,
									"code": 1,
									"isAuthorized": true
								},
								"schema": {
									"type": "object",
									"properties": {
										"isSuccess": {
											"type": "boolean"
										},
										"code": {
											"type": "integer",
											"format": "int32"
										},
										"isAuthorized": {
											"type": "boolean"
										}
									},
									"required": ["isSuccess", "code", "isAuthorized"]
								}
							}
						}
					}
				}
			}
		},
		"/api/agent/doUpdateAgentNode": {
			"post": {
				"summary": "更新智能体节点",
				"description": "",
				"tags": ["Agent"],
				"parameters": [
					{
						"name": "Authorization",
						"in": "header",
						"description": "认证令牌",
						"required": false,
						"schema": {
							"type": "string",
							"default": "bpm_client_1473687766939209728",
							"example": "bpm_client_1473687766939209728"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"type": "object",
								"properties": {
									"id": {
										"type": "string",
										"format": "uuid"
									},
									"appAgentId": {
										"type": "string",
										"format": "uuid"
									},
									"parentId": {
										"type": "string",
										"format": "uuid"
									},
									"position": {
										"type": "object",
										"properties": {
											"x": {
												"type": "integer"
											},
											"y": {
												"type": "integer"
											}
										},
										"required": ["x", "y"]
									},
									"width": {
										"type": "integer"
									},
									"height": {
										"type": "integer"
									},
									"selected": {
										"type": "boolean"
									},
									"nodeType": {
										"type": "string",
										"enum": ["custom", "start", "end", "condition", "task", "http-request"]
									},
									"zIndex": {
										"type": "integer"
									},
									"data": {
										"type": "object"
									}
								},
								"required": [
									"id",
									"appAgentId",
									"parentId",
									"position",
									"width",
									"height",
									"selected",
									"nodeType",
									"zIndex",
									"data"
								]
							}
						}
					}
				},
				"responses": {
					"200": {
						"description": "成功响应",
						"content": {
							"application/json": {
								"example": {
									"isSuccess": true,
									"code": 1,
									"isAuthorized": true
								},
								"schema": {
									"type": "object",
									"properties": {
										"isSuccess": {
											"type": "boolean"
										},
										"code": {
											"type": "integer",
											"format": "int32"
										},
										"isAuthorized": {
											"type": "boolean"
										}
									},
									"required": ["isSuccess", "code", "isAuthorized"]
								}
							}
						}
					}
				}
			}
		},
		"/api/agent/doTestNodeRunner": {
			"post": {
				"summary": "测试运行智能体节点",
				"description": "",
				"tags": ["Agent"],
				"parameters": [
					{
						"name": "Authorization",
						"in": "header",
						"description": "认证令牌",
						"required": false,
						"schema": {
							"type": "string",
							"default": "bpm_client_1473687766939209728",
							"example": "bpm_client_1473687766939209728"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"type": "object",
								"properties": {
									"id": {
										"type": "string",
										"format": "uuid"
									},
									"appAgentId": {
										"type": "string",
										"format": "uuid"
									}
								},
								"required": ["id", "appAgentId"]
							}
						}
					}
				},
				"responses": {
					"200": {
						"description": "成功响应",
						"content": {
							"application/json": {
								"example": {
									"isSuccess": true,
									"code": 1,
									"isAuthorized": true
								},
								"schema": {
									"type": "object",
									"properties": {
										"isSuccess": {
											"type": "boolean"
										},
										"code": {
											"type": "integer",
											"format": "int32"
										},
										"isAuthorized": {
											"type": "boolean"
										}
									},
									"required": ["isSuccess", "code", "isAuthorized"]
								}
							}
						}
					}
				}
			}
		}
	},
	"components": {
		"schemas": {
			"AgentNode": {
				"type": "object",
				"properties": {
					"appAgentId": {
						"type": "string",
						"format": "uuid"
					},
					"creationTime": {
						"type": "string",
						"format": "date-time"
					},
					"creatorUserId": {
						"type": "string",
						"format": "uuid"
					},
					"data": {
						"$ref": "#/components/schemas/NodeData"
					},
					"height": {
						"type": "integer"
					},
					"id": {
						"type": "string",
						"format": "uuid"
					},
					"isDeleted": {
						"type": "boolean"
					},
					"position": {
						"type": "object",
						"properties": {
							"x": {
								"type": "integer"
							},
							"y": {
								"type": "integer"
							}
						},
						"required": ["x", "y"]
					},
					"selected": {
						"type": "boolean"
					},
					"type": {
						"type": "string",
						"enum": ["custom", "start", "end", "condition", "task", "http-request"]
					},
					"updateTime": {
						"type": "string",
						"format": "date-time"
					},
					"width": {
						"type": "integer"
					},
					"zIndex": {
						"type": "integer"
					}
				},
				"required": [
					"appAgentId",
					"creationTime",
					"creatorUserId",
					"data",
					"id",
					"position",
					"type"
				]
			},
			"NodeData": {
				"type": "object",
				"properties": {
					"outputs": {
						"type": "array",
						"items": {
							"type": "object",
							"properties": {
								"name": {
									"type": "string"
								},
								"describe": {
									"type": "string"
								},
								"type": {
									"type": "string",
									"enum": ["string", "number", "boolean", "object", "array"]
								}
							},
							"required": ["name", "describe", "type"]
						}
					},
					"output_can_alter": {
						"type": "boolean"
					},
					"variables": {
						"type": "array",
						"items": {
							"type": "string"
						}
					},
					"method": {
						"type": "string",
						"enum": ["get", "post", "put", "delete", "patch", "head", "options"]
					},
					"ssl_verify": {
						"type": "boolean"
					},
					"isInIteration": {
						"type": "boolean"
					},
					"default_value": {
						"type": "array",
						"items": {
							"type": "string"
						}
					},
					"body": {
						"$ref": "#/components/schemas/RequestBody"
					},
					"params": {
						"type": "array",
						"items": {
							"type": "string"
						}
					},
					"title": {
						"type": "string"
					},
					"type": {
						"type": "string",
						"enum": ["http-request", "condition", "task"]
					},
					"error_strategy": {
						"type": "string",
						"enum": ["none", "retry", "abort", "continue"]
					},
					"retry_config": {
						"type": "object",
						"properties": {
							"max_retries": {
								"type": "integer",
								"minimum": 0,
								"maximum": 10
							},
							"retry_enabled": {
								"type": "boolean"
							},
							"retry_interval": {
								"type": "integer",
								"minimum": 0,
								"maximum": 5000
							}
						},
						"required": ["max_retries", "retry_enabled", "retry_interval"]
					},
					"url": {
						"type": "string",
						"format": "uri"
					},
					"authorization": {
						"type": "object",
						"properties": {
							"type": {
								"type": "string",
								"enum": ["none", "bearer", "basic", "api-key"]
							},
							"config": {
								"type": "object",
								"properties": {
									"api_key": {
										"type": "string"
									},
									"header": {
										"type": "string"
									},
									"type": {
										"type": "string"
									}
								}
							}
						},
						"required": ["type", "config"]
					},
					"timeout_config": {
						"type": "object",
						"properties": {
							"max_write_timeout": {
								"type": "integer",
								"minimum": 0
							},
							"max_read_timeout": {
								"type": "integer",
								"minimum": 0
							},
							"max_connect_timeout": {
								"type": "integer",
								"minimum": 0
							}
						},
						"required": ["max_write_timeout", "max_read_timeout", "max_connect_timeout"]
					},
					"heads": {
						"type": "array",
						"items": {
							"$ref": "#/components/schemas/HttpHeader"
						}
					},
					"selected": {
						"type": "boolean"
					},
					"desc": {
						"type": "string"
					},
					"isInLoop": {
						"type": "boolean"
					}
				},
				"required": ["outputs", "method", "title", "type", "url"]
			},
			"RequestBody": {
				"type": "object",
				"properties": {
					"data": {
						"type": "array",
						"items": {
							"$ref": "#/components/schemas/RequestDataItem"
						}
					},
					"type": {
						"type": "string",
						"enum": ["json", "form-data", "x-www-form-urlencoded", "raw", "binary"]
					}
				},
				"required": ["data", "type"]
			},
			"RequestDataItem": {
				"type": "object",
				"properties": {
					"type": {
						"type": "string",
						"enum": ["text", "file", "json"]
					},
					"value": {
						"type": "string"
					},
					"key": {
						"type": "string"
					}
				},
				"required": ["type", "value"]
			},
			"HttpHeader": {
				"type": "object",
				"properties": {
					"name": {
						"type": "string"
					},
					"value": {
						"type": "string"
					}
				},
				"required": ["name", "value"]
			}
		},
		"securitySchemes": {
			"ApiKeyAuth": {
				"type": "apiKey",
				"in": "header",
				"name": "Authorization"
			}
		}
	},
	"security": [
		{
			"ApiKeyAuth": []
		}
	]
}