From d895a7124313d0e145de3279575f5ea3cc7beaeb Mon Sep 17 00:00:00 2001
From: john <409225776@qq.com>
Date: 星期二, 27 五月 2025 16:21:23 +0800
Subject: [PATCH] docs: 外部调用工作流文档。
---
docs/zh/product/system/apiKey.md | 64 +++++++++++++++++++++++++++++++
1 files changed, 63 insertions(+), 1 deletions(-)
diff --git a/docs/zh/product/system/apiKey.md b/docs/zh/product/system/apiKey.md
index e553bdb..daa7c01 100644
--- a/docs/zh/product/system/apiKey.md
+++ b/docs/zh/product/system/apiKey.md
@@ -166,4 +166,66 @@
```
-## 閫氳繃 apiKey 璋冪敤宸ヤ綔娴�
\ No newline at end of file
+## 閫氳繃 apiKey 璋冪敤宸ヤ綔娴�
+
+鍙互閫氳繃 apiKey 鍦ㄥ閮ㄨ皟鐢ㄥ伐浣滄祦銆�
+
+### 鑾峰彇鍙傛暟
+璇锋眰鏂瑰紡锛歅OST
+
+璇锋眰鍦板潃锛歨ttp://127.0.0.1:8080/api/v1/aiWorkflow/external/getRunningParams
+
+璇锋眰澶达細
+Headers: {
+Authorization: apiKey
+}
+
+璇锋眰浣擄細id=workflowId
+
+杩斿洖鍊硷細
+```
+{
+ "errorCode": 0,
+ "description": "鏍规嵁杈撳叆鐨処P鍦板潃锛岃幏鍙栬缁嗙殑IP淇℃伅銆�",
+ "title": "鑾峰彇IP淇℃伅",
+ "parameters": [
+ {
+ "dataType": "String",
+ "description": "IP鍦板潃",
+ "id": "3BE5GftyH8y7CUfF",
+ "name": "ipAddress",
+ "refType": "INPUT",
+ "required": true
+ }
+ ]
+}
+```
+### 杩愯
+璇锋眰鏂瑰紡锛歅OST
+
+璇锋眰鍦板潃锛歨ttp://127.0.0.1:8080/api/v1/aiWorkflow/external/run
+
+璇锋眰澶达細
+Headers: {
+Authorization: apiKey
+}
+
+璇锋眰浣擄細
+```
+{
+ "id": "workflowId",
+ "variables": { // 姝ゅ鏄伐浣滄祦鐨勫叆鍙�
+ "ipAddress": "218.86.179.185"
+ }
+}
+```
+
+杩斿洖鍊硷細
+```
+{
+ "result": {
+ ... // 姝ゅ鏄伐浣滄祦鐨勮繑鍥炲��
+ },
+ "errorCode": 0
+}
+```
\ No newline at end of file
--
Gitblit v1.8.0