model.openapi.json 52 KB

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