model.openapi.json 56 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293
  1. {
  2. "openapi": "3.0.3",
  3. "info": {
  4. "title": "默认模块",
  5. "description": "",
  6. "version": "1.0.0"
  7. },
  8. "servers": [
  9. {
  10. "url": "/",
  11. "description": "默认服务器"
  12. }
  13. ],
  14. "tags": [
  15. {
  16. "name": "ai-model",
  17. "description": "模型管理相关接口"
  18. },
  19. {
  20. "name": "ollama",
  21. "description": "ollama相关接口"
  22. }
  23. ],
  24. "paths": {
  25. "/api/ai/model/providers": {
  26. "post": {
  27. "summary": "根据模型类型获取支持的服务商列表及配置信息",
  28. "deprecated": false,
  29. "description": "",
  30. "tags": ["ai-model"],
  31. "parameters": [
  32. {
  33. "name": "Authorization",
  34. "in": "header",
  35. "description": "",
  36. "example": "bpm_client_1500870842102321152",
  37. "schema": {
  38. "type": "string",
  39. "default": "bpm_client_1500870842102321152"
  40. }
  41. }
  42. ],
  43. "requestBody": {
  44. "content": {
  45. "application/json": {
  46. "schema": {
  47. "type": "object",
  48. "properties": {
  49. "model_type": {
  50. "type": "string"
  51. }
  52. },
  53. "required": ["model_type"]
  54. },
  55. "example": {
  56. "keyword": "",
  57. "type": "",
  58. "source": "",
  59. "pageIndex": 1,
  60. "pageSize": 20
  61. }
  62. }
  63. },
  64. "required": true
  65. },
  66. "responses": {
  67. "200": {
  68. "description": "",
  69. "content": {
  70. "application/json": {
  71. "schema": {
  72. "type": "object",
  73. "properties": {
  74. "isSuccess": {
  75. "type": "boolean"
  76. },
  77. "code": {
  78. "type": "integer"
  79. },
  80. "result": {
  81. "type": "array",
  82. "items": {
  83. "type": "object",
  84. "properties": {
  85. "defaultUrls": {
  86. "type": "object",
  87. "properties": {
  88. "chat": {
  89. "type": "string"
  90. },
  91. "embedding": {
  92. "type": "string"
  93. },
  94. "rerank": {
  95. "type": "string"
  96. },
  97. "vllm": {
  98. "type": "string"
  99. }
  100. },
  101. "required": ["chat", "embedding", "rerank", "vllm"]
  102. },
  103. "description": {
  104. "type": "string"
  105. },
  106. "label": {
  107. "type": "string"
  108. },
  109. "modelTypes": {
  110. "type": "array",
  111. "items": {
  112. "type": "string"
  113. }
  114. },
  115. "value": {
  116. "type": "string"
  117. }
  118. },
  119. "required": ["defaultUrls", "description", "label", "modelTypes", "value"]
  120. }
  121. },
  122. "isAuthorized": {
  123. "type": "boolean"
  124. }
  125. },
  126. "required": ["isSuccess", "code", "result", "isAuthorized"]
  127. },
  128. "example": {
  129. "isSuccess": true,
  130. "code": 1,
  131. "result": [
  132. {
  133. "defaultUrls": {},
  134. "description": "Generic API endpoint (OpenAI-compatible)",
  135. "label": "自定义 (OpenAI兼容接口)",
  136. "modelTypes": ["chat", "embedding", "rerank", "vllm", "asr"],
  137. "value": "generic"
  138. },
  139. {
  140. "defaultUrls": {
  141. "chat": "https://weknora.weixin.qq.com",
  142. "embedding": "https://weknora.weixin.qq.com",
  143. "rerank": "https://weknora.weixin.qq.com",
  144. "vllm": "https://weknora.weixin.qq.com"
  145. },
  146. "description": "WeKnora云服务,模型:chat, embedding, rerank, vlm",
  147. "label": "WeKnoraCloud",
  148. "modelTypes": ["chat", "embedding", "rerank", "vllm"],
  149. "value": "weknoracloud"
  150. },
  151. {
  152. "defaultUrls": {
  153. "chat": "https://dashscope.aliyuncs.com/compatible-mode/v1",
  154. "embedding": "https://dashscope.aliyuncs.com/compatible-mode/v1",
  155. "rerank": "https://dashscope.aliyuncs.com/api/v1/services/rerank/text-rerank/text-rerank",
  156. "vllm": "https://dashscope.aliyuncs.com/compatible-mode/v1"
  157. },
  158. "description": "qwen-plus, tongyi-embedding-vision-plus, qwen3-rerank, etc.",
  159. "label": "阿里云 DashScope",
  160. "modelTypes": ["chat", "embedding", "rerank", "vllm"],
  161. "value": "aliyun"
  162. },
  163. {
  164. "defaultUrls": {
  165. "chat": "https://open.bigmodel.cn/api/paas/v4",
  166. "embedding": "https://open.bigmodel.cn/api/paas/v4",
  167. "rerank": "https://open.bigmodel.cn/api/paas/v4/rerank",
  168. "vllm": "https://open.bigmodel.cn/api/paas/v4"
  169. },
  170. "description": "glm-4.7, embedding-3, rerank, etc.",
  171. "label": "智谱 BigModel",
  172. "modelTypes": ["chat", "embedding", "rerank", "vllm"],
  173. "value": "zhipu"
  174. },
  175. {
  176. "defaultUrls": {
  177. "chat": "https://ark.cn-beijing.volces.com/api/v3",
  178. "embedding": "https://ark.cn-beijing.volces.com/api/v3/embeddings/multimodal",
  179. "vllm": "https://ark.cn-beijing.volces.com/api/v3"
  180. },
  181. "description": "doubao-1-5-pro-32k-250115, doubao-embedding-vision-250615, etc.",
  182. "label": "火山引擎 Volcengine",
  183. "modelTypes": ["chat", "embedding", "vllm"],
  184. "value": "volcengine"
  185. },
  186. {
  187. "defaultUrls": {
  188. "chat": "https://api.hunyuan.cloud.tencent.com/v1",
  189. "embedding": "https://api.hunyuan.cloud.tencent.com/v1"
  190. },
  191. "description": "hunyuan-pro, hunyuan-standard, hunyuan-embedding, etc.",
  192. "label": "腾讯混元 Hunyuan",
  193. "modelTypes": ["chat", "embedding"],
  194. "value": "hunyuan"
  195. },
  196. {
  197. "defaultUrls": {
  198. "chat": "https://api.siliconflow.cn/v1",
  199. "embedding": "https://api.siliconflow.cn/v1",
  200. "rerank": "https://api.siliconflow.cn/v1",
  201. "vllm": "https://api.siliconflow.cn/v1"
  202. },
  203. "description": "deepseek-ai/DeepSeek-V3.1, etc.",
  204. "label": "硅基流动 SiliconFlow",
  205. "modelTypes": ["chat", "embedding", "rerank", "vllm", "asr"],
  206. "value": "siliconflow"
  207. },
  208. {
  209. "defaultUrls": {
  210. "chat": "https://api.deepseek.com/v1"
  211. },
  212. "description": "deepseek-chat, deepseek-reasoner, etc.",
  213. "label": "DeepSeek",
  214. "modelTypes": ["chat"],
  215. "value": "deepseek"
  216. },
  217. {
  218. "defaultUrls": {
  219. "chat": "https://api.minimaxi.com/v1"
  220. },
  221. "description": "MiniMax-M2.7, MiniMax-M2.7-highspeed, MiniMax-M2.5, etc.",
  222. "label": "MiniMax",
  223. "modelTypes": ["chat"],
  224. "value": "minimax"
  225. },
  226. {
  227. "defaultUrls": {
  228. "chat": "https://api.moonshot.ai/v1",
  229. "vllm": "https://api.moonshot.ai/v1"
  230. },
  231. "description": "kimi-k2-turbo-preview, moonshot-v1-8k-vision-preview, etc.",
  232. "label": "月之暗面 Moonshot",
  233. "modelTypes": ["chat", "vllm"],
  234. "value": "moonshot"
  235. },
  236. {
  237. "defaultUrls": {
  238. "chat": "https://api-inference.modelscope.cn/v1",
  239. "embedding": "https://api-inference.modelscope.cn/v1",
  240. "vllm": "https://api-inference.modelscope.cn/v1"
  241. },
  242. "description": "Qwen/Qwen3-8B, Qwen/Qwen3-Embedding-8B, etc.",
  243. "label": "魔搭 ModelScope",
  244. "modelTypes": ["chat", "embedding", "vllm"],
  245. "value": "modelscope"
  246. },
  247. {
  248. "defaultUrls": {
  249. "chat": "https://qianfan.baidubce.com/v2",
  250. "embedding": "https://qianfan.baidubce.com/v2",
  251. "rerank": "https://qianfan.baidubce.com/v2",
  252. "vllm": "https://qianfan.baidubce.com/v2"
  253. },
  254. "description": "ernie-5.0-thinking-preview, embedding-v1, bce-reranker-base, etc.",
  255. "label": "百度千帆 Baidu Cloud",
  256. "modelTypes": ["chat", "embedding", "rerank", "vllm"],
  257. "value": "qianfan"
  258. },
  259. {
  260. "defaultUrls": {
  261. "chat": "https://api.qnaigc.com/v1"
  262. },
  263. "description": "deepseek/deepseek-v3.2-251201, z-ai/glm-4.7, etc.",
  264. "label": "七牛云 Qiniu",
  265. "modelTypes": ["chat"],
  266. "value": "qiniu"
  267. },
  268. {
  269. "defaultUrls": {
  270. "chat": "https://api.openai.com/v1",
  271. "embedding": "https://api.openai.com/v1",
  272. "rerank": "https://api.openai.com/v1",
  273. "vllm": "https://api.openai.com/v1"
  274. },
  275. "description": "gpt-5.2, gpt-5-mini, etc.",
  276. "label": "OpenAI",
  277. "modelTypes": ["chat", "embedding", "rerank", "vllm", "asr"],
  278. "value": "openai"
  279. },
  280. {
  281. "defaultUrls": {
  282. "chat": "https://generativelanguage.googleapis.com/v1beta/openai"
  283. },
  284. "description": "gemini-3-flash-preview, gemini-2.5-pro, etc.",
  285. "label": "Google Gemini",
  286. "modelTypes": ["chat"],
  287. "value": "gemini"
  288. },
  289. {
  290. "defaultUrls": {
  291. "chat": "https://openrouter.ai/api/v1",
  292. "embedding": "https://openrouter.ai/api/v1",
  293. "vllm": "https://openrouter.ai/api/v1"
  294. },
  295. "description": "openai/gpt-5.2-chat, google/gemini-3-flash-preview, etc.",
  296. "label": "OpenRouter",
  297. "modelTypes": ["chat", "embedding", "vllm"],
  298. "value": "openrouter"
  299. },
  300. {
  301. "defaultUrls": {
  302. "embedding": "https://api.jina.ai/v1",
  303. "rerank": "https://api.jina.ai/v1"
  304. },
  305. "description": "jina-clip-v1, jina-embeddings-v2-base-zh, etc.",
  306. "label": "Jina",
  307. "modelTypes": ["embedding", "rerank"],
  308. "value": "jina"
  309. },
  310. {
  311. "defaultUrls": {
  312. "chat": "https://api.xiaomimimo.com/v1"
  313. },
  314. "description": "mimo-v2-flash",
  315. "label": "小米 MiMo",
  316. "modelTypes": ["chat"],
  317. "value": "mimo"
  318. },
  319. {
  320. "defaultUrls": {
  321. "chat": "https://api.longcat.chat/openai/v1"
  322. },
  323. "description": "LongCat-Flash-Chat, LongCat-Flash-Thinking, etc.",
  324. "label": "LongCat AI",
  325. "modelTypes": ["chat"],
  326. "value": "longcat"
  327. },
  328. {
  329. "defaultUrls": {
  330. "chat": "https://api.lkeap.cloud.tencent.com/v1"
  331. },
  332. "description": "DeepSeek-R1, DeepSeek-V3 系列模型,支持思维链",
  333. "label": "腾讯云 LKEAP",
  334. "modelTypes": ["chat"],
  335. "value": "lkeap"
  336. },
  337. {
  338. "defaultUrls": {
  339. "chat": "http://your_gpustack_server_url/v1-openai",
  340. "embedding": "http://your_gpustack_server_url/v1-openai",
  341. "rerank": "http://your_gpustack_server_url/v1",
  342. "vllm": "http://your_gpustack_server_url/v1-openai"
  343. },
  344. "description": "Choose your deployed model on GPUStack",
  345. "label": "GPUStack",
  346. "modelTypes": ["chat", "embedding", "rerank", "vllm", "asr"],
  347. "value": "gpustack"
  348. },
  349. {
  350. "defaultUrls": {
  351. "chat": "https://integrate.api.nvidia.com/v1",
  352. "embedding": "https://integrate.api.nvidia.com/v1",
  353. "rerank": "https://ai.api.nvidia.com/v1/retrieval/nvidia/reranking",
  354. "vllm": "https://integrate.api.nvidia.com/v1"
  355. },
  356. "description": "deepseek-ai-deepseek-v3_1, nv-embed-v1, rerank-qa-mistral-4b, etc.",
  357. "label": "NVIDIA",
  358. "modelTypes": ["chat", "embedding", "rerank", "vllm"],
  359. "value": "nvidia"
  360. },
  361. {
  362. "defaultUrls": {
  363. "chat": "https://api.novita.ai/openai/v1",
  364. "embedding": "https://api.novita.ai/openai/v1",
  365. "vllm": "https://api.novita.ai/openai/v1"
  366. },
  367. "description": "moonshotai/kimi-k2.5, zai-org/glm-5, minimax/minimax-m2.7, qwen/qwen3-embedding-0.6b, etc.",
  368. "label": "Novita AI",
  369. "modelTypes": ["chat", "embedding", "vllm"],
  370. "value": "novita"
  371. },
  372. {
  373. "defaultUrls": {
  374. "chat": "https://{resource}.openai.azure.com",
  375. "embedding": "https://{resource}.openai.azure.com",
  376. "rerank": "https://{resource}.openai.azure.com",
  377. "vllm": "https://{resource}.openai.azure.com"
  378. },
  379. "description": "gpt-4o, gpt-4, text-embedding-ada-002, etc.",
  380. "label": "Azure OpenAI",
  381. "modelTypes": ["chat", "embedding", "vllm", "asr"],
  382. "value": "azure_openai"
  383. }
  384. ],
  385. "isAuthorized": true
  386. }
  387. }
  388. },
  389. "headers": {}
  390. }
  391. },
  392. "security": []
  393. }
  394. },
  395. "/api/ai/model/selectList": {
  396. "post": {
  397. "summary": "获取模型选择列表",
  398. "deprecated": false,
  399. "description": "",
  400. "tags": ["ai-model"],
  401. "parameters": [
  402. {
  403. "name": "Authorization",
  404. "in": "header",
  405. "description": "",
  406. "example": "bpm_client_1500870842102321152",
  407. "schema": {
  408. "type": "string",
  409. "default": "bpm_client_1500870842102321152"
  410. }
  411. }
  412. ],
  413. "requestBody": {
  414. "content": {
  415. "application/json": {
  416. "schema": {
  417. "type": "object",
  418. "properties": {
  419. "keyword": {
  420. "type": "string"
  421. },
  422. "type": {
  423. "type": "string"
  424. }
  425. },
  426. "required": []
  427. },
  428. "example": {
  429. "keyword": "",
  430. "type": "",
  431. "source": ""
  432. }
  433. }
  434. },
  435. "required": true
  436. },
  437. "responses": {
  438. "200": {
  439. "description": "",
  440. "content": {
  441. "application/json": {
  442. "schema": {
  443. "type": "object",
  444. "properties": {
  445. "isSuccess": {
  446. "type": "boolean"
  447. },
  448. "code": {
  449. "type": "integer"
  450. },
  451. "result": {
  452. "type": "array",
  453. "items": {
  454. "type": "object",
  455. "properties": {
  456. "creationTime": {
  457. "type": "string"
  458. },
  459. "creatorUserId": {
  460. "type": "string"
  461. },
  462. "description": {
  463. "type": "string"
  464. },
  465. "id": {
  466. "type": "string"
  467. },
  468. "isDeleted": {
  469. "type": "boolean"
  470. },
  471. "is_default": {
  472. "type": "boolean"
  473. },
  474. "name": {
  475. "type": "string"
  476. },
  477. "parameters": {
  478. "type": "object",
  479. "properties": {
  480. "api_key": {
  481. "type": "string"
  482. },
  483. "base_url": {
  484. "type": "string"
  485. },
  486. "embedding_parameters": {
  487. "type": "object",
  488. "properties": {
  489. "dimension": {
  490. "type": "integer"
  491. },
  492. "truncate_prompt_tokens": {
  493. "type": "integer"
  494. }
  495. },
  496. "required": ["dimension", "truncate_prompt_tokens"]
  497. },
  498. "provider": {
  499. "type": "string"
  500. }
  501. },
  502. "required": ["api_key", "base_url", "embedding_parameters", "provider"]
  503. },
  504. "provider": {
  505. "type": "string"
  506. },
  507. "source": {
  508. "type": "string"
  509. },
  510. "status": {
  511. "type": "string"
  512. },
  513. "title": {
  514. "type": "string"
  515. },
  516. "type": {
  517. "type": "string"
  518. },
  519. "updateTime": {
  520. "type": "string"
  521. }
  522. }
  523. }
  524. },
  525. "isAuthorized": {
  526. "type": "boolean"
  527. }
  528. },
  529. "required": ["isSuccess", "code", "result", "isAuthorized"]
  530. },
  531. "example": {
  532. "isSuccess": true,
  533. "code": 1,
  534. "result": [
  535. {
  536. "creationTime": "2026-05-10 10:53:15",
  537. "creatorUserId": "7F8A2BFE-402D-4499-9BB8-2EF7FFC7B993",
  538. "description": "火山引擎 Volcengine-vllm",
  539. "id": "20ce3d44-0f68-45e5-b30c-06df4b402ec2",
  540. "isDeleted": false,
  541. "is_default": false,
  542. "name": "ep-20260415150834-6bp4p",
  543. "parameters": {
  544. "api_key": "45991062-123b-48a7-9764-e3dc7db9b989",
  545. "base_url": "https://ark.cn-beijing.volces.com/api/v3",
  546. "embedding_parameters": {
  547. "dimension": 0,
  548. "truncate_prompt_tokens": 0
  549. },
  550. "provider": "volcengine"
  551. },
  552. "provider": "volcengine",
  553. "source": "remote",
  554. "status": "active",
  555. "title": "火山引擎 Volcengine-vllm",
  556. "type": "VLLM",
  557. "updateTime": "2026-05-10 10:53:15"
  558. }
  559. ],
  560. "isAuthorized": true
  561. }
  562. },
  563. "headers": {}
  564. }
  565. },
  566. "security": []
  567. }
  568. }
  569. },
  570. "/api/ai/model/pageList": {
  571. "post": {
  572. "summary": "获取模型分页列表",
  573. "deprecated": false,
  574. "description": "",
  575. "tags": ["ai-model"],
  576. "parameters": [
  577. {
  578. "name": "Authorization",
  579. "in": "header",
  580. "description": "",
  581. "example": "bpm_client_1500870842102321152",
  582. "schema": {
  583. "type": "string",
  584. "default": "bpm_client_1500870842102321152"
  585. }
  586. }
  587. ],
  588. "requestBody": {
  589. "content": {
  590. "application/json": {
  591. "schema": {
  592. "type": "object",
  593. "properties": {
  594. "keyword": {
  595. "type": "string"
  596. },
  597. "type": {
  598. "type": "string"
  599. },
  600. "source": {
  601. "type": "string"
  602. },
  603. "pageIndex": {
  604. "type": "integer"
  605. },
  606. "pageSize": {
  607. "type": "integer"
  608. }
  609. },
  610. "required": ["keyword", "type", "source", "pageIndex", "pageSize"]
  611. },
  612. "example": {
  613. "keyword": "",
  614. "type": "",
  615. "source": "",
  616. "pageIndex": 1,
  617. "pageSize": 20
  618. }
  619. }
  620. },
  621. "required": true
  622. },
  623. "responses": {
  624. "200": {
  625. "description": "",
  626. "content": {
  627. "application/json": {
  628. "schema": {
  629. "type": "object",
  630. "properties": {
  631. "isSuccess": {
  632. "type": "boolean"
  633. },
  634. "code": {
  635. "type": "integer"
  636. },
  637. "result": {
  638. "type": "object",
  639. "properties": {
  640. "currentPage": {
  641. "type": "integer"
  642. },
  643. "hasNextPage": {
  644. "type": "boolean"
  645. },
  646. "hasPreviousPage": {
  647. "type": "boolean"
  648. },
  649. "model": {
  650. "type": "array",
  651. "items": {
  652. "type": "object",
  653. "properties": {
  654. "creationTime": {
  655. "type": "string"
  656. },
  657. "creatorUserId": {
  658. "type": "string"
  659. },
  660. "description": {
  661. "type": "string"
  662. },
  663. "id": {
  664. "type": "string"
  665. },
  666. "isDeleted": {
  667. "type": "boolean"
  668. },
  669. "is_default": {
  670. "type": "boolean"
  671. },
  672. "name": {
  673. "type": "string"
  674. },
  675. "parameters": {
  676. "type": "object",
  677. "properties": {
  678. "api_key": {
  679. "type": "string"
  680. },
  681. "base_url": {
  682. "type": "string"
  683. },
  684. "embedding_parameters": {
  685. "type": "object",
  686. "properties": {
  687. "dimension": {
  688. "type": "integer"
  689. },
  690. "truncate_prompt_tokens": {
  691. "type": "integer"
  692. }
  693. },
  694. "required": ["dimension", "truncate_prompt_tokens"]
  695. },
  696. "provider": {
  697. "type": "string"
  698. }
  699. },
  700. "required": [
  701. "api_key",
  702. "base_url",
  703. "embedding_parameters",
  704. "provider",
  705. "id"
  706. ]
  707. },
  708. "provider": {
  709. "type": "string"
  710. },
  711. "source": {
  712. "type": "string"
  713. },
  714. "status": {
  715. "type": "string"
  716. },
  717. "title": {
  718. "type": "string"
  719. },
  720. "type": {
  721. "type": "string"
  722. },
  723. "updateTime": {
  724. "type": "string"
  725. }
  726. }
  727. }
  728. },
  729. "pageSize": {
  730. "type": "integer"
  731. },
  732. "totalCount": {
  733. "type": "integer"
  734. },
  735. "totalPages": {
  736. "type": "integer"
  737. }
  738. },
  739. "required": [
  740. "currentPage",
  741. "hasNextPage",
  742. "hasPreviousPage",
  743. "model",
  744. "pageSize",
  745. "totalCount",
  746. "totalPages"
  747. ]
  748. },
  749. "isAuthorized": {
  750. "type": "boolean"
  751. }
  752. },
  753. "required": ["isSuccess", "code", "result", "isAuthorized"]
  754. },
  755. "example": {
  756. "isSuccess": true,
  757. "code": 1,
  758. "result": {
  759. "currentPage": 1,
  760. "hasNextPage": true,
  761. "hasPreviousPage": false,
  762. "model": [
  763. {
  764. "creationTime": "2026-05-10 10:53:15",
  765. "creatorUserId": "7F8A2BFE-402D-4499-9BB8-2EF7FFC7B993",
  766. "description": "火山引擎 Volcengine-vllm",
  767. "id": "20ce3d44-0f68-45e5-b30c-06df4b402ec2",
  768. "isDeleted": false,
  769. "is_default": false,
  770. "name": "ep-20260415150834-6bp4p",
  771. "parameters": {
  772. "api_key": "45991062-123b-48a7-9764-e3dc7db9b989",
  773. "base_url": "https://ark.cn-beijing.volces.com/api/v3",
  774. "embedding_parameters": {
  775. "dimension": 0,
  776. "truncate_prompt_tokens": 0
  777. },
  778. "provider": "volcengine"
  779. },
  780. "provider": "volcengine",
  781. "source": "remote",
  782. "status": "active",
  783. "title": "火山引擎 Volcengine-vllm",
  784. "type": "VLLM",
  785. "updateTime": "2026-05-10 10:53:15"
  786. }
  787. ],
  788. "pageSize": 20,
  789. "totalCount": 1,
  790. "totalPages": 1
  791. },
  792. "isAuthorized": true
  793. }
  794. }
  795. },
  796. "headers": {}
  797. }
  798. },
  799. "security": []
  800. }
  801. },
  802. "/api/ai/model/info": {
  803. "post": {
  804. "summary": "模型详情",
  805. "deprecated": false,
  806. "description": "",
  807. "tags": ["ai-model"],
  808. "parameters": [
  809. {
  810. "name": "Authorization",
  811. "in": "header",
  812. "description": "",
  813. "example": "bpm_client_1500870842102321152",
  814. "schema": {
  815. "type": "string",
  816. "default": "bpm_client_1500870842102321152"
  817. }
  818. }
  819. ],
  820. "requestBody": {
  821. "content": {
  822. "application/json": {
  823. "schema": {
  824. "type": "object",
  825. "properties": {
  826. "id": {
  827. "type": "string"
  828. }
  829. },
  830. "required": ["id"]
  831. },
  832. "example": {
  833. "id": "287edb39-8f5d-4b0c-81be-f1b7517ae08a"
  834. }
  835. }
  836. },
  837. "required": true
  838. },
  839. "responses": {
  840. "200": {
  841. "description": "",
  842. "content": {
  843. "application/json": {
  844. "schema": {
  845. "type": "object",
  846. "properties": {
  847. "isSuccess": {
  848. "type": "boolean"
  849. },
  850. "code": {
  851. "type": "integer"
  852. },
  853. "result": {
  854. "type": "object",
  855. "properties": {
  856. "creationTime": {
  857. "type": "string"
  858. },
  859. "creatorUserId": {
  860. "type": "string"
  861. },
  862. "description": {
  863. "type": "string"
  864. },
  865. "id": {
  866. "type": "string"
  867. },
  868. "isDeleted": {
  869. "type": "boolean"
  870. },
  871. "is_default": {
  872. "type": "boolean"
  873. },
  874. "name": {
  875. "type": "string"
  876. },
  877. "parameters": {
  878. "type": "object",
  879. "properties": {
  880. "api_key": {
  881. "type": "string"
  882. },
  883. "base_url": {
  884. "type": "string"
  885. },
  886. "embedding_parameters": {
  887. "type": "object",
  888. "properties": {
  889. "dimension": {
  890. "type": "integer"
  891. },
  892. "truncate_prompt_tokens": {
  893. "type": "integer"
  894. }
  895. },
  896. "required": ["dimension", "truncate_prompt_tokens"]
  897. },
  898. "provider": {
  899. "type": "string"
  900. }
  901. },
  902. "required": ["api_key", "base_url", "embedding_parameters", "provider"]
  903. },
  904. "provider": {
  905. "type": "string"
  906. },
  907. "source": {
  908. "type": "string"
  909. },
  910. "status": {
  911. "type": "string"
  912. },
  913. "title": {
  914. "type": "string"
  915. },
  916. "type": {
  917. "type": "string"
  918. },
  919. "updateTime": {
  920. "type": "string"
  921. }
  922. },
  923. "required": [
  924. "creationTime",
  925. "creatorUserId",
  926. "description",
  927. "id",
  928. "isDeleted",
  929. "is_default",
  930. "name",
  931. "parameters",
  932. "provider",
  933. "source",
  934. "status",
  935. "title",
  936. "type",
  937. "updateTime"
  938. ]
  939. },
  940. "isAuthorized": {
  941. "type": "boolean"
  942. }
  943. },
  944. "required": ["isSuccess", "code", "result", "isAuthorized"]
  945. },
  946. "example": {
  947. "isSuccess": true,
  948. "code": 1,
  949. "result": {
  950. "creationTime": "2026-05-10 18:41:24",
  951. "creatorUserId": "7F8A2BFE-402D-4499-9BB8-2EF7FFC7B993",
  952. "description": "火山引擎 Volcengine-vllm",
  953. "id": "287edb39-8f5d-4b0c-81be-f1b7517ae08a",
  954. "isDeleted": false,
  955. "is_default": false,
  956. "name": "ep-20260415150834-6bp4p",
  957. "parameters": {
  958. "api_key": "45991062-123b-48a7-9764-e3dc7db9b989",
  959. "base_url": "https://ark.cn-beijing.volces.com/api/v3",
  960. "embedding_parameters": {
  961. "dimension": 0,
  962. "truncate_prompt_tokens": 0
  963. },
  964. "provider": "volcengine"
  965. },
  966. "provider": "volcengine",
  967. "source": "remote",
  968. "status": "active",
  969. "title": "火山引擎 Volcengine-vllm",
  970. "type": "VLLM",
  971. "updateTime": "2026-05-10 18:41:24"
  972. },
  973. "isAuthorized": true
  974. }
  975. }
  976. },
  977. "headers": {}
  978. }
  979. },
  980. "security": []
  981. }
  982. },
  983. "/api/ai/model/create": {
  984. "post": {
  985. "summary": "创建模型",
  986. "deprecated": false,
  987. "description": "",
  988. "tags": ["ai-model"],
  989. "parameters": [
  990. {
  991. "name": "Authorization",
  992. "in": "header",
  993. "description": "",
  994. "example": "bpm_client_1500870842102321152",
  995. "schema": {
  996. "type": "string",
  997. "default": "bpm_client_1500870842102321152"
  998. }
  999. }
  1000. ],
  1001. "requestBody": {
  1002. "content": {
  1003. "application/json": {
  1004. "schema": {
  1005. "type": "object",
  1006. "properties": {
  1007. "name": {
  1008. "type": "string"
  1009. },
  1010. "title": {
  1011. "type": "string"
  1012. },
  1013. "description": {
  1014. "type": "string"
  1015. },
  1016. "type": {
  1017. "type": "string"
  1018. },
  1019. "source": {
  1020. "type": "string"
  1021. },
  1022. "provider": {
  1023. "type": "string"
  1024. },
  1025. "base_url": {
  1026. "type": "string"
  1027. },
  1028. "api_key": {
  1029. "type": "string"
  1030. },
  1031. "custom_headers": {
  1032. "type": "object",
  1033. "properties": {}
  1034. }
  1035. },
  1036. "required": [
  1037. "name",
  1038. "title",
  1039. "description",
  1040. "type",
  1041. "source",
  1042. "provider",
  1043. "base_url",
  1044. "api_key",
  1045. "custom_headers"
  1046. ]
  1047. },
  1048. "examples": {
  1049. "1": {
  1050. "value": {
  1051. "name": "ep-20250312153410-5vdmg",
  1052. "title": "火山引擎-deepseek-v3",
  1053. "description": "火山引擎-deepseek-v3",
  1054. "type": "KnowledgeQA",
  1055. "source": "remote",
  1056. "provider": "volcengine",
  1057. "base_url": "https://ark.cn-beijing.volces.com/api/v3",
  1058. "api_key": "45991062-123b-48a7-9764-e3dc7db9b989",
  1059. "custom_headers": {}
  1060. },
  1061. "summary": "对话模型"
  1062. },
  1063. "2": {
  1064. "value": {
  1065. "name": "text-embedding-v4",
  1066. "title": "阿里云-embedding",
  1067. "description": "阿里云-embedding",
  1068. "type": "Embedding",
  1069. "source": "remote",
  1070. "provider": "aliyun",
  1071. "base_url": "https://dashscope.aliyuncs.com/compatible-mode/v1",
  1072. "api_key": "sk-42e82e5b8f3a48b98ff07244989b5725",
  1073. "dimension": 1024,
  1074. "truncate_prompt_tokens": 0,
  1075. "custom_headers": {}
  1076. },
  1077. "summary": "Embedding模型"
  1078. },
  1079. "3": {
  1080. "value": {
  1081. "name": "qwen3-vl-rerank",
  1082. "title": "阿里云-rerank",
  1083. "description": "阿里云-rerank",
  1084. "type": "Rerank",
  1085. "source": "remote",
  1086. "provider": "aliyun",
  1087. "base_url": "https://dashscope.aliyuncs.com/api/v1/services/rerank/text-rerank/text-rerank",
  1088. "api_key": "sk-42e82e5b8f3a48b98ff07244989b5725",
  1089. "custom_headers": {}
  1090. },
  1091. "summary": "Rerank模型"
  1092. },
  1093. "4": {
  1094. "value": {
  1095. "name": "ep-20260415150834-6bp4p",
  1096. "title": "火山引擎 Volcengine-vllm",
  1097. "description": "火山引擎 Volcengine-vllm",
  1098. "type": "VLLM",
  1099. "source": "remote",
  1100. "provider": "volcengine",
  1101. "base_url": "https://ark.cn-beijing.volces.com/api/v3",
  1102. "api_key": "45991062-123b-48a7-9764-e3dc7db9b989",
  1103. "custom_headers": {}
  1104. },
  1105. "summary": "视觉模型"
  1106. }
  1107. }
  1108. }
  1109. },
  1110. "required": true
  1111. },
  1112. "responses": {
  1113. "200": {
  1114. "description": "",
  1115. "content": {
  1116. "application/json": {
  1117. "schema": {
  1118. "type": "object",
  1119. "properties": {
  1120. "isSuccess": {
  1121. "type": "boolean"
  1122. },
  1123. "code": {
  1124. "type": "integer"
  1125. },
  1126. "isAuthorized": {
  1127. "type": "boolean"
  1128. }
  1129. },
  1130. "required": ["isSuccess", "code", "isAuthorized"]
  1131. },
  1132. "example": {
  1133. "isSuccess": true,
  1134. "code": 1,
  1135. "isAuthorized": true
  1136. }
  1137. }
  1138. },
  1139. "headers": {}
  1140. }
  1141. },
  1142. "security": []
  1143. }
  1144. },
  1145. "/api/ai/model/update": {
  1146. "post": {
  1147. "summary": "更新模型",
  1148. "deprecated": false,
  1149. "description": "",
  1150. "tags": ["ai-model"],
  1151. "parameters": [
  1152. {
  1153. "name": "Authorization",
  1154. "in": "header",
  1155. "description": "",
  1156. "example": "bpm_client_1500870842102321152",
  1157. "schema": {
  1158. "type": "string",
  1159. "default": "bpm_client_1500870842102321152"
  1160. }
  1161. }
  1162. ],
  1163. "requestBody": {
  1164. "content": {
  1165. "application/json": {
  1166. "schema": {
  1167. "type": "object",
  1168. "properties": {
  1169. "id": {
  1170. "type": "string"
  1171. },
  1172. "name": {
  1173. "type": "string"
  1174. },
  1175. "title": {
  1176. "type": "string"
  1177. },
  1178. "description": {
  1179. "type": "string"
  1180. },
  1181. "base_url": {
  1182. "type": "string"
  1183. },
  1184. "api_key": {
  1185. "type": "string"
  1186. },
  1187. "custom_headers": {
  1188. "type": "object",
  1189. "properties": {}
  1190. }
  1191. },
  1192. "required": [
  1193. "id",
  1194. "name",
  1195. "title",
  1196. "description",
  1197. "base_url",
  1198. "api_key",
  1199. "custom_headers"
  1200. ]
  1201. },
  1202. "examples": {
  1203. "1": {
  1204. "value": {
  1205. "id": "4d9606c9-42ac-485e-b2ce-2bf5e2b109f7",
  1206. "name": "ep-20250312153410-5vdmg",
  1207. "title": "新的火山引擎-deepseek-v3",
  1208. "description": "新的火山引擎-deepseek-v3",
  1209. "base_url": "https://ark.cn-beijing.volces.com/api/v3",
  1210. "api_key": "45991062-123b-48a7-9764-e3dc7db9b989",
  1211. "custom_headers": {}
  1212. },
  1213. "summary": "对话模型"
  1214. },
  1215. "2": {
  1216. "value": {
  1217. "id": "40be5435-929e-4c81-8f01-d3be8df4ad34",
  1218. "name": "text-embedding-v4",
  1219. "title": "阿里云-embedding",
  1220. "description": "阿里云-embedding",
  1221. "base_url": "https://dashscope.aliyuncs.com/compatible-mode/v1",
  1222. "api_key": "sk-42e82e5b8f3a48b98ff07244989b5725",
  1223. "dimension": 1024,
  1224. "truncate_prompt_tokens": 0,
  1225. "custom_headers": {}
  1226. },
  1227. "summary": "Embedding模型"
  1228. },
  1229. "3": {
  1230. "value": {
  1231. "id": "211afd74-45d6-443f-969e-8624aa9f5c0a",
  1232. "name": "qwen3-vl-rerank",
  1233. "title": "阿里云-rerank",
  1234. "description": "阿里云-rerank",
  1235. "base_url": "https://dashscope.aliyuncs.com/api/v1/services/rerank/text-rerank/text-rerank",
  1236. "api_key": "sk-42e82e5b8f3a48b98ff07244989b5725",
  1237. "custom_headers": {}
  1238. },
  1239. "summary": "Rerank模型"
  1240. },
  1241. "4": {
  1242. "value": {
  1243. "id": "081412f6-d5cf-4c84-bc0d-ccaab3065d7b",
  1244. "name": "ep-20260415150834-6bp4p",
  1245. "title": "火山引擎 Volcengine-vllm",
  1246. "description": "火山引擎 Volcengine-vllm",
  1247. "base_url": "https://ark.cn-beijing.volces.com/api/v3",
  1248. "api_key": "45991062-123b-48a7-9764-e3dc7db9b989",
  1249. "custom_headers": {}
  1250. },
  1251. "summary": "视觉模型"
  1252. }
  1253. }
  1254. }
  1255. },
  1256. "required": true
  1257. },
  1258. "responses": {
  1259. "200": {
  1260. "description": "",
  1261. "content": {
  1262. "application/json": {
  1263. "schema": {
  1264. "type": "object",
  1265. "properties": {
  1266. "isSuccess": {
  1267. "type": "boolean"
  1268. },
  1269. "code": {
  1270. "type": "integer"
  1271. },
  1272. "isAuthorized": {
  1273. "type": "boolean"
  1274. }
  1275. },
  1276. "required": ["isSuccess", "code", "isAuthorized"]
  1277. },
  1278. "example": {
  1279. "isSuccess": true,
  1280. "code": 1,
  1281. "isAuthorized": true
  1282. }
  1283. }
  1284. },
  1285. "headers": {}
  1286. }
  1287. },
  1288. "security": []
  1289. }
  1290. },
  1291. "/api/ai/model/delete": {
  1292. "post": {
  1293. "summary": "删除模型",
  1294. "deprecated": false,
  1295. "description": "",
  1296. "tags": ["ai-model"],
  1297. "parameters": [
  1298. {
  1299. "name": "Authorization",
  1300. "in": "header",
  1301. "description": "",
  1302. "example": "bpm_client_1500870842102321152",
  1303. "schema": {
  1304. "type": "string",
  1305. "default": "bpm_client_1500870842102321152"
  1306. }
  1307. }
  1308. ],
  1309. "requestBody": {
  1310. "content": {
  1311. "application/json": {
  1312. "schema": {
  1313. "type": "object",
  1314. "properties": {
  1315. "id": {
  1316. "type": "string"
  1317. }
  1318. },
  1319. "required": ["id"]
  1320. },
  1321. "example": {
  1322. "id": "081412f6-d5cf-4c84-bc0d-ccaab3065d7b"
  1323. }
  1324. }
  1325. },
  1326. "required": true
  1327. },
  1328. "responses": {
  1329. "200": {
  1330. "description": "",
  1331. "content": {
  1332. "application/json": {
  1333. "schema": {
  1334. "type": "object",
  1335. "properties": {
  1336. "isSuccess": {
  1337. "type": "boolean"
  1338. },
  1339. "code": {
  1340. "type": "integer"
  1341. },
  1342. "isAuthorized": {
  1343. "type": "boolean"
  1344. }
  1345. },
  1346. "required": ["isSuccess", "code", "isAuthorized"]
  1347. },
  1348. "example": {
  1349. "isSuccess": true,
  1350. "code": 1,
  1351. "isAuthorized": true
  1352. }
  1353. }
  1354. },
  1355. "headers": {}
  1356. }
  1357. },
  1358. "security": []
  1359. }
  1360. },
  1361. "/api/ai/model/check": {
  1362. "post": {
  1363. "summary": "检查模型",
  1364. "deprecated": false,
  1365. "description": "",
  1366. "tags": ["ai-model"],
  1367. "parameters": [
  1368. {
  1369. "name": "Authorization",
  1370. "in": "header",
  1371. "description": "",
  1372. "example": "bpm_client_1500870842102321152",
  1373. "schema": {
  1374. "type": "string",
  1375. "default": "bpm_client_1500870842102321152"
  1376. }
  1377. }
  1378. ],
  1379. "requestBody": {
  1380. "content": {
  1381. "application/json": {
  1382. "schema": {
  1383. "type": "object",
  1384. "properties": {
  1385. "name": {
  1386. "type": "string"
  1387. },
  1388. "type": {
  1389. "type": "string"
  1390. },
  1391. "source": {
  1392. "type": "string"
  1393. },
  1394. "provider": {
  1395. "type": "string"
  1396. },
  1397. "api_key": {
  1398. "type": "string"
  1399. }
  1400. },
  1401. "required": ["name", "type", "source", "provider", "api_key"]
  1402. },
  1403. "examples": {
  1404. "1": {
  1405. "value": {
  1406. "name": "ep-20250312153410-5vdmg",
  1407. "type": "KnowledgeQA",
  1408. "source": "remote",
  1409. "provider": "volcengine",
  1410. "api_key": "45991062-123b-48a7-9764-e3dc7db9b989"
  1411. },
  1412. "summary": "对话模型"
  1413. },
  1414. "2": {
  1415. "value": {
  1416. "name": "text-embedding-v4",
  1417. "type": "Embedding",
  1418. "source": "remote",
  1419. "provider": "aliyun",
  1420. "api_key": "sk-42e82e5b8f3a48b98ff07244989b5725",
  1421. "dimension": 1024,
  1422. "truncate_prompt_tokens": 0
  1423. },
  1424. "summary": "Embedding模型"
  1425. },
  1426. "3": {
  1427. "value": {
  1428. "name": "qwen3-vl-rerank",
  1429. "type": "Rerank",
  1430. "source": "remote",
  1431. "provider": "aliyun",
  1432. "api_key": "sk-42e82e5b8f3a48b98ff07244989b5725"
  1433. },
  1434. "summary": "Rerank模型"
  1435. },
  1436. "4": {
  1437. "value": {
  1438. "name": "ep-20260415150834-6bp4p",
  1439. "type": "VLLM",
  1440. "source": "remote",
  1441. "provider": "volcengine",
  1442. "api_key": "45991062-123b-48a7-9764-e3dc7db9b989"
  1443. },
  1444. "summary": "视觉模型"
  1445. }
  1446. }
  1447. }
  1448. },
  1449. "required": true
  1450. },
  1451. "responses": {
  1452. "200": {
  1453. "description": "",
  1454. "content": {
  1455. "application/json": {
  1456. "schema": {
  1457. "type": "object",
  1458. "properties": {
  1459. "isSuccess": {
  1460. "type": "boolean"
  1461. },
  1462. "code": {
  1463. "type": "integer"
  1464. },
  1465. "isAuthorized": {
  1466. "type": "boolean"
  1467. },
  1468. "result": {
  1469. "type": "object"
  1470. }
  1471. },
  1472. "required": ["isSuccess", "code", "isAuthorized"]
  1473. },
  1474. "example": {
  1475. "isSuccess": true,
  1476. "code": 1,
  1477. "isAuthorized": true
  1478. }
  1479. }
  1480. },
  1481. "headers": {}
  1482. }
  1483. },
  1484. "security": []
  1485. }
  1486. },
  1487. "/api/ai/ollama/status": {
  1488. "post": {
  1489. "summary": "检查Ollama状态",
  1490. "deprecated": false,
  1491. "description": "",
  1492. "tags": ["ollama"],
  1493. "parameters": [
  1494. {
  1495. "name": "Authorization",
  1496. "in": "header",
  1497. "description": "",
  1498. "example": "bpm_client_1500870842102321152",
  1499. "schema": {
  1500. "type": "string",
  1501. "default": "bpm_client_1500870842102321152"
  1502. }
  1503. }
  1504. ],
  1505. "requestBody": {
  1506. "content": {
  1507. "application/json": {
  1508. "schema": {
  1509. "type": "object",
  1510. "properties": {}
  1511. },
  1512. "examples": {}
  1513. }
  1514. },
  1515. "required": true
  1516. },
  1517. "responses": {
  1518. "200": {
  1519. "description": "",
  1520. "content": {
  1521. "application/json": {
  1522. "schema": {
  1523. "type": "object",
  1524. "properties": {}
  1525. }
  1526. }
  1527. },
  1528. "headers": {}
  1529. }
  1530. },
  1531. "security": []
  1532. }
  1533. },
  1534. "/api/ai/ollama/models": {
  1535. "post": {
  1536. "summary": "获取模型列表",
  1537. "deprecated": false,
  1538. "description": "",
  1539. "tags": ["ollama"],
  1540. "parameters": [
  1541. {
  1542. "name": "Authorization",
  1543. "in": "header",
  1544. "description": "",
  1545. "example": "bpm_client_1500870842102321152",
  1546. "schema": {
  1547. "type": "string",
  1548. "default": "bpm_client_1500870842102321152"
  1549. }
  1550. }
  1551. ],
  1552. "requestBody": {
  1553. "content": {
  1554. "application/json": {
  1555. "schema": {
  1556. "type": "object",
  1557. "properties": {}
  1558. },
  1559. "example": {}
  1560. }
  1561. },
  1562. "required": true
  1563. },
  1564. "responses": {
  1565. "200": {
  1566. "description": "",
  1567. "content": {
  1568. "application/json": {
  1569. "schema": {
  1570. "type": "object",
  1571. "properties": {
  1572. "isSuccess": {
  1573. "type": "boolean"
  1574. },
  1575. "code": {
  1576. "type": "integer"
  1577. },
  1578. "result": {
  1579. "type": "array",
  1580. "items": {
  1581. "type": "object",
  1582. "properties": {
  1583. "digest": {
  1584. "type": "string"
  1585. },
  1586. "modified_at": {
  1587. "type": "string"
  1588. },
  1589. "name": {
  1590. "type": "string"
  1591. },
  1592. "size": {
  1593. "type": "integer"
  1594. }
  1595. }
  1596. }
  1597. },
  1598. "isAuthorized": {
  1599. "type": "boolean"
  1600. }
  1601. },
  1602. "required": ["isSuccess", "code", "result", "isAuthorized"]
  1603. },
  1604. "example": {
  1605. "isSuccess": true,
  1606. "code": 1,
  1607. "result": [
  1608. {
  1609. "digest": "baf6a787fdffd633537aa2eb51cfd54cb93ff08e28040095462bb63daf552878",
  1610. "modified_at": "2026-04-29T16:17:20.046777106Z",
  1611. "name": "llama3.2:1b",
  1612. "size": 1321098329
  1613. }
  1614. ],
  1615. "isAuthorized": true
  1616. }
  1617. }
  1618. },
  1619. "headers": {}
  1620. }
  1621. },
  1622. "security": []
  1623. }
  1624. },
  1625. "/api/ai/ollama/checkModels": {
  1626. "post": {
  1627. "summary": "批量检查模型是否可用",
  1628. "deprecated": false,
  1629. "description": "",
  1630. "tags": ["ollama"],
  1631. "parameters": [
  1632. {
  1633. "name": "Authorization",
  1634. "in": "header",
  1635. "description": "",
  1636. "example": "bpm_client_1500870842102321152",
  1637. "schema": {
  1638. "type": "string",
  1639. "default": "bpm_client_1500870842102321152"
  1640. }
  1641. }
  1642. ],
  1643. "requestBody": {
  1644. "content": {
  1645. "application/json": {
  1646. "schema": {
  1647. "type": "object",
  1648. "properties": {
  1649. "models": {
  1650. "type": "array",
  1651. "items": {
  1652. "type": "string"
  1653. }
  1654. }
  1655. },
  1656. "required": ["models"]
  1657. },
  1658. "example": {
  1659. "models": ["llama3.2:1b"]
  1660. }
  1661. }
  1662. },
  1663. "required": true
  1664. },
  1665. "responses": {
  1666. "200": {
  1667. "description": "",
  1668. "content": {
  1669. "application/json": {
  1670. "schema": {
  1671. "type": "object",
  1672. "properties": {
  1673. "isSuccess": {
  1674. "type": "boolean"
  1675. },
  1676. "code": {
  1677. "type": "integer"
  1678. },
  1679. "result": {
  1680. "type": "array",
  1681. "items": {
  1682. "type": "object",
  1683. "properties": {
  1684. "available": {
  1685. "type": "boolean"
  1686. },
  1687. "name": {
  1688. "type": "string"
  1689. }
  1690. }
  1691. }
  1692. },
  1693. "isAuthorized": {
  1694. "type": "boolean"
  1695. }
  1696. },
  1697. "required": ["isSuccess", "code", "result", "isAuthorized"]
  1698. },
  1699. "example": {
  1700. "isSuccess": true,
  1701. "code": 1,
  1702. "result": [
  1703. {
  1704. "available": true,
  1705. "name": "llama3.2:1b"
  1706. }
  1707. ],
  1708. "isAuthorized": true
  1709. }
  1710. }
  1711. },
  1712. "headers": {}
  1713. }
  1714. },
  1715. "security": []
  1716. }
  1717. },
  1718. "/api/ai/ollama/downloadModel": {
  1719. "post": {
  1720. "summary": "下载模型",
  1721. "deprecated": false,
  1722. "description": "",
  1723. "tags": ["ollama"],
  1724. "parameters": [
  1725. {
  1726. "name": "Authorization",
  1727. "in": "header",
  1728. "description": "",
  1729. "example": "bpm_client_1500870842102321152",
  1730. "schema": {
  1731. "type": "string",
  1732. "default": "bpm_client_1500870842102321152"
  1733. }
  1734. }
  1735. ],
  1736. "requestBody": {
  1737. "content": {
  1738. "application/json": {
  1739. "schema": {
  1740. "type": "object",
  1741. "properties": {
  1742. "model": {
  1743. "type": "string"
  1744. }
  1745. },
  1746. "required": ["model"]
  1747. },
  1748. "example": {
  1749. "model": "qwen3-embedding:4b"
  1750. }
  1751. }
  1752. },
  1753. "required": true
  1754. },
  1755. "responses": {
  1756. "200": {
  1757. "description": "",
  1758. "content": {
  1759. "application/json": {
  1760. "schema": {
  1761. "type": "object",
  1762. "properties": {
  1763. "isSuccess": {
  1764. "type": "boolean"
  1765. },
  1766. "code": {
  1767. "type": "integer"
  1768. },
  1769. "result": {
  1770. "type": "object",
  1771. "properties": {
  1772. "modelName": {
  1773. "type": "string"
  1774. },
  1775. "progress": {
  1776. "type": "integer"
  1777. },
  1778. "status": {
  1779. "type": "string"
  1780. },
  1781. "taskId": {
  1782. "type": "string"
  1783. }
  1784. },
  1785. "required": ["modelName", "progress", "status", "taskId"]
  1786. },
  1787. "isAuthorized": {
  1788. "type": "boolean"
  1789. }
  1790. },
  1791. "required": ["isSuccess", "code", "result", "isAuthorized"]
  1792. },
  1793. "example": {
  1794. "isSuccess": true,
  1795. "code": 1,
  1796. "result": {
  1797. "modelName": "qwen3-embedding:4b",
  1798. "progress": 0,
  1799. "status": "pending",
  1800. "taskId": "9aaad22d-3749-4d8d-9b34-9aa9d119becc"
  1801. },
  1802. "isAuthorized": true
  1803. }
  1804. }
  1805. },
  1806. "headers": {}
  1807. }
  1808. },
  1809. "security": []
  1810. }
  1811. },
  1812. "/api/ai/ollama/downloadProcess": {
  1813. "post": {
  1814. "summary": "获取下载进度",
  1815. "deprecated": false,
  1816. "description": "",
  1817. "tags": ["ollama"],
  1818. "parameters": [
  1819. {
  1820. "name": "Authorization",
  1821. "in": "header",
  1822. "description": "",
  1823. "example": "bpm_client_1500870842102321152",
  1824. "schema": {
  1825. "type": "string",
  1826. "default": "bpm_client_1500870842102321152"
  1827. }
  1828. }
  1829. ],
  1830. "requestBody": {
  1831. "content": {
  1832. "application/json": {
  1833. "schema": {
  1834. "type": "object",
  1835. "properties": {
  1836. "taskId": {
  1837. "type": "string"
  1838. }
  1839. },
  1840. "required": ["taskId"]
  1841. },
  1842. "example": {
  1843. "taskId": "9aaad22d-3749-4d8d-9b34-9aa9d119becc"
  1844. }
  1845. }
  1846. },
  1847. "required": true
  1848. },
  1849. "responses": {
  1850. "200": {
  1851. "description": "",
  1852. "content": {
  1853. "application/json": {
  1854. "schema": {
  1855. "type": "object",
  1856. "properties": {
  1857. "isSuccess": {
  1858. "type": "boolean"
  1859. },
  1860. "code": {
  1861. "type": "integer"
  1862. },
  1863. "result": {
  1864. "type": "object",
  1865. "properties": {
  1866. "id": {
  1867. "type": "string"
  1868. },
  1869. "message": {
  1870. "type": "string"
  1871. },
  1872. "modelName": {
  1873. "type": "string"
  1874. },
  1875. "progress": {
  1876. "type": "number"
  1877. },
  1878. "startTime": {
  1879. "type": "string"
  1880. },
  1881. "status": {
  1882. "type": "string"
  1883. }
  1884. },
  1885. "required": ["id", "message", "modelName", "progress", "startTime", "status"]
  1886. },
  1887. "isAuthorized": {
  1888. "type": "boolean"
  1889. }
  1890. },
  1891. "required": ["isSuccess", "code", "result", "isAuthorized"]
  1892. },
  1893. "example": {
  1894. "isSuccess": true,
  1895. "code": 1,
  1896. "result": {
  1897. "id": "9aaad22d-3749-4d8d-9b34-9aa9d119becc",
  1898. "message": "下载中: 0.3% (pulling 2b0cf8f17b4c)",
  1899. "modelName": "qwen3-embedding:4b",
  1900. "progress": 0.33791762086877225,
  1901. "startTime": "2026-05-10T17:56:51.675831455+08:00",
  1902. "status": "downloading"
  1903. },
  1904. "isAuthorized": true
  1905. }
  1906. }
  1907. },
  1908. "headers": {}
  1909. }
  1910. },
  1911. "security": []
  1912. }
  1913. },
  1914. "/api/ai/ollama/downloadTasks": {
  1915. "post": {
  1916. "summary": "获取所有下载任务列表",
  1917. "deprecated": false,
  1918. "description": "",
  1919. "tags": ["ollama"],
  1920. "parameters": [
  1921. {
  1922. "name": "Authorization",
  1923. "in": "header",
  1924. "description": "",
  1925. "example": "bpm_client_1500870842102321152",
  1926. "schema": {
  1927. "type": "string",
  1928. "default": "bpm_client_1500870842102321152"
  1929. }
  1930. }
  1931. ],
  1932. "requestBody": {
  1933. "content": {
  1934. "application/json": {
  1935. "schema": {
  1936. "type": "object",
  1937. "properties": {}
  1938. },
  1939. "example": {}
  1940. }
  1941. },
  1942. "required": true
  1943. },
  1944. "responses": {
  1945. "200": {
  1946. "description": "",
  1947. "content": {
  1948. "application/json": {
  1949. "schema": {
  1950. "type": "object",
  1951. "properties": {
  1952. "isSuccess": {
  1953. "type": "boolean"
  1954. },
  1955. "code": {
  1956. "type": "integer"
  1957. },
  1958. "result": {
  1959. "type": "array",
  1960. "items": {
  1961. "type": "object",
  1962. "properties": {
  1963. "id": {
  1964. "type": "string"
  1965. },
  1966. "message": {
  1967. "type": "string"
  1968. },
  1969. "modelName": {
  1970. "type": "string"
  1971. },
  1972. "progress": {
  1973. "type": "integer"
  1974. },
  1975. "startTime": {
  1976. "type": "string"
  1977. },
  1978. "status": {
  1979. "type": "string"
  1980. }
  1981. }
  1982. }
  1983. },
  1984. "isAuthorized": {
  1985. "type": "boolean"
  1986. }
  1987. },
  1988. "required": ["isSuccess", "code", "result", "isAuthorized"]
  1989. },
  1990. "example": {
  1991. "isSuccess": true,
  1992. "code": 1,
  1993. "result": [
  1994. {
  1995. "id": "9aaad22d-3749-4d8d-9b34-9aa9d119becc",
  1996. "message": "下载完成",
  1997. "modelName": "qwen3-embedding:4b",
  1998. "progress": 100,
  1999. "startTime": "2026-05-10T17:56:51.675831455+08:00",
  2000. "status": "completed"
  2001. }
  2002. ],
  2003. "isAuthorized": true
  2004. }
  2005. }
  2006. },
  2007. "headers": {}
  2008. }
  2009. },
  2010. "security": []
  2011. }
  2012. }
  2013. },
  2014. "components": {
  2015. "schemas": {
  2016. "AgentNode": {
  2017. "type": "object",
  2018. "properties": {
  2019. "appAgentId": {
  2020. "type": "string",
  2021. "format": "uuid"
  2022. },
  2023. "creationTime": {
  2024. "type": "string",
  2025. "format": "date-time"
  2026. },
  2027. "creatorUserId": {
  2028. "type": "string",
  2029. "format": "uuid"
  2030. },
  2031. "data": {
  2032. "$ref": "#/components/schemas/NodeData"
  2033. },
  2034. "height": {
  2035. "type": "integer"
  2036. },
  2037. "id": {
  2038. "type": "string",
  2039. "format": "uuid"
  2040. },
  2041. "isDeleted": {
  2042. "type": "boolean"
  2043. },
  2044. "position": {
  2045. "type": "object",
  2046. "properties": {
  2047. "x": {
  2048. "type": "integer"
  2049. },
  2050. "y": {
  2051. "type": "integer"
  2052. }
  2053. },
  2054. "required": ["x", "y"]
  2055. },
  2056. "selected": {
  2057. "type": "boolean"
  2058. },
  2059. "type": {
  2060. "type": "string",
  2061. "enum": ["custom", "start", "end", "condition", "task", "http-request"]
  2062. },
  2063. "updateTime": {
  2064. "type": "string",
  2065. "format": "date-time"
  2066. },
  2067. "width": {
  2068. "type": "integer"
  2069. },
  2070. "zIndex": {
  2071. "type": "integer"
  2072. }
  2073. },
  2074. "required": [
  2075. "appAgentId",
  2076. "creationTime",
  2077. "creatorUserId",
  2078. "data",
  2079. "id",
  2080. "position",
  2081. "type"
  2082. ]
  2083. },
  2084. "NodeData": {
  2085. "type": "object",
  2086. "properties": {
  2087. "outputs": {
  2088. "type": "array",
  2089. "items": {
  2090. "type": "object",
  2091. "properties": {
  2092. "name": {
  2093. "type": "string"
  2094. },
  2095. "describe": {
  2096. "type": "string"
  2097. },
  2098. "type": {
  2099. "type": "string",
  2100. "enum": ["string", "number", "boolean", "object", "array"]
  2101. }
  2102. },
  2103. "required": ["name", "describe", "type"]
  2104. }
  2105. },
  2106. "output_can_alter": {
  2107. "type": "boolean"
  2108. },
  2109. "variables": {
  2110. "type": "array",
  2111. "items": {
  2112. "type": "string"
  2113. }
  2114. },
  2115. "method": {
  2116. "type": "string",
  2117. "enum": ["get", "post", "put", "delete", "patch", "head", "options"]
  2118. },
  2119. "ssl_verify": {
  2120. "type": "boolean"
  2121. },
  2122. "isInIteration": {
  2123. "type": "boolean"
  2124. },
  2125. "default_value": {
  2126. "type": "array",
  2127. "items": {
  2128. "type": "string"
  2129. }
  2130. },
  2131. "body": {
  2132. "$ref": "#/components/schemas/RequestBody"
  2133. },
  2134. "params": {
  2135. "type": "array",
  2136. "items": {
  2137. "type": "string"
  2138. }
  2139. },
  2140. "title": {
  2141. "type": "string"
  2142. },
  2143. "type": {
  2144. "type": "string",
  2145. "enum": ["http-request", "condition", "task"]
  2146. },
  2147. "error_strategy": {
  2148. "type": "string",
  2149. "enum": ["none", "retry", "abort", "continue"]
  2150. },
  2151. "retry_config": {
  2152. "type": "object",
  2153. "properties": {
  2154. "max_retries": {
  2155. "type": "integer",
  2156. "minimum": 0,
  2157. "maximum": 10
  2158. },
  2159. "retry_enabled": {
  2160. "type": "boolean"
  2161. },
  2162. "retry_interval": {
  2163. "type": "integer",
  2164. "minimum": 0,
  2165. "maximum": 5000
  2166. }
  2167. },
  2168. "required": ["max_retries", "retry_enabled", "retry_interval"]
  2169. },
  2170. "url": {
  2171. "type": "string",
  2172. "format": "uri"
  2173. },
  2174. "authorization": {
  2175. "type": "object",
  2176. "properties": {
  2177. "type": {
  2178. "type": "string",
  2179. "enum": ["none", "bearer", "basic", "api-key"]
  2180. },
  2181. "config": {
  2182. "type": "object",
  2183. "properties": {
  2184. "api_key": {
  2185. "type": "string"
  2186. },
  2187. "header": {
  2188. "type": "string"
  2189. },
  2190. "type": {
  2191. "type": "string"
  2192. }
  2193. }
  2194. }
  2195. },
  2196. "required": ["type", "config"]
  2197. },
  2198. "timeout_config": {
  2199. "type": "object",
  2200. "properties": {
  2201. "max_write_timeout": {
  2202. "type": "integer",
  2203. "minimum": 0
  2204. },
  2205. "max_read_timeout": {
  2206. "type": "integer",
  2207. "minimum": 0
  2208. },
  2209. "max_connect_timeout": {
  2210. "type": "integer",
  2211. "minimum": 0
  2212. }
  2213. },
  2214. "required": ["max_write_timeout", "max_read_timeout", "max_connect_timeout"]
  2215. },
  2216. "heads": {
  2217. "type": "array",
  2218. "items": {
  2219. "$ref": "#/components/schemas/HttpHeader"
  2220. }
  2221. },
  2222. "selected": {
  2223. "type": "boolean"
  2224. },
  2225. "desc": {
  2226. "type": "string"
  2227. },
  2228. "isInLoop": {
  2229. "type": "boolean"
  2230. }
  2231. },
  2232. "required": ["outputs", "method", "title", "type", "url"]
  2233. },
  2234. "RequestBody": {
  2235. "type": "object",
  2236. "properties": {
  2237. "data": {
  2238. "type": "array",
  2239. "items": {
  2240. "$ref": "#/components/schemas/RequestDataItem"
  2241. }
  2242. },
  2243. "type": {
  2244. "type": "string",
  2245. "enum": ["json", "form-data", "x-www-form-urlencoded", "raw", "binary"]
  2246. }
  2247. },
  2248. "required": ["data", "type"]
  2249. },
  2250. "RequestDataItem": {
  2251. "type": "object",
  2252. "properties": {
  2253. "type": {
  2254. "type": "string",
  2255. "enum": ["text", "file", "json"]
  2256. },
  2257. "value": {
  2258. "type": "string"
  2259. },
  2260. "key": {
  2261. "type": "string"
  2262. }
  2263. },
  2264. "required": ["type", "value"]
  2265. },
  2266. "HttpHeader": {
  2267. "type": "object",
  2268. "properties": {
  2269. "name": {
  2270. "type": "string"
  2271. },
  2272. "value": {
  2273. "type": "string"
  2274. }
  2275. },
  2276. "required": ["name", "value"]
  2277. }
  2278. },
  2279. "securitySchemes": {
  2280. "ApiKeyAuth": {
  2281. "type": "apiKey",
  2282. "in": "header",
  2283. "name": "Authorization"
  2284. }
  2285. }
  2286. },
  2287. "security": [
  2288. {
  2289. "ApiKeyAuth": []
  2290. }
  2291. ]
  2292. }